Linux Certif

Toute la documentation sur la certification Linux LPI

SoFaceDetail.3coin2

NAME

SoFaceDetail -

The SoFaceDetail class is for storing detailed polygon information.

Instances of this class are used among other things for storing information about polygons after pick operations, and for storing information returned to tessellation callbacks.

SYNOPSIS

#include <Inventor/details/SoFaceDetail.h>

Inherits SoDetail.

Public Member Functions

SoFaceDetail (void)

virtual ~SoFaceDetail ()

virtual SoDetail * copy (void) const

int getNumPoints (void) const

const SoPointDetail * getPoint (const int idx) const

SoPointDetail * getPoints (void)

int getFaceIndex (void) const

int getPartIndex (void) const

void setNumPoints (const int num)

void setPoint (const int idx, const SoPointDetail *const detail)

void setFaceIndex (const int idx)

void setPartIndex (const int idx)

void incFaceIndex (void)

void incPartIndex (void)

Static Public Member Functions

static void initClass (void)

Detailed Description

The SoFaceDetail class is for storing detailed polygon information.

Instances of this class are used among other things for storing information about polygons after pick operations, and for storing information returned to tessellation callbacks.

Note that a SoFaceDetail instance consists of a set of SoPointDetail instances, one for each vertex of the polygon it represents.

See also:

SoRayPickAction, SoPickedPoint, SoCallbackAction

Constructor & Destructor Documentation

SoFaceDetail::SoFaceDetail (void)Default constructor sets up an empty, non-valid detail specification.

Referenced by copy().

SoFaceDetail::~SoFaceDetail () [virtual]Destructor, free internal resources used for storing the polygon vertices.

Member Function Documentation

void SoFaceDetail::initClass (void) [static]Initialize relevant common data for all instances, like the type system.

Reimplemented from SoDetail.

SoDetail * SoFaceDetail::copy (void) const [virtual]Return a deep copy of ourself.

Note that if the Coin library has been built as a DLL under Microsoft Windows and you use this method from application code, you must make sure that both the Coin DLL and the application executable is using the same instance of a C Run-Time (CRT) library. Otherwise, you will get memory heap corruption upon deallocating the returned instances, eventually leading to mysterious crashes.

Implements SoDetail.

References getPoint(), setNumPoints(), setPoint(), and SoFaceDetail().

int SoFaceDetail::getNumPoints (void) constNumber of vertices making up the polygon.

const SoPointDetail * SoFaceDetail::getPoint (const int idx) constReturns a pointer into the array of vertices, starting at the idx'th vertice of the polygon.

The array will contain (SoFaceDetail::getNumPoints() - idx) elements.

Referenced by copy().

SoPointDetail * SoFaceDetail::getPoints (void)Returns the full array of vertice details for the polygon. The array will contain SoFaceDetail::getNumPoints() elements.

int SoFaceDetail::getFaceIndex (void) constReturns the index of this polygon within the faceset node it is part of.

int SoFaceDetail::getPartIndex (void) constIf this SoFaceDetail represents a triangle tessellated from a complex shape, this method returns the index of the part of the complex shape it was tessellated from.

void SoFaceDetail::setNumPoints (const int num)Used internally from library client code setting up a SoFaceDetail instance.

See also:

getNumPoints()

Referenced by copy().

void SoFaceDetail::setPoint (const int idx, const SoPointDetail *const detail)Used internally from library client code setting up a SoFaceDetail instance.

See also:

getPoint(), getPoints()

Referenced by copy().

void SoFaceDetail::setFaceIndex (const int idx)Used internally from library client code setting up a SoFaceDetail instance.

See also:

getFaceIndex()

Referenced by SoTriangleStripSet::generatePrimitives(), SoQuadMesh::generatePrimitives(), and SoIndexedTriangleStripSet::generatePrimitives().

void SoFaceDetail::setPartIndex (const int idx)Used internally from library client code setting up a SoFaceDetail instance.

See also:

getPartIndex()

void SoFaceDetail::incFaceIndex (void)Used internally from library client code setting up a SoFaceDetail instance.

This function is specific for Coin, and is not present in SGI/TGS Open Inventor.

Referenced by SoTriangleStripSet::generatePrimitives(), SoQuadMesh::generatePrimitives(), SoIndexedTriangleStripSet::generatePrimitives(), SoIndexedFaceSet::generatePrimitives(), and SoFaceSet::generatePrimitives().

void SoFaceDetail::incPartIndex (void)Used internally from library client code setting up a SoFaceDetail instance.

This function is specific for Coin, and is not present in SGI/TGS Open Inventor.

Referenced by SoTriangleStripSet::generatePrimitives(), SoQuadMesh::generatePrimitives(), SoIndexedTriangleStripSet::generatePrimitives(), and SoIndexedFaceSet::generatePrimitives().

Author

Generated automatically by Doxygen for Coin from the source code.