HM_ExtAPI::GeomCurveGetParameterBounds()

Returns information about parameter range of the curve.

Syntax

bool GeomCurveGetParameterBounds(
const HM_EntityGeometryCurve & curve,
double& start_param,
double& end_param,
bool& no_bounds,
bool& periodic
);

Type

HyperMesh Ext API

Description

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 function.
start_param
[out] - Lower bound of curve parameter range.
end_param
[out] - Upper bound of curve parameter range.
no_bounds
[out] - Flag that specifies whether parameterization has bounds. When function returns, this parameter can have one of following values.
false - Curve parameterization has bounds that are returned by start_param and end_param parameters.
true - Curve parameterization does not have bounds. Curve points are defined for any value of the parameter. In this case, the parameter start_param returns 0, and the parameter end_param returns 1.
periodic
[out] - Upper bound of curve parameter range.
false - The curve is not periodic.
true - The curve is periodic. Curve points are defined for any value of the parameter. The difference between the values returned by parameters start_param and end_param in this case defines parameter periodicity.

Errors

None.