SoVRMLColor(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoVRMLColor — the manual page, bestie edition 💖

okay so this is SoVRMLColor(3), one of the Coin pages, and it's a whole vibe. it's long so we're doing it in parts, and this is part one. buckle up, hydrate, let's go 🫶

✨ NAME ✨

SoVRMLColor — the class that exists to specify multiple colors for a single shape. that's it. that's the whole job. and it does it beautifully. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/VRMLnodes/SoVRMLColor.h>

Inherits SoNode. so it's got all that SoNode energy, plus its own thing going on.

👑 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoVRMLColor (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)

💜 Public Member Functions inherited from SoNode

  • 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 GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *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

  • 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

  • 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 — Returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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

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

💫 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • 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)

🎀 Static Public Member Functions inherited from SoFieldContainer

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

  • SoMFColor color

🌸 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLColor ()

💐 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

🌟 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 SoVRMLColor class is used to specify multiple colors for a single shape. yes, we said that already, but it's the whole point of the class so we're saying it again. it's giving "one shape, many colors, no notes". 🎨

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium.
Color {
  exposedField MFColor color  []         # [0,1]
}

This node defines a set of RGB colours to be used in the fields of another node. 💡

Color nodes are only used to specify multiple colours for a single geometric shape, such as colours for the faces or vertices of an IndexedFaceSet. A Material node is used to specify the overall material parameters of lit geometry. If both a Material node and a Color node are specified for a geometric shape, the colours shall replace the diffuse component of the material. RGB or RGBA textures take precedence over colours; specifying both an RGB or RGBA texture and a Color node for geometric shape will result in the Color node being ignored. Details on lighting equations can be found in 4.14, Lighting model (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.14).

ngl bestie, that last sentence about textures is the important one: if there's a texture in the mix, the Color node just gets ghosted entirely. no cap. 👻

🎬 Constructor & Destructor Documentation 🎬

🍼 SoVRMLColor::SoVRMLColor (void )

Constructor. makes a brand new one. ✨

💀 SoVRMLColor::~SoVRMLColor () [protected], [virtual]

Destructor. it's protected and virtual, so it says goodbye on its own terms. 💅

and that's only, like, half of the whole thing — the rest is right there in part two, keep scrolling bestie 🦋

💖 Member Function Documentation 💖

Okay bestie, this is where it gets ✨spicy✨ — all the functions you can actually call. Let's go one by one, no skipping, we're thorough in this house 🫶

⭐ SoType SoVRMLColor::getClassTypeId (void ) — static

This static cutie returns the SoType object that's associated with objects of this class. That's it, that's the job. Iconic, honestly.

🌸 SoType SoVRMLColor::getTypeId (void ) const — virtual

This one returns the type identification of an object derived from a class that inherits SoBase. What's it for? Runtime type checking and "downward" casting, periodt. So like, figuring out what something actually is while the program is running, then casting it down the inheritance tree. Very main character behaviour.

It implements SoBase — so this is the override that does the real work for this class, fr fr.

🎀 const SoFieldData ** SoVRMLColor::getFieldDataPtr (void ) — static, protected

ngl, this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. So like… if you're just writing an app, this is not your moment. 🙈

That said, it returns the SoFieldData class which holds information about fields in this node. iykyk.

🦋 const SoFieldData * SoVRMLColor::getFieldData (void ) const — protected, virtual

This sweetie returns a pointer to the class-wide field data storage object for this instance. And important caveat, bestie: if no fields are present, it returns NULL. So check before you dereference, okay? We don't do segfaults in this group chat. 💀

Reimplemented from SoFieldContainer.

👑 void SoVRMLColor::initClass (void ) — static

No description given for this one in the source — it's just the class init hook, sitting there, mysterious, serving looks. ✨

🔥 void SoVRMLColor::doAction (SoAction * action) — virtual

This function performs the typical operation of a node for any action. Any action at all — it's the general-purpose "do the thing" method. Versatile queen.

Reimplemented from SoNode.

🌈 void SoVRMLColor::GLRender (SoGLRenderAction * action) — virtual

Action method for the SoGLRenderAction, babes. This gets called during rendering traversals. And the vibe check here is: any node that influences the rendering state in any way — or that wants to throw geometry primitives at OpenGL — overrides this method. That's you, if you're doing graphics things. 💅

Reimplemented from SoNode.

💜 void SoVRMLColor::callback (SoCallbackAction * action) — virtual

Action method for SoCallbackAction.

What does it do? Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. So it's like, "hey, behave the same way you would for rendering, so I can peek at what's going on." Sneaky and useful. 🧚

Reimplemented from SoNode.

🍓 Member Data Documentation 🍓

SoMFColor SoVRMLColor::color

The color field, bestie. Empty by default. So if you were expecting colors to just appear — nope, she's starting out empty and you gotta fill her up yourself. 🌸

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. Not a human, not a poet — just Doxygen doing its lil thing. 💖

And that's a wrap on SoVRMLColor(3), bestie!! 🎉 This page came from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00 — so jot that down if you're citing her. Go forth and color your scene graph, you absolute icon. 🫶💅✨

📦 where this page comes from