HM_ExtAPI::TopologyTypeAndIDGetGrid()

Returns a mesh grid associated with a specified topology edge or vertex.

Syntax

bool TopologyTypeAndIDGetGrid(
const HM_EntityMesh & hmesh,
HM_ExtAPI::TopologyType& ttyp,
const int & topo_id,
const int & index_of_grid,
HM_EntityGrid hgrid
);

Type

HyperMesh Ext API Function

Description

The grids associated with the edges are indexed according to their order on the edge in the direction from the edge start vertex to the edge end vertex.

The call of the function for an edge should be preceded by a call to HM_ExtAPI::TopologyTypeAndIDGetGridCount() to get the exact number of the grids on the edge and to have the correct index of the inquired grid.

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.
ttyp
[in] - The type of input topological entity. Valid values are:
HM_ExtAPI::VERTEX - The entity is a vertex.
HM_ExtAPI::EDGE - The entity is an edge.
topo_id
[in] - Contains the ID of the topological entity (edge or vertex).
index_of_grid
[in] - The index of the grid for the edge input. Ignored for vertex input. For an edge, the index starts at 1 and should not exceed num_of_grids returned by HM_ExtAPI::TopologyTypeAndIDGetGridCount for the same edge.
hgrid
[out] - A returned handle to the mesh grid.

Errors

None.

Version History

11.0.101