HM_ExtAPI::CreateCurveCircle()

Syntax

bool CreateCurveCircle(
HM_EntityGeometryCurve& new_circle,
const HM_Point& center_point,
const HM_Vector& normal,
const HM_Vector& radius
);

Type

HyperMesh Ext API Function

Description

The creates the curve object of the type HM_ExtAPI::CIRCLE. The points on the circle can be calculated parametrically as

C(t) = C + R cos t + [n X R] sin t

R = ρ - n (nρ) , n = N / | N |

where circle parameters correspond to the parameters used by the CreateCurveCircle function as summarized in the table below.

Parameters used by CreateCurveCircle	Curve parameters
center_points	C
normal	N
radius	P

Note that input normal vector defined by the normal parameter does not have to have unit length. The vector radius that defines position of the circle point with zero angle parameter does not have to be perpendicular to the normal vector but in this case it will be projected to the plane defined by the normal and the center point.

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

new_circle: [out] - Handle to new curve object.
center_points: [in] - Circle center point.
normal: [in] - Vector normal to the plane that contains the circle.
radius: [in] - Defines vector from center point to circle point corresponding to zero angle parameter.

Errors

None.