SoVRMLIndexedShape(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 NAME 🎀

okay so bestie, pull up a chair, because this is SoVRMLIndexedShape(3) — straight out of the Library Functions Manual — and she's kind of a big deal.

SoVRMLIndexedShape — the class is a superclass for geometry that uses indexes. that's it, that's the whole job description. she's the momager, not the main character. (the main character is her kid, SoVRMLIndexedFaceSet, we'll get there.)

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLIndexedShape.h>

Inherits SoVRMLVertexShape.

Inherited by SoVRMLIndexedFaceSet.

so yeah, she's in the middle of the family tree. got a whole ancestry of member functions she inherited and never once said thank you for. let's meet the whole bloodline 💅

🫶 Public Member Functions 🫶

  • virtual SoType getTypeId (void) const — her own personal type ID moment, slay.

🦋 Public Member Functions inherited from SoVRMLVertexShape 🦋

lowkey these are all hers now, that's how inheritance works bestie, it's giving generational wealth:

  • virtual SbBool generateDefaultNormals (SoState *s, SoNormalBundle *nb)
  • virtual SbBool generateDefaultNormals (SoState *s, SoNormalCache *nc)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void pick (SoPickAction *action)

🌸 Public Member Functions inherited from SoVRMLGeometry 🌸

  • virtual void search (SoSearchAction *action)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

🌈 Public Member Functions inherited from SoShape 🌈

  • virtual SbBool affectsState (void) const
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • const SoBoundingBoxCache * getBoundingBoxCache (void) const

👑 Public Member Functions inherited from SoNode 👑

this list is long, bestie. hydrate. 💧

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const

🧚 Public Member Functions inherited from SoFieldContainer 🧚

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

💀 Public Member Functions inherited from SoBase 💀

the origin story. the blueprint. the ancestors.

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

⭐ Static Public Member Functions ⭐

the static girlies. they don't need an instance to show up, they just are. iconic behaviour honestly.

  • static SoType getClassTypeId (void)
  • static void initClass (void)

🌟 Static Public Member Functions inherited from SoVRMLVertexShape 🌟

  • static SoType getClassTypeId (void)
  • static void initClass (void)

💫 Static Public Member Functions inherited from SoVRMLGeometry 💫

  • static SoType getClassTypeId (void)
  • static void initClass (void)

🎆 Static Public Member Functions inherited from SoShape 🎆

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize)
  • static float getDecimatedComplexity (SoState *state, float complexity)

✨ Static Public Member Functions inherited from SoNode ✨

  • static uint32_t getCompatibilityTypes (const SoType &nodetype)
  • static SoType getClassTypeId (void)
  • static SoNode * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoNodeList &l)
  • static void initClass (void)
  • static void initClasses (void)
  • static uint32_t getNextNodeId (void)
  • static int getActionMethodIndex (const SoType type)
  • static void getBoundingBoxS (SoAction *action, SoNode *node)
  • static void GLRenderS (SoAction *action, SoNode *node)
  • static void callbackS (SoAction *action, SoNode *node)
  • static void getMatrixS (SoAction *action, SoNode *node)
  • static void handleEventS (SoAction *action, SoNode *node)
  • static void pickS (SoAction *action, SoNode *node)
  • static void rayPickS (SoAction *action, SoNode *node)
  • static void searchS (SoAction *action, SoNode *node)
  • static void writeS (SoAction *action, SoNode *node)
  • static void audioRenderS (SoAction *action, SoNode *node)
  • static void getPrimitiveCountS (SoAction *action, SoNode *node)

🍓 Static Public Member Functions inherited from SoFieldContainer 🍓

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void cleanupClass (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

💜 Static Public Member Functions inherited from SoBase 💜

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

🔥 Public Attributes 🔥

these are the fields, the actual data, the it factor. all of them are index lists — hence the name, bestie, it's all coming together:

  • SoMFInt32 coordIndex
  • SoMFInt32 colorIndex
  • SoMFInt32 normalIndex
  • SoMFInt32 texCoordIndex

🌺 Public Attributes inherited from SoVRMLVertexShape 🌺

  • SoSFNode coord
  • SoSFNode texCoord
  • SoSFNode normal
  • SoSFNode color
  • SoSFBool colorPerVertex
  • SoSFBool normalPerVertex

💅 Protected Member Functions 💅

protected = the inner circle only, bestie. if you're not a subclass, don't even look at these.

  • virtual const SoFieldData * getFieldData (void) const
  • SoVRMLIndexedShape (void) — the constructor, our girl's grand entrance
  • virtual ~SoVRMLIndexedShape () — the destructor, her exit, dramatic as always
  • virtual void notify (SoNotList *list)
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
  • SbBool getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const int32_t *&cindices, const int32_t *&nindices, const int32_t *&tindices, const int32_t *&mindices, int &numcindices, const SbBool neednormals, SbBool &normalcacheused)

🫧 Protected Member Functions inherited from SoVRMLVertexShape 🫧

  • SoVRMLVertexShape (void)
  • virtual ~SoVRMLVertexShape ()
  • virtual SbBool shouldGLRender (SoGLRenderAction *action)
  • void setNormalCache (SoState *s, int numNormals, SbVec3f *normals)
  • SoNormalCache * getNormalCache (void) const
  • SoNormalCache * generateAndReadLockNormalCache (SoState *const state)
  • void getVertexData (SoState *state, const SoCoordinateElement *&coords, const SbVec3f *&normals, const SbBool neednormals)
  • void readLockNormalCache (void)
  • void readUnlockNormalCache (void)
👀 yes, there are two different getVertexData in this family tree — the one up there with all the index pointers, and this one with just coords, normals and neednormals. don't mix them up bestie, that's a whole different function.

🌙 Protected Member Functions inherited from SoVRMLGeometry 🌙

  • SoVRMLGeometry (void)
  • virtual ~SoVRMLGeometry ()
  • void setupShapeHints (SoState *state, const SbBool ccw, const SbBool solid)
  • virtual SoChildList * getChildren (void) const

okay that's the whole synopsis bestie, every single signature accounted for, nothing skipped, we ate and left no crumbs 💖 and there is so much more coming — the description, the fields, the whole lore — so don't you dare close the terminal, part 2 is right there 🦋

okay bestie, we're picking up right where we left off — no re-intro, no recap, just vibes 💅 these are the protected member functions our girl inherits from SoShape, and yeah… there's a LOT of them. buckle in 🎀

  • SoShape (void)
  • virtual ~SoShape ()
  • float getComplexityValue (SoAction *action)
  • virtual void generatePrimitives (SoAction *action)=0
  • void beginSolidShape (SoGLRenderAction *action)
  • void endSolidShape (SoGLRenderAction *action)
  • void GLRenderBoundingBox (SoGLRenderAction *action)
  • SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action)
  • SbBool shouldRayPick (SoRayPickAction *const action)
  • void computeObjectSpaceRay (SoRayPickAction *const action)
  • void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix)
  • virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
  • virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)
  • virtual SoDetail * createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp)
  • void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3)
  • void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2)
  • void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v)
  • void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL)
  • void shapeVertex (const SoPrimitiveVertex *const v)
  • void endShape (void)
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *const tce, const float s, const float t, const float r, const SbVec3f &normal)
  • SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)
  • void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)

and from SoNode we get these three 🦋

  • SoNode (void)
  • virtual ~SoNode ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

and from SoFieldContainer, just the classics 🌸

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

and from SoBase, the OGs of the whole family tree ✨

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const

✨ Static Protected Member Functions ✨

just one, and she's serving:

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoVRMLVertexShape ✨

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoVRMLGeometry ✨

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoShape ✨

  • static const SoFieldData ** getFieldDataPtr (void)

✨ Static Protected Member Functions inherited from SoNode ✨

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void setNextActionMethodIndex (int index)
  • static int getNextActionMethodIndex (void)
  • static void incNextActionMethodIndex (void)
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

✨ Static Protected Member Functions inherited from SoBase ✨

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

🫶 Additional Inherited Members 🫶

Public Types inherited from SoVRMLVertexShape

the material binding era, lowkey iconic:

enum Binding { OVERALL = SoMaterialBindingElement::OVERALL, PER_PART =
    SoMaterialBindingElement::PER_PART, PER_PART_INDEXED =
    SoMaterialBindingElement::PER_PART_INDEXED, PER_FACE =
    SoMaterialBindingElement::PER_FACE, PER_FACE_INDEXED =
    SoMaterialBindingElement::PER_FACE_INDEXED, PER_VERTEX =
    SoMaterialBindingElement::PER_VERTEX, PER_VERTEX_INDEXED =
    SoMaterialBindingElement::PER_VERTEX_INDEXED }

Public Types inherited from SoShape

every way a shape can be shaped, fr fr:

enum TriangleShape { TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, POLYGON,
    QUADS, QUAD_STRIP, POINTS, LINES, LINE_STRIP }

Public Types inherited from SoNode

the node-type bitmask buffet — literally every era of Coin/Inventor in one enum 👑

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Protected Attributes inherited from SoNode

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

💖 Detailed Description 💖

okay so the tea: SoVRMLIndexedShape is a superclass for geometry that use indexes. that's the whole plot bestie — she's the blueprint other nodes build on, not a standalone star 🦋

🎀 Constructor & Destructor Documentation 🎀

SoVRMLIndexedShape::SoVRMLIndexedShape (void ) [protected]

Constructor. she's born 💖

SoVRMLIndexedShape::~SoVRMLIndexedShape () [protected], [virtual]

Destructor. she's leaving, but make it graceful 💅

⭐ Member Function Documentation ⭐

SoType SoVRMLIndexedShape::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example, copied exactly so you can peek at the fit:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

okay so for all the app devs out there wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. no skipping, it's mandatory bestie 😭 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 for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoVRMLVertexShape.

Reimplemented in SoVRMLIndexedFaceSet.

const SoFieldData * SoVRMLIndexedShape::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoVRMLVertexShape.

Reimplemented in SoVRMLIndexedFaceSet.

void SoVRMLIndexedShape::notify (SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made. she's the gossip, she tells everyone 👀

Reimplemented from SoVRMLVertexShape.

void SoVRMLIndexedShape::computeBBox (SoAction * action, SbBox3f & box, SbVec3f & center) [protected], [virtual]

Implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box.

The bounding box and center point should be calculated and returned in the local coordinate system.

The method implements action behavior for shape nodes for SoGetBoundingBoxAction. It is invoked from SoShape::getBoundingBox(). (Subclasses should not override SoNode::getBoundingBox().)

heads up bestie: the box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry. don't trust her yet 💀

Implements SoShape.

SbBool SoVRMLIndexedShape::getVertexData (SoState * state, const SoCoordinateElement *& coords, const SbVec3f *& normals, const int32_t *& cindices, const int32_t *& nindices, const int32_t *& tindices, const int32_t *& mindices, int & numcindices, const SbBool neednormals, SbBool & normalcacheused) [protected]

Convenience method that will fetch data needed for rendering or generating primitives. Takes care of normal cache. she does the boring errands so you don't have to 🫶

🌈 Member Data Documentation 🌈

SoMFInt32 SoVRMLIndexedShape::coordIndex

The coordinate index array. the main character of index arrays, no cap ✨

SoMFInt32 SoVRMLIndexedShape::colorIndex

The color index array. 🎨

SoMFInt32 SoVRMLIndexedShape::normalIndex

The normal index array. she's the direction-coded one 💅

SoMFInt32 SoVRMLIndexedShape::texCoordIndex

The texture coordinate index array. slay, texture girl 🦋

🧚 Author 🧚

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap bestie!! this page is straight outta Coin Version 3.1.3, filed as SoVRMLIndexedShape(3) — go forth and index your geometry, you absolute icon 👑💖

📦 where this page comes from