Detailed Description
The Edge object gives access to the geometry edges of an X3DObject's primitive.
Edges are the PolygonMesh-specifics of Segments. You can reach edges from PolygonFace::GetEdges and PolygonMesh::GetEdges.
- See also:
- CEdgeRefArray, Segment, Vertex, PolygonMesh, Geometry
- Example:
#include <xsi_edge.h>
List of all members.
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
in_ref | constant reference object. |
Copy constructor.
- Parameters:
-
in_obj | constant class object. |
Member Function Documentation
bool IsA |
( |
siClassID |
in_ClassID | ) |
const [virtual] |
Returns true if a given class type is compatible with this API class.
- Parameters:
-
- Returns:
- true if the class is compatible, false otherwise.
Reimplemented from Segment.
Returns the type of the API class.
- Returns:
- The class type.
Reimplemented from Segment.
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
- Parameters:
-
in_obj | constant class object. |
- Returns:
- The new Edge object.
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
- Parameters:
-
in_ref | constant class object. |
- Returns:
- The new Edge object.
Reimplemented from Segment.
Returns the vertices at the ends of this edge.
- Returns:
- An array of Vertex objects
Returns an array of Vertex neighbors within a given distance.If the distance is 1, the 2 Vertex objects comprising the current Edge are returned.
- Parameters:
-
in_lDistance | Value Represents the degree of neighborhood (eg., degree=2 for an edge means its adjacent vertices plus the adjacent vertices of the adjacent vertices). |
- Returns:
- An array of Vertex objects
Returns an array of Edge neighbors within a given distance.If the distance is 1 the Edge objects are returned in counter-clockwise order.
- Parameters:
-
in_lDistance | Value Represents the degree of neighborhood (eg., degree=2 for an edge means its adjacent vertices plus the adjacent vertices of the adjacent vertices). |
- Returns:
- An array of Edge objects
Returns an array of PolygonFace neighbors within a given distance.If the distance is 1 the adjacent PolygonFace objects are returned (1 if border edge, 2 otherwise).
- Parameters:
-
in_lDistance | Value representing the degree of neighborhood (eg., degree=2 for an edge means its adjacent vertices plus the adjacent vertices of the adjacent vertices). |
- Returns:
- An array of PolygonFace objects
Returns an array of Edge objects that are adjacent to this Edge object, within a given distance.
- Parameters:
-
in_lDistance | Value representing the degree of neighborhood (eg., degree=2 for an edge means its adjacent vertices plus the adjacent vertices of the adjacent vertices). |
- Returns:
- An array of Edge objects
double GetCrease |
( |
| ) |
const |
Returns the crease value associated with this edge.
- Returns:
- The crease value between 0.0 and 10.0.
- Since:
- 3.5.1
Returns whether the edge is hard or not.
- Returns:
- True if the edge is hard, false if not.
- Since:
- 3.5.1
bool GetIsBoundary |
( |
| ) |
const |
Returns whether the edge is a boundary or not.
- Returns:
- True if the edge is a boundary, false if not.
- Since:
- 4.2
The documentation for this class was generated from the following file: