SoPackedColor(3)

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

💅 SoPackedColor(3) 💅

okay bestie, so this is the SoPackedColor man page from the Coin crew, and heads up — it's a long one, so it's split into two parts and this right here is part 1 🫶. Buckle in, grab a strawberry lemonade 🍓, and let's get into it.

🌸 NAME 🌸

SoPackedColor — the SoPackedColor class is a node for setting diffuse and transparency material values. literally what it says on the tin, no cap ✨

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoPackedColor.h>

Inherits SoNode. (so like, it's part of that whole family tree, iykyk 🌳)

👑 Public Member Functions 👑

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

🌈 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)
  • 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. (the lil setup ritual, iconic)

✨ 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 🫶

  • SoMFUInt32 orderedRGBA

🔥 Protected Member Functions 🔥

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoPackedColor ()
  • virtual void notify (SoNotList *list)

🍓 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 SoPackedColor class is a node for setting diffuse and transparency material values. periodt 💅

so basically, this node is the convenient lil shortcut for setting diffuse colors and transparency values, all with packed 32-bit RGBA vectors. one field, so much power, we love an efficient queen 👑

FILE FORMAT/DEFAULTS:

PackedColor {
    orderedRGBA 0xccccccff
}

👀 See also 👀

  • SoBaseColor

🛠️ Constructor & Destructor Documentation 🛠️

🌟 SoPackedColor::SoPackedColor (void ) 🌟

Constructor. (hi bestie, welcome to the world ✨)

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

Destructor. (bye bestie, protected and virtual, very mysterious of her 🙈)

and that's where part 1 wraps, but hold on — there's more coming in part 2, so don't go anywhere 🦋✨

🌸 Member Function Documentation 🌸

okay bestie this is the part where we meet the actual functions — the little methods that make this node do its thing. every single one is here, i promise, no skips, no "etc." 💅

🦋 SoType SoPackedColor::getClassTypeId(void) — static

this one's a static method and its whole job is to hand you back the SoType object that's associated with objects of this class. like a little name tag for the whole class, not just one instance. adorable. ✨

🦋 SoType SoPackedColor::getTypeId(void) const — virtual

this one gives you the type identification for an object derived from a class that inherits SoBase. what's it for? runtime type checking and "downward" casting, that's what. 🫶

fun fact: this Implements SoBase.

🦋 const SoFieldData ** SoPackedColor::getFieldDataPtr(void) — static, protected

heads up bestie: this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. so like… iffy for us, but here it is anyway because we keep ALL the details. 🙈

it Returns the SoFieldData class which holds information about fields in this node.

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

gives you a pointer to the class-wide field data storage object for this particular instance. and if there are no fields present? it returns NULL. that's it, that's the whole vibe. 😭

Reimplemented from SoFieldContainer.

🦋 void SoPackedColor::doAction(SoAction * action) — virtual

this function performs the typical operation of a node for any action. any action, periodt. it's the generalist of the group. 👑

Reimplemented from SoNode.

🦋 void SoPackedColor::GLRender(SoGLRenderAction * action) — virtual

action method for the SoGLRenderAction.

this gets called during rendering traversals. any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. main character energy honestly. 🔥

Reimplemented from SoNode.

🦋 void SoPackedColor::callback(SoCallbackAction * action) — virtual

action method for SoCallbackAction.

it simply updates the state according to how the node behaves for the render action, so that the application programmer can use the SoCallbackAction for extracting information about the scene graph. lowkey iconic. 🌈

Reimplemented from SoNode.

🦋 SbBool SoPackedColor::isTransparent(void)

returns TRUE if there is at least one RGBA vector in the set which is not completely opaque. so like, one single see-through-ish vector and boom, it's transparent. 🌸

🦋 void SoPackedColor::notify(SoNotList * l) — protected, virtual

notifies all auditors for this instance when changes are made. it's giving "hey everyone, something changed!!" 📣

Reimplemented from SoNode.

💜 Member Data Documentation 💜

🎀 SoMFUInt32 SoPackedColor::orderedRGBA

a set of packed 32-bit RGBA vectors. let's break down the bits, bestie:

  • the most significant 24 bits specify 8 bits each for the red, green and blue components.
  • the least significant 8 bits specify the transparency value, where 0x00 means completely transparent, and 0xff completely opaque.

so that's 24 bits of colour and 8 bits of "can you see through me". math ate. ✨

🫶 Author

Generated automatically by Doxygen for Coin from the source code. (yes, a robot wrote this, and yes, it slayed.) 🤖💖

aaaand that's the whole page, bestie!! this was Coin 4.0.10, dated Thu Jun 25 2026 00:00:00, and it lives at SoPackedColor(3). go forth and pack those colours 💅🌸🦋

📦 where this page comes from