PolygonNode Class Reference
 
 
 
PolygonNode Class Reference

#include <xsi_polygonnode.h>


Class Description

The PolygonNode object gives access to the X3DObject's polygon node geometry. A polygon represents the edge junction of a polygon object.

See also:
PolygonFace::GetNodes
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(0) );
                PolygonFace face( mesh.GetPolygons().GetItem(0) );
                PolygonNode node( face.GetNodes().GetItem(0) );

                app.LogMessage( L"Index of Node 0: " +
                                                CValue(node.GetIndex()).GetAsText() );
Inheritance diagram for PolygonNode:
Sample SIObject CBase

List of all members.

Public Member Functions

  PolygonNode ()
  ~PolygonNode ()
  PolygonNode (const CRef &in_ref)
  PolygonNode (const PolygonNode &in_obj)
bool  IsA (siClassID in_ClassID) const
siClassID  GetClassID () const
PolygonNode operator= (const PolygonNode &in_obj)
PolygonNode operator= (const CRef &in_ref)
LONG  GetIndex () const
MATH::CVector3  GetNormal (bool &io_bValid) const

Constructor & Destructor Documentation

Default constructor.

Default destructor.

PolygonNode ( const CRef in_ref )

Constructor.

Parameters:
in_ref constant reference object.
PolygonNode ( const PolygonNode in_obj )

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:
in_ClassID class type.
Returns:
true if the class is compatible, false otherwise.

Reimplemented from Sample.

siClassID GetClassID ( ) const [virtual]

Returns the type of the API class.

Returns:
The class type.

Reimplemented from Sample.

PolygonNode& operator= ( const PolygonNode in_obj )

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 PolygonNode object.
PolygonNode& operator= ( const CRef in_ref )

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 PolygonNode object.

Reimplemented from Sample.

LONG GetIndex ( ) const

Returns the index of this PolygonNode object within the polygon face.

Returns:
The index of this PolygonNode object.

Reimplemented from Sample.

MATH::CVector3 GetNormal ( bool &  io_bValid ) const

Returns the normal of this PolygonNode object.

Parameters:
io_bValid Returns true if the normal is valid.
Returns:
The normal expressed as a CVector3 object..

The documentation for this class was generated from the following file: