Returns the number of existing 3D components.

    GSErrCode  ACAPI_3D_GetNum (
        API_3DTypeID      typeID,
        Int32*            count
    );

 

Parameters

typeID

[in] Type of the 3D component.

count

[out] Number of component with the given type.

 

Return Values

NoError

The function has completed with success.

APIERR_BADPARS

The passed parameter is nullptr; count

APIERR_REFUSEDCMD

The 3D model is not available in the current context

APIERR_BADID

The component type is invalid

APIERR_REFUSEDPAR

The component type cannot be queried directly

For other common API errors see the API Errors document.

 

Remarks

This function is used to get the number of 3D components with a given type. Refer to the API_3DTypeID structure for the possible values.

Only the API_BodyID, API_LghtID and API_UmatID type components can be addressed with this function.

Model dependent components (API_PgonID, API_PedgID, API_EdgeID, API_VertID, API_VectID) are body dependent; direct access is prohibited. The number of these components can be determined from the API_BodyType type.

 

Example

See the example of the ACAPI_3D_GetComponent function.

 

Requirements

Version: API 1.3 or later

Header: ACAPinc.h

 

See Also

API_3DTypeID, API_BodyType,
ACAPI_3D_GetComponent,
3D Manager, API Functions