HM_ExtAPI::GridTopologyGetTypeAndID()

Returns the type and ID of topological entity associated with a grid point of a mesh.

Syntax

bool GridTopologyGetTypeAndID(
const HM_EntityMesh & hmesh,
const HM_EntityTopology & htopo,
HM_ExtAPI::TopologyType & ttyp,
int & topo_id
);

Type

HyperMesh Ext API

Description

The topological entity referenced by the handle htopo must be obtained in previous calls to API functions using the same mesh handle hmesh.

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.
htopo: [in] - Handle referencing topological entity.
ttyp: [out] - When the function returns, this member contains the type of topological entity, which can have one of following values.; HM_ExtAPI::VERTEX - The entity is a vertex.; HM_ExtAPI::EDGE - The entity is an edge.; HM_ExtAPI::FACE - The entity is a face.; HM_ExtAPI::UNKNOWN - Invalid entity.
topo_id: [out] - Contains the ID of topological entity.

Errors

None.