SoFaceDetail Class Reference

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

#include <Inventor/details/SoFaceDetail.h>

Inheritance diagram for SoFaceDetail:

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 SoPointDetail *	getPoint (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 SoDetail *	copy () 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)
SoPointDetail *	getPoints ()
	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)
Public Member Functions inherited from SoDetail
virtual	~SoDetail ()
	Destructor.
virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.
bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
virtual SoDetail *	copy () const =0
	Returns an instance that is a copy of this instance.

Static Public Member Functions
static void	initClass ()
Static Public Member Functions inherited from SoDetail
static SoType	getClassTypeId ()
	Returns type identifier for this class.
static void	initClass ()
static void	initClasses ()
	Initialize ALL Inventor detail classes.

Additional Inherited Members
Protected Member Functions inherited from SoDetail
	SoDetail ()
	Constructor is protected since this is an abstract class.

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::SoFaceDetail

(

)

~SoFaceDetail()

virtual SoFaceDetail::~SoFaceDetail ( )

virtual

Member Function Documentation

copy()

virtual SoDetail * SoFaceDetail::copy ( ) const

virtual

The caller is responsible for deleting the copy when done.

Implements SoDetail.

getFaceIndex()

int32_t SoFaceDetail::getFaceIndex ( ) const

inline

Definition at line 105 of file SoFaceDetail.h.

getNumPoints()

int32_t SoFaceDetail::getNumPoints ( ) const

inline

Definition at line 98 of file SoFaceDetail.h.

getPartIndex()

int32_t SoFaceDetail::getPartIndex ( ) const

inline

Definition at line 108 of file SoFaceDetail.h.

getPoint()

const SoPointDetail * SoFaceDetail::getPoint ( int  i ) const

inline

Definition at line 102 of file SoFaceDetail.h.

getPoints()

SoPointDetail * SoFaceDetail::getPoints ( )

inline

Definition at line 126 of file SoFaceDetail.h.

initClass()

static void SoFaceDetail::initClass ( )

static

setFaceIndex() [1/2]

void SoFaceDetail::setFaceIndex ( int32_t  i )

inline

Definition at line 122 of file SoFaceDetail.h.

setFaceIndex() [2/2]

void SoFaceDetail::setFaceIndex ( long  i )

inline

Parameters

i	System long

Definition at line 133 of file SoFaceDetail.h.

setNumPoints() [1/2]

void SoFaceDetail::setNumPoints

(

int32_t

num

)

setNumPoints() [2/2]

void SoFaceDetail::setNumPoints ( long  num )

inline

Parameters

num	System long

Definition at line 129 of file SoFaceDetail.h.

setPartIndex() [1/2]

void SoFaceDetail::setPartIndex ( int32_t  i )

inline

Definition at line 123 of file SoFaceDetail.h.

setPartIndex() [2/2]

void SoFaceDetail::setPartIndex ( long  i )

inline

Parameters

i	System long

Definition at line 135 of file SoFaceDetail.h.

setPoint() [1/2]

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

setPoint() [2/2]

void SoFaceDetail::setPoint ( long  index, const SoPointDetail *  pd  )

inline

Parameters

pd	System long

Definition at line 131 of file SoFaceDetail.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/details/SoFaceDetail.h