PgonEdge Class Reference

#include <c4d_pgonedge.h>

Public Member Functions

Bool IsFirst ()
 
Bool IsSegmentEnd ()
 
Int32 ID ()
 
Int32 State ()
 
Int32 Edge ()
 
Int32 EdgeIndex ()
 
void GetEdge (const CPolygon *vadr, Int32 &p1, Int32 &p2)
 

Public Attributes

UInt32 edge_index
 

Detailed Description

Represents an N-gon edge of a Pgon.

Member Function Documentation

◆ IsFirst()

Bool IsFirst ( )

Check if the polygon ID is the first occurrence in the array.

Note
Useful to know which polygons form an N-gon.
Returns
true if the polygon ID is the first occurrence in the array, otherwise false.

◆ IsSegmentEnd()

Bool IsSegmentEnd ( )

Checks if it is the last edge in the segment.

Returns
true if it is the last edge in the segment, otherwise false.

◆ ID()

Int32 ID ( )

Gets the polygon ID.

Returns
The polygon ID.

◆ State()

Int32 State ( )

Gets the edge state.

Returns
The edge as a bit, or 0 if the polygon has no edge on the outer/inner of the N-gon.

◆ Edge()

Int32 Edge ( )

Gets the edge of the polygon.

Returns
The edge of the polygon, or NOTOK for no edge.

◆ EdgeIndex()

Int32 EdgeIndex ( )

Gets the edge index.

Returns
The edge index (4*polygon ID + edge).

◆ GetEdge()

void GetEdge ( const CPolygon vadr,
Int32 p1,
Int32 p2 
)

Assigns to p1 and p2 the point IDs for the edge or NOTINDEX if it is not an N-gon edge.

Parameters
[in]vadrThe polygon array. The caller owns the pointed array.
[out]p1Assigned the first point ID.
[out]p2Assigned the second point ID.

Member Data Documentation

◆ edge_index

UInt32 edge_index

Edge index.