Edge Class Reference
#include <xsi_edge.h>
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.
using namespace XSI;
Application app;
Model root = app.GetActiveSceneRoot();
X3DObject myCube;
root.AddGeometry( L"Cube", L"MeshSurface", L"", myCube );
PolygonMesh mesh( myCube.GetActivePrimitive().GetGeometry() );
Edge edge( mesh.GetEdges().GetItem(0) );
app.LogMessage( L"This object is an: " + edge.GetClassIDName() );
Public Member Functions |
|
| Edge () | |
| ~Edge () | |
| Edge (const CRef &in_ref) | |
| Edge (const Edge &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| Edge & | operator= (const Edge &in_obj) |
| Edge & | operator= (const CRef &in_ref) |
| CVertexRefArray | GetVertices () const |
| CPolygonNodeRefArray | GetNodes () const |
| CVertexRefArray | GetNeighborVertices (LONG in_lDistance=1) const |
| CEdgeRefArray | GetNeighborEdges (LONG in_lDistance=1) const |
| CPolygonFaceRefArray | GetNeighborPolygons (LONG in_lDistance=1) const |
| CEdgeRefArray | GrowNeighborEdges (LONG in_lDistance=1) const |
| double | GetCrease () const |
| bool | GetIsHard () const |
| bool | GetIsBoundary () const |
| Edge | ( | ) |
Default constructor.
| ~Edge | ( | ) |
Default destructor.
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
| in_ClassID | class type. |
Reimplemented from Segment.
| siClassID GetClassID | ( | ) | const [virtual] |
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
| in_obj | constant class object. |
| CVertexRefArray GetVertices | ( | ) | const |
Returns the vertices at the ends of this edge.
| CPolygonNodeRefArray GetNodes | ( | ) | const |
Returns the PolygonNode objects adjacent to this edge.
| CVertexRefArray GetNeighborVertices | ( | LONG | in_lDistance = 1 |
) | const |
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.
| 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). |
| CEdgeRefArray GetNeighborEdges | ( | LONG | in_lDistance = 1 |
) | const |
Returns an array of Edge neighbors within a given distance.If the distance is 1 the Edge objects are returned in counter-clockwise order.
| 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). |
| CPolygonFaceRefArray GetNeighborPolygons | ( | LONG | in_lDistance = 1 |
) | const |
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).
| 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). |
| CEdgeRefArray GrowNeighborEdges | ( | LONG | in_lDistance = 1 |
) | const |
Returns an array of Edge objects that are adjacent to this Edge object, within a given distance.
| 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). |
| double GetCrease | ( | ) | const |
Returns the crease value associated with this edge.
| bool GetIsHard | ( | ) | const |
Returns whether the edge is hard or not.
| bool GetIsBoundary | ( | ) | const |
Returns whether the edge is a boundary or not.