SoColorIndex(3)

💖 NAME 💖

okay so SoColorIndex — bestie, the whole entire job of this class is to specify color indices for subsequent shapes. That's it. That's the assignment. And she ate. 👑

(also hi, this is the page for SoColorIndex(3) from the Coin manual — yes that Coin, the 3D graphics toolkit one, iykyk 🪙)

---

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoColorIndex.h>

Inherits SoNode.

so like, the family tree situation: she is a SoNode, which means she inherited a truly unhinged amount of stuff. Let's go through it, no skipping, we don't gatekeep here 💅

✨ Public Member Functions ✨

these are the ones that are hers, the main character functions:

virtual SoType getTypeId (void) const
SoColorIndex (void)
virtual void GLRender (SoGLRenderAction *action)

🌸 Public Member Functions inherited from SoNode 🌸

the freebies from SoNode, and there are... so many. not me counting them. there are a lot:

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 SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
SbUniqueId getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainer * copyThroughConnection (void) const

🎀 Public Member Functions inherited from SoFieldContainer 🎀

more inheritance, because of course there is. SoFieldContainer said "here, hold these":

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 💜

and the OG ancestor SoBase showing up with the ref-counting lore:

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

one of these comes with a lil explanation attached, and bestie I'm keeping it because it's genuinely useful: isOfType() — Returns TRUE if the type of this object is either of the same type or inherited from type. so basically "are you her or one of her ancestors", periodt 🌈

👑 Static Public Member Functions 👑

the static girls. they don't need an instance to function, they're that independent:

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

and initClass() does this: Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

🌟 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 SbUniqueId 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)

and this initClass() here: Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

🦄 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)

notes on two of these, straight from the source:

• initClass() — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
• getClassTypeId() — This static method returns the SoType object associated with objects of this class.

🌈 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)

and the same two notes carry over here too:

• initClass() — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
• getClassTypeId() — This static method returns the SoType object associated with objects of this class.

💅 Public Attributes 💅

the actual data she's carrying around, and it's just one thing, because she's focused:

• SoMFInt32 index

🎯 Protected Member Functions 🎯

for the inner circle only, don't touch:

virtual const SoFieldData * getFieldData (void) const
virtual ~SoColorIndex ()

🍓 Protected Member Functions inherited from SoNode 🍓

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

🧚 Protected Member Functions inherited from SoFieldContainer 🧚

SoFieldContainer (void)
virtual ~SoFieldContainer ()

🌸 Protected Member Functions inherited from SoBase 🌸

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
virtual SoNotRec createNotRec (void)

⭐ Static Protected Member Functions ⭐

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 👑

the deep lore. the ancestry. buckle up.

🎀 Public Types inherited from SoNode 🎀

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, COIN_4_0 = 0x20000 }

🦋 Protected Types inherited from SoBase 🦋

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

💜 Protected Attributes inherited from SoNode 💜

• SbUniqueId uniqueId

🌸 Protected Attributes inherited from SoFieldContainer 🌸

• SbBool isBuiltIn

🌟 Static Protected Attributes inherited from SoNode 🌟

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

---

✨ Detailed Description ✨

The SoColorIndex class is used to specify color indices for subsequent shapes. (yes girl, same sentence as the NAME section, she's consistent 💅)

okay so here's the important tea: this node should only be used in OpenGL color index mode, and only when the current light model is set to SoLightModel::BASE_COLOR. if you're not doing both of those things, this is not your girl, respectfully 🙈

so what even is OpenGL color index mode? bestie it's where the colors for individual pixels are fetched from a color lookup table, aka a "CLUT". The usual thing to do is to set up a canvas in RGBA true color mode. (that's the normie path, and it's fine!!)

one common use for color index mode OpenGL canvases is to use one in the overlay planes — which are usually limited to only 2 or 4 available colors — if supported by the OpenGL hardware and / or driver. so like, tiny palette, big vibes. 🎨

FILE FORMAT/DEFAULTS:

ColorIndex {
    index 1
}

---

🎀 Constructor & Destructor Documentation 🎀

SoColorIndex::SoColorIndex (void )

Constructor.

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

Destructor.

---

okay bestie that's the whole synopsis situation and the class lore — part 2 is loading, do not go anywhere 💖

✨ Member Function Documentation ✨

okay bestie this is the part where we meet the actual little functions that do the work 💖 every one of them is listed, no skips, no shortcuts, periodt.

---

🌸 SoType SoColorIndex::getClassTypeId(void) — [static]

this one is a static method and it hands you back the SoType object that's associated with objects of this class. that's it, that's the whole job 🎀 it's the "hey what even ARE you" question answered at the class level.

---

🦋 SoType SoColorIndex::getTypeId(void) const — [virtual]

this one gives you the type identification of an object that's derived from a class inheriting SoBase. what's it for? runtime type checking and "downward" casting, bestie — iykyk, that's the classic move where you're like "okay but are you actually one of these" and the code checks before it commits 💅

Implements SoBase. — yeah she's fulfilling that contract, iconic behaviour.

---

🌈 const SoFieldData ** SoColorIndex::getFieldDataPtr(void) — [static], [protected]

lowkey this API member is considered internal to the library, because it's not likely to be of interest to the application programmer 🙈 so like… you can look, but she's not for you, she's for the library's own business.

what does it return though? the SoFieldData class which holds information about fields in this node. so even though it's off-limits vibes, the facts are: it gives you the SoFieldData holding this node's field info ✨

---

🎀 const SoFieldData * SoColorIndex::getFieldData(void) const — [protected], [virtual]

this one returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. no fields, no pointer, that's just how she is 😭

Reimplemented from SoFieldContainer.

---

👑 void SoColorIndex::GLRender(SoGLRenderAction * action) — [virtual]

this is the action method for the SoGLRenderAction, and she's main character energy during rendering traversals 🔥

the way that it works: nodes that influence the rendering state in any way — or that want to throw geometry primitives at OpenGL — override this method. that's the whole vibe. you influence state, or you yeet geometry at OpenGL, and either way you're overriding GLRender 💅

Reimplemented from SoNode.

---

🍓 Member Data Documentation 🍓

⭐ SoMFInt32 SoColorIndex::index

color indices which can be used by shapes. that's the data, bestie, a whole field of SoMFInt32 just sitting there full of color indices waiting to be used 🌸

---

💜 Author

generated automatically by Doxygen for Coin from the source code. not me writing it by hand, the machine did that 🙈

---

okay so that's the whole page!! this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it lives in the SoColorIndex(3) manual page slot. slay, go forth and index your colors responsibly 🫶✨💖