HM_ExtAPI::TopologyTypeAndIDGetGridCount()

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,
int& num_of_grids
);

Type

HyperMesh Ext API Function

Description

The returned number of grids for an edge represents the number of the edge inner nodes only. The end nodes of the edge (associated with the edge vertices) are not considered.

For vertex input, the returned grids can number either 1 or 0 (indicates mapping error).

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).
num_of_grids
[out] - The number of grids associated with the input topological entity.

Errors

None.

Version History

11.0.101