HM_ExtAPI::GeomCoedgeGetNextOnEdge()
Returns next coedge on the edge represented by the coedge.
Syntax
bool GeomCoedgeGetNextOnEdge(
const HM_EntityGeomCoedge & coedge,
bool face_sense,
bool forward,
HM_EntityGeomCoedge& next_coedge,
bool& next_face_sense
);
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".
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
- coedge
- [in] - Handle to coedge object that was returned by previous calls to API functions.
- face_sense
- [in] - The flag that indicates the side of the coedge at which the coedge face is connected. The value of true indicates that the face is on the left side of the coedge. The value of false indicates that the face is on the right side of the coedge.
- forward
- [in] - The flag that indicates rotation direction around the edge. The value of true indicates that the rotation is counter clockwise with respect to an outward direction of the edge. The value of false indicates that the rotation is clockwise with respect to outward direction of the edge.
- next_coedge
- [out] - The handle to the next coedge.
- next_face_sense
- [out] - The flag that indicates the side of the next coedge at which associated face is connected. The value of true indicates that the face is on the left side of the next coedge. The value of false indicates that the face is on the right side of the coedge.
Errors
None.