SoBaseColor(3)

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

✨ SoBaseColor ✨

okay bestie, welcome to the SoBaseColor page 💖 — yes, the one from the Coin manual, aka SoBaseColor(3). Settle in, grab a snack, it's a long one and we're only doing part 1 of 2 rn. Let's go 🫶

💖 NAME 💖

SoBaseColor — the node class that gives you a convenient little shortcut for setting the base material color. That's the whole job. Iconic, honestly.

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoBaseColor.h>

Inherits SoNode.

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • SoBaseColor (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) — 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) — 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 rgb

🌸 Protected Member Functions 🌸

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

🦋 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 SoBaseColor class provides a node type for convenient setting of the base material color.

So like — if all you wanna do is set the diffuse color of whatever geometry comes next, bestie, you can just use this node for simplicity. No need to drag the whole SoMaterial situation in. It's giving minimal effort, maximum slay 💅.

📄 FILE FORMAT/DEFAULTS

BaseColor {
    rgb 0.8 0.8 0.8
}

👀 See also

  • SoMaterial

💅 Constructor & Destructor Documentation 💅

SoBaseColor::SoBaseColor (void )

Constructor. She's born ✨.

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

Destructor. She's gone 😭 (protected, so like, don't try this at home).

okay so that's the whole first half and we are not done yet — more follows, so don't go anywhere bestie 🫶

💖 Member Function Documentation 💖

okay bestie, this is the part where we meet the actual functions — the little guys that do the work. stay with me, they're all listed in order and i'm not skipping a single one. 🫶

🦋 SoType SoBaseColor::getClassTypeId (void ) [static]

This is the static one — call it on the class itself, not on an instance. It hands you back the SoType object that's associated with objects of this class. that's it, that's the whole job. ✨

🌸 SoType SoBaseColor::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what powers runtime type checking and "downward" casting — you know, when you're like "okay but is this actually the type i think it is" and the answer comes back in real time. 💅

It implements SoBase. so it's not just vibes, it's contractual.

🎀 const SoFieldData ** SoBaseColor::getFieldDataPtr (void ) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like… you can look, but it's giving backstage-pass energy, not front-row. 🙈

It returns the SoFieldData class which holds information about fields in this node.

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

Returns a pointer to the class-wide field data storage object for this instance. And listen — if there are no fields present, it returns NULL. that's the rule, no exceptions. 🫶

Reimplemented from SoFieldContainer.

🔥 void SoBaseColor::doAction (SoAction * action) [virtual]

This one performs the typical operation of a node for any action. like, any action at all. it's the generalist, the "i got you whatever you need" friend. 👑

Reimplemented from SoNode.

⭐ void SoBaseColor::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes that influence the rendering state in any way — or that want to throw geometry primitives at OpenGL — override this method. so if you're the kind of node that touches the render state, this is your moment. ✨

Reimplemented from SoNode.

🌈 void SoBaseColor::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

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. lowkey the most useful little spy in the whole scene. 🕵️‍♀️

Reimplemented from SoNode.

💜 Member Data Documentation 💜

🍓 SoMFColor SoBaseColor::rgb

Color values. Default value of field is to have a single gray color. so if you don't set anything, bestie, you get gray. no cap. 🎨

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. (not a human, just a very diligent robot doing its thing fr fr 🤖✨)

okay that's the whole page, you made it, i'm so proud of you 💖 this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoBaseColor(3) manual page — so go forth, color your scene graphs, and slay. periodt. 💅🌈🎀

📦 where this page comes from