HM_ExtAPI::CurveComposedGetSize()

Returns number of curve segments that define composed curve.

Syntax

bool CurveComposedGetSize(
const HM_EntityGeometryCurve& curve,
int& number_of_segments
);

Type

HyperMesh Ext API

Description

The function expects that the type of curve object is HM_ExtAPI::COMPOSED_CURVE(). Application should call the function HM_ExtAPI::GeomCurveGetType() to verify the type before calling CurveComposedGetSize function.

Use the function HM_ExtAPI::CurveComposedGetSegment() to get information of individual segments of composed curve.

See Description section in CurveComposedGetSegment() for the explanation of the structure of the composed curve.

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

curve
[in] - Handle to curve object that was returned by previous calls to API functions.
number_of_segments
[out] - Number of composed curve segments.

Errors

None.