HM_ExtAPI::PointLocateFace()
Finds closest to given point face or finds the closest point on the face.
Syntax
bool PointLocateFace(
const HM_Point& point,
double search_tol,
HM_EntityComponent& only_comp,
HM_EntityGeomFace& face,
HM_Point* face_point,
HM_Vector* face_normal,
double* face_upar,
double* face_vpar
);Type
HyperMesh Ext API
Description
If the function succeeds, the return value is true. If the function fails, the return value is false. To get extended value information, call HM_ExtAPI::GetLastErrorCode().
Requires including hm_extapi.h.
Inputs
- point
- [in] - Point.
- search_tol
- [in] - Search tolerance. If the value is positive then it is used as the maximal distance limit between point and closest point on any of the model faces. Set negative value to disable the limit.
- only_comp
- [in] - If not NULL entity then limits the search of the closest face to only faces of the component only_comp. Ignored if face parameter is not NULL entity on input.
- face
- [in/out] - If not NULL handle to valid face entity on input then the search of the closest point on this face is performed. If NULL handle then on output returns the face on which the closest point is found.
- face_point
- [out] - If not NULL on input then returns the position of the closest face point.
- face_normal
- [out] - If not NULL on input then returns the normal direction of the face face at the closest to point point.
- face_upar
- [out] - If not NULL on input then returns U surface parameter of the closest face point.
- face_vpar
- [out] - If not NULL on input then returns V surface parameter of the closest face point.
Errors
None.