HM_ExtAPI::GeomEdgeGetFirstCoedge()
Returns first co-edge connected to the edge.
Syntax
bool GeomEdgeGetFirstCoedge(
const HM_EntityGeomEdge & edge,
HM_EntityGeomCoedge * & coedge,
bool& dir_sense,
bool& face_sense
);Type
HyperMesh Ext API Function
Description
The function GeomEdgeGetFirstCoedge can be used together with the HM_ExtAPI::GeomCoedgeGetNextOnEdge() function to iterate through the list of all connected to the edge faces. Alternatively, the function HM_ExtAPI::GeomEdgeGetCoedges() can be used to get the whole list. Using the functions HM_ExtAPI::GeomEdgeGetFirstCoedge() and HM_ExtAPI::GeomCoedgeGetNextOnEdge() helps to avoid memory allocation.
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
- edge
- [in] - Handle to edge object that was returned by previous calls to API functions.
- coedge
- [out] - The handle to one of co-edges connected to the edge. The handle is NULL if edge is not connected to any faces.
- dir_sense
- [out] - The flag that indicates co-edge direction with respect to edge direction. The value of true indicates that co-edge direction coincides with the direction of the edge. The value of false indicates that co-edge direction is opposite to the direction of the edge.
- face_sense
- [out] - The flag that indicates at which side the co-edge is connected to associated face "wing". The value of true indicates that corresponding co-edge has associated face on its left. The value of false indicates that corresponding co-edge has associated face on its right.
Errors
None.