HM_ExtAPI::SurfacePlaneGetData()

Returns parameters that define plane surface.

Syntax

bool SurfacePlaneGetData(
const HM_EntityGeometrySurface & surface,
HM_Point& plane_base,
HM_Vector& u_axis,
HM_Vector& v_axis
);

Type

HyperMesh Ext API Function

Description

The function expects that the type of surface object is HM_ExtAPI::PLANE(). Application should call the function HM_ExtAPI::GeomSurfaceGetType() to verify the type before calling SurfacePlaneGetData function.

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 returned by the function SurfacePlaneGetData.
Parameters returned by SurfacePlaneGetData 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

surface
[in] - Handle to surface object that was returned by previous calls to API functions.
plane_base
[out] - The point of the plane corresponding to surface parametric point u=0, v=0.
u_axis
[out] - Vector in the plane that defines parametric U axis.
v_axis
[out] - Vector in the plane that defines parametric V axis.

Errors

None.