HM_ExtAPI::CreateSurfacePlane()

Creates plane surface object.

Syntax

bool CreateSurfacePlane(
HM_EntityGeometrySurface& new_plane,
const HM_Point& plane_base,
const HM_Vector& u_axis,
const HM_Vector& v_axis
);

Type

HyperMesh Ext API

Description

The function creates the surface object of the type HM_ExtAPI::PLANE().

The points on the plane surface can be calculated parametrically as

S(U, V) = C + u U + v V

The following table summarizes correspondence of the parameters used in the equation to parameters used by the function CreateSurfacePlane.

Parameters used by CreateSurfacePlane Plane parameters
plane_base C
u_axis u
v_axis v

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_plane
[out] - Handle to new surface object.
plane_base
[in] - The point of the plane corresponding to surface parametric point u=0, v=0.
u_axis
[in] - Vector in the plane that defines parametric U axis.
v_axis
[in] - Vector in the plane that defines V axis.

Errors

None.