HM_ExtAPI::GetFirstComponent()

Syntax

bool GetFirstComponent(
HM_EntityComponent & comp
);

Type

HyperMesh Ext API Function

Description

The function GetFirstComponent is used together with the function HM_ExtAPI::GetNextComponent() to iterate through all components of the model loaded into HyperMesh database. The call to GetFirstComponent resets internal component counter to the first component. The following calls to GetNextComponent increment the counter until components 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

[out] - Handle to existing component. The value of the handle is zero in case if no model is loaded.

Errors

None.