HM_ExtAPI::ComponentGetFirstFreeGeomPoint()
Returns the first free point of the component.
Syntax
bool ComponentGetFirstFreeGeomPoint(
const HM_EntityComponent& comp,
HM_EntityGeomVertex& fpnt
);Type
HyperMesh Ext API
Description
The function ComponentGetFirstFreeGeomPoint is used together with the function HM_ExtAPI::ComponentGetNextFreeGeomPoint() to iterate through all free points contained in the component. The call to ComponentGetFirstFreeGeomPoint resets internal component counter to the first point. The following calls to ComponentGetNextFreeGeomPoint increment the counter until all free points 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.
- fpnt
- [out] - Handle to the first free point of the component. The value of the handle is zero in case if component does not contain free points.
Errors
None.