.TH "SoFaceDetail" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoFaceDetail \- The \fBSoFaceDetail\fP class is for storing detailed polygon information\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoDetail\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const" .br .ti -1c .RI "\fBSoFaceDetail\fP (void)" .br .ti -1c .RI "virtual \fB~SoFaceDetail\fP ()" .br .ti -1c .RI "virtual \fBSoDetail\fP * \fBcopy\fP (void) const" .br .ti -1c .RI "int \fBgetNumPoints\fP (void) const" .br .ti -1c .RI "const \fBSoPointDetail\fP * \fBgetPoint\fP (const int idx) const" .br .ti -1c .RI "\fBSoPointDetail\fP * \fBgetPoints\fP (void)" .br .ti -1c .RI "int \fBgetFaceIndex\fP (void) const" .br .ti -1c .RI "int \fBgetPartIndex\fP (void) const" .br .ti -1c .RI "void \fBsetNumPoints\fP (const int num)" .br .ti -1c .RI "void \fBsetPoint\fP (const int idx, const \fBSoPointDetail\fP *const detail)" .br .ti -1c .RI "void \fBsetFaceIndex\fP (const int idx)" .br .ti -1c .RI "void \fBsetPartIndex\fP (const int idx)" .br .ti -1c .RI "void \fBincFaceIndex\fP (void)" .br .ti -1c .RI "void \fBincPartIndex\fP (void)" .br .in -1c Public Member Functions inherited from \fBSoDetail\fP .in +1c .ti -1c .RI "virtual \fB~SoDetail\fP ()" .br .ti -1c .RI "SbBool \fBisOfType\fP (const \fBSoType\fP type) const" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBcleanupClass\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBSoDetail\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBinitClasses\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .in -1c .SS "Additional Inherited Members" Protected Member Functions inherited from \fBSoDetail\fP .in +1c .ti -1c .RI "\fBSoDetail\fP (void)" .br .in -1c .SH "Detailed Description" .PP The \fBSoFaceDetail\fP 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\&. .PP Note that a \fBSoFaceDetail\fP instance consists of a set of \fBSoPointDetail\fP instances, one for each vertex of the polygon it represents\&. .PP \fBSee also\fP .RS 4 \fBSoRayPickAction\fP, \fBSoPickedPoint\fP, \fBSoCallbackAction\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoFaceDetail::SoFaceDetail (void )" Default constructor sets up an empty, non-valid detail specification\&. .SS "SoFaceDetail::~SoFaceDetail ()\fR [virtual]\fP" Destructor, free internal resources used for storing the polygon vertices\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoFaceDetail::getTypeId (void ) const\fR [virtual]\fP" Returns the type identification of an object derived from a class inheriting \fBSoDetail\fP\&. This is used for runtime type checking and 'downward' casting\&. .br .PP Implements \fBSoDetail\fP\&. .SS "\fBSoType\fP SoFaceDetail::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "static void SoFaceDetail::cleanupClass (void )\fR [inline]\fP, \fR [static]\fP" This static method cleans up static data of the class\&. .br .SS "\fBSoDetail\fP * SoFaceDetail::copy (void ) const\fR [virtual]\fP" Return a deep copy of ourself\&. .PP \fBNote that if the Coin library has been built as a DLL under Microsoft Windows and you use this method from application code, you \fImust\fP make sure that both the Coin DLL and the application executable are using the same instance of a C Run-Time (CRT) library\&. Otherwise, you \fIwill\fP get memory heap corruption upon deallocating the returned instances, eventually leading to mysterious crashes\&.\fP .br .br .PP Implements \fBSoDetail\fP\&. .SS "int SoFaceDetail::getNumPoints (void ) const" Number of vertices making up the polygon\&. .SS "const \fBSoPointDetail\fP * SoFaceDetail::getPoint (const int idx) const" Returns a pointer into the array of vertices, starting at the \fIidx'th\fP vertex of the polygon\&. .PP The array will contain (\fBSoFaceDetail::getNumPoints()\fP - \fIidx\fP) elements\&. .SS "\fBSoPointDetail\fP * SoFaceDetail::getPoints (void )" Returns the full array of vertices details for the polygon\&. The array will contain \fBSoFaceDetail::getNumPoints()\fP elements\&. .SS "int SoFaceDetail::getFaceIndex (void ) const" Returns the index of this polygon within the faceset node it is part of\&. .SS "int SoFaceDetail::getPartIndex (void ) const" If this \fBSoFaceDetail\fP represents a triangle tessellated from a complex shape, this method returns the index of the part of the complex shape it was tessellated from\&. .SS "void SoFaceDetail::setNumPoints (const int num)" Used internally from library client code setting up a \fBSoFaceDetail\fP instance\&. .PP \fBSee also\fP .RS 4 \fBgetNumPoints()\fP .RE .PP .SS "void SoFaceDetail::setPoint (const int idx, const \fBSoPointDetail\fP *const detail)" Used internally from library client code setting up a \fBSoFaceDetail\fP instance\&. .PP \fBSee also\fP .RS 4 \fBgetPoint()\fP, \fBgetPoints()\fP .RE .PP .SS "void SoFaceDetail::setFaceIndex (const int idx)" Used internally from library client code setting up a \fBSoFaceDetail\fP instance\&. .PP \fBSee also\fP .RS 4 \fBgetFaceIndex()\fP .RE .PP .SS "void SoFaceDetail::setPartIndex (const int idx)" Used internally from library client code setting up a \fBSoFaceDetail\fP instance\&. .PP \fBSee also\fP .RS 4 \fBgetPartIndex()\fP .RE .PP .SS "void SoFaceDetail::incFaceIndex (void )" Used internally from library client code setting up a \fBSoFaceDetail\fP instance\&. .PP This function is specific for Coin, and is not present in SGI/TGS Open Inventor\&. .SS "void SoFaceDetail::incPartIndex (void )" Used internally from library client code setting up a \fBSoFaceDetail\fP instance\&. .PP This function is specific for Coin, and is not present in SGI/TGS Open Inventor\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.