Open Inventor Reference
SoFaceDetail Class Reference

Stores detail information about vertex-based shapes made of faces. More...

#include <Inventor/details/SoFaceDetail.h>

Inheritance diagram for SoFaceDetail:
SoDetail

List of all members.

Public Member Functions

 SoFaceDetail ()
 Constructor and destructor.
virtual ~SoFaceDetail ()
 Constructor and destructor.
int32_t getNumPoints () const
 Returns the number of points in the face.
const SoPointDetailgetPoint (int i) const
 Returns information about the point forming the i'th vertex of the face, represented as an SoPointDetail.
int32_t getFaceIndex () const
 Returns the index of the face within the shape.
int32_t getPartIndex () const
 Returns the index of the part containing the face within the shape.
virtual SoDetailcopy () const
 Returns an instance that is a copy of this instance.
void setNumPoints (int32_t num)
 Sets the number of points in the face and allocates room for the points.
void setPoint (int32_t index, const SoPointDetail *pd)
 Copies a point detail from the given detail.
void setFaceIndex (int32_t i)
 Sets the face index and part index.
void setPartIndex (int32_t i)
SoPointDetailgetPoints ()
 Return a pointer to the point details.
void setNumPoints (long num)
void setPoint (long index, const SoPointDetail *pd)
void setFaceIndex (long i)
void setPartIndex (long i)

Static Public Member Functions

static void initClass ()

Detailed Description

This class contains detail information about a point on a face in a vertex-based shape made of faces. The information includes the number of points in the face, the points forming the vertices of the face, and the index of the face within the shape.

Note that when an SoFaceDetail is returned from picking (in an SoPickedPoint), it will contain details for all points defining the face that was intersected. However, when an SoFaceDetail is created for a triangle produced during primitive generation (in an SoPrimitiveVertex), it will contain details for only the three vertices of the triangle.

See Also
SoDetail, SoPickedPoint, SoPrimitiveVertex, SoVertexShape

Definition at line 86 of file SoFaceDetail.h.


Constructor & Destructor Documentation

SoFaceDetail::SoFaceDetail ( )
virtual SoFaceDetail::~SoFaceDetail ( ) [virtual]

Member Function Documentation

virtual SoDetail* SoFaceDetail::copy ( ) const [virtual]

The caller is responsible for deleting the copy when done.

Implements SoDetail.

int32_t SoFaceDetail::getFaceIndex ( ) const [inline]

Definition at line 105 of file SoFaceDetail.h.

int32_t SoFaceDetail::getNumPoints ( ) const [inline]

Definition at line 98 of file SoFaceDetail.h.

int32_t SoFaceDetail::getPartIndex ( ) const [inline]

Definition at line 108 of file SoFaceDetail.h.

const SoPointDetail* SoFaceDetail::getPoint ( int  i) const [inline]

Definition at line 102 of file SoFaceDetail.h.

SoPointDetail* SoFaceDetail::getPoints ( ) [inline]

Definition at line 126 of file SoFaceDetail.h.

static void SoFaceDetail::initClass ( ) [static]

Reimplemented from SoDetail.

void SoFaceDetail::setFaceIndex ( int32_t  i) [inline]

Definition at line 122 of file SoFaceDetail.h.

void SoFaceDetail::setFaceIndex ( long  i) [inline]
Parameters:
iSystem long

Definition at line 133 of file SoFaceDetail.h.

References setFaceIndex().

Referenced by setFaceIndex().

void SoFaceDetail::setNumPoints ( int32_t  num)
void SoFaceDetail::setNumPoints ( long  num) [inline]
Parameters:
numSystem long

Definition at line 129 of file SoFaceDetail.h.

References setNumPoints().

Referenced by setNumPoints().

void SoFaceDetail::setPartIndex ( int32_t  i) [inline]

Definition at line 123 of file SoFaceDetail.h.

void SoFaceDetail::setPartIndex ( long  i) [inline]
Parameters:
iSystem long

Definition at line 135 of file SoFaceDetail.h.

References setPartIndex().

Referenced by setPartIndex().

void SoFaceDetail::setPoint ( long  index,
const SoPointDetail pd 
) [inline]
Parameters:
pdSystem long

Definition at line 131 of file SoFaceDetail.h.

References setPoint().

Referenced by setPoint().

void SoFaceDetail::setPoint ( int32_t  index,
const SoPointDetail pd 
)

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