HM_ExtAPI::MeshGetFirstComponent()

Returns the first mesh component in a mesh object.

Syntax

bool MeshGetFirstComponent(
const HM_EntityMesh& hmesh,
HM_EntityMeshComponent& hcomp
);

Type

HyperMesh Ext API Function

Description

The function HM_ExtAPI::MeshGetFirstComponent is used together with the funciton HM_ExtAPI::MeshGetNextComponent to iterate through all the components contained in the mesh referenced by the mesh object. The call to HM_ExtAPI::MeshGetFirstComponent resets the internal component counter of the mesh object to the first component. Subsequent calls to HM_ExtAPI::MeshGetNextComponent increment the counter until all components are iterated.

If the function succeeds, the return value is true. To get extended value information, call HM_ExtAPI::GetLastErrorCode().

Requires including hm_extapi.h.

Inputs

hmesh
[in] - Handle to mesh object that was returned by previous calls to API functions.
hcomp
[out] - Handle to the first mesh component in the mesh referenced by the mesh object.

Errors

None.

Version History

11.0.101