HM_ExtAPI::GeomEdgeGetCoedges()
Returns face "wings" connected to the edge.
Syntax
bool GeomEdgeGetCoedges(
const HM_EntityGeomEdge & edge,
int& coedge_count,
HM_EntityGeomCoedge * & coedges,
bool*& dir_senses,
bool*& face_senses
);Type
HyperMesh Ext API Function
Description
When one or more faces are connected at common edge then connection of the edge to each of the faces is represented by coedge entity associated with this face. Each of coedges has corresponding face on one of its sides. It is also possible for a coedge to have faces on both sides. In some cases a coedge can have the same face on both sides. In these cases the same coedge corresponds to topologically distinct face "wings" that are connected to the common edge. The combination of the coedge and its side is necessary to identify uniquely corresponding "wing".
To free arrays allocated for coedges, dir_senses and face_senses during the function call use the function HM_ExtAPI::MemoryFree().
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_count
- [out] - Number of coedges.
- coedges
- [out] - Returns pointer to array of handles to coedges. The number of values in the array is coedge_count. The pointer is NULL if edge is not connected to any faces.
- dir_senses
- [out] - Returns pointer to array of flags that indicate coedge direction with respect to edge direction. The number of values in the array is coedge_count. The pointer is NULL if edge is not connected to any faces. The value of true indicates that corresponding coedge direction coincides with the direction of the edge. The value of false indicates that corresponding coedge direction is opposite to the direction of the edge.
- face_senses
- [out] - Returns pointer to array of flags that indicate at which side the coedge is connected to associated face "wing". The number of values in the array is coedge_count. The pointer is NULL if edge is not connected to any faces. The value of true indicates that corresponding coedge has associated face on its left. The value of false indicates that corresponding coedge has associated face on its right.
Errors
None.