CEdgeRefArray Class Reference

Related Scripting Object: EdgeCollection

Array of Edge objects. More...

#include <xsi_edge.h>

Inheritance diagram for CEdgeRefArray:

Detailed Description

Warning:

This specialized array is returned by PolygonFace::GetEdges and PolygonMesh::GetEdges, it is not meant to be created and modified in user-defined functions. If you want to add and remove arbitrary items to a collection, you must use a CRefArray instead.

See also:

PolygonMesh::GetEdges, PolygonFace::GetEdges

Example:

        using namespace XSI;
        Application app;
        Model root = app.GetActiveSceneRoot();

        X3DObject myCube;
        root.AddGeometry( L"Cube", L"MeshSurface", L"", myCube );

        PolygonMesh mesh( myCube.GetActivePrimitive().GetGeometry() );

        CEdgeRefArray edges(mesh.GetEdges());

        app.LogMessage( L"Number of edges: " +
                        CValue(edges.GetCount()).GetAsText() );

Constructor & Destructor Documentation

Copy constructor.

Parameters:

in_array

constant CEdgeRefArray reference object.

Member Function Documentation

Returns the Edge object in the array matching the specified name.

Parameters:

in_name

The name of the Edge.

Returns:

A reference to the specified Edge object.

Reimplemented from CSegmentRefArray.

Gets the number of Edges in the array.

Returns:

The number of Edge objects.

Reimplemented from CSegmentRefArray.

Returns true if this array is a valid object or false otherwise.

Returns:

true if valid, false otherwise.

Reimplemented from CSegmentRefArray.

Returns an array of Vertex neighbors within a given distance.

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.

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

Returns an array of PolygonFace neighbors 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 PolygonFace objects

Returns an array of Edge objects on the geometry that are adjacent to the Edge objects contained in the array, 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

Returns an array of crease values for all edges contained in this edge array.

Returns:

An array of crease values (doubles).

Since:

3.5.1

Returns an array of boolean values indicating whether each edge in the array is hard or not.

Returns:

An array of boolean values.

Since:

3.5.1

• xsi_edge.h