SoFaceDetail(3)

📦 version 3.1.3, in fedora 43, fedora 44

💅 SoFaceDetail(3) — Library Functions Manual 🎀

okay bestie, buckle up, we're doing the SoFaceDetail(3) page and it's literally all about storing detailed polygon info. no cap. let's get into it 💖

✨ NAME ✨

SoFaceDetail — the class that's out here storing detailed polygon information. that's the whole job. she's a keeper 🫶

🌸 SYNOPSIS 🌸

#include <Inventor/details/SoFaceDetail.h>

Inherits SoDetail.

👑 Public Member Functions

virtual SoType getTypeId (void) const
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)

🌈 Public Member Functions inherited from `SoDetail`

virtual ~SoDetail ()
SbBool isOfType (const SoType type) const

⭐ Static Public Member Functions

static SoType getClassTypeId (void)
static void cleanupClass (void)
static void initClass (void)

🌈 Static Public Member Functions inherited from `SoDetail`

static void initClass (void)
static void initClasses (void)
static SoType getClassTypeId (void)

🦋 Additional Inherited Members

Protected Member Functions inherited from `SoDetail`

SoDetail (void)

💖 Detailed Description 💖

the SoFaceDetail class is for storing detailed polygon information. she said what she said. ✨

instances of this class get used, among other things, for storing information about polygons after pick operations, and for storing information returned to tessellation callbacks. multitasking queen 👑

not me reminding you that a SoFaceDetail instance consists of a set of SoPointDetail instances, one for each vertex of the polygon it represents. that's the whole structure, one per vertex, no skips 💅

See also SoRayPickAction, SoPickedPoint, SoCallbackAction

🎀 Constructor & Destructor Documentation 🎀

`SoFaceDetail::SoFaceDetail (void )`

default constructor sets up an empty, non-valid detail specification. she's a blank canvas, an empty vibe, awaiting her moment 🦋

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

destructor, free internal resources used for storing the polygon vertices. say bye bestie, she's releasing the storage 👋

🔥 Member Function Documentation 🔥

`SoType SoFaceDetail::getTypeId (void ) const [virtual]`

returns the type identification of a detail derived from a class inheriting SoDetail. this is used for run-time type checking and "downward" casting. very demure, very type-safe ✨

usage example:

void fuhbear(SoDetail * detail)
{
  if (detail->getTypeId() == SoFaceDetail::getClassTypeId()) {
    // safe downward cast, know the type
    SoFaceDetail * facedetail = (SoFaceDetail *)detail;
  }
  return; // ignore if not a SoFaceDetail
}

for application programmers wanting to extend the library with new detail classes: this method needs to be overridden in all subclasses. this is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through Inventor/nodes/SoSubDetail.h: SO_DETAIL_SOURCE and SO_DETAIL_INIT_CLASS.

Implements SoDetail.

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

return a deep copy of ourself. she's cloning herself, main character energy fr fr 👑

⚠️ 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. 💀 not the mysterious crashes bestie, please read this part.

Implements SoDetail.

`int SoFaceDetail::getNumPoints (void ) const`

number of vertices making up the polygon. counting the girlies 🔢

`const SoPointDetail * SoFaceDetail::getPoint (const int idx) const`

returns a pointer into the array of vertices, starting at the idx'th vertice of the polygon.

the array will contain (SoFaceDetail::getNumPoints() - idx) elements. math is math 💅

`SoPointDetail * SoFaceDetail::getPoints (void )`

returns the full array of vertice details for the polygon. the array will contain SoFaceDetail::getNumPoints() elements. the whole squad, assembled 🌈

`int SoFaceDetail::getFaceIndex (void ) const`

returns the index of this polygon within the faceset node it is part of. she knows her place in the lineup ✨

`int SoFaceDetail::getPartIndex (void ) const`

if 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. tracing her origin story 🧚