HM_ExtAPI::ComponentGetFirstFreeGeomFace()
Returns the first free face of the component.
Syntax
bool ComponentGetFirstFreeGeomFace(
const HM_EntityComponent& comp,
HM_EntityGeomFace& face
);Type
HyperMesh Ext API
Description
The function ComponentGetFirstFreeGeomFace is used together with the function HM_ExtAPI::ComponentGetNextFreeGeomFace() to iterate through all free faces contained in the component. The call to ComponentGetFirstFreeGeomFace resets internal component counter to the first face. The following calls to ComponentGetNextFreeGeomFace increment the counter until all free face of the component are iterated.
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
- comp
- [in] - Handle to component object that was returned by previous calls to API functions.
- face
- [out] - Handle to the first free face of the component. The value of the handle is zero in case if component does not contain free faces.
Errors
None.