HM_ExtAPI::GridGetTopologyPosition()

Returns expected position of the grid point on associated topological entity.

Syntax

bool GridGetTopologyPosition(
const HM_EntityMesh & hmesh,
const HM_EntityGrid & hgrid,
HM_Point & point
);

Type

HyperMesh Ext API

Description

The grid point referenced by the handle hgrid must belong to the mesh referenced by the handle hmesh. That is only the grid handles obtained in previous calls to API functions using the same mesh handle hmesh must be used.

The function returns false in case if the grid point is not associated to any topological entity.

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

hmesh: [in] - Handle to mesh object that was returned by previous calls to API functions.
hgrid: [in] - Handle referencing the grid point.
point: [out] - The structure HM_Point that contains grid point coordinates on associated topological entity when the function returns. In most cases this is the closest on the entity point to the true grid position returned in a call to the function HM_ExtAPI::GridGetPosition().

Errors

None.