SoPackedColor(3)

💖 SoPackedColor(3) — Library Functions Manual ✨

okay bestie, buckle up, we're doing the SoPackedColor page from the Library Functions Manual and it's a whole vibe 💅

---

🌸 NAME 🌸

SoPackedColor — the SoPackedColor class is a node for setting diffuse and transparency material values. literally its whole personality 🎀

---

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoPackedColor.h>

Inherits SoNode. (so it's got that SoNode bloodline, iconic lineage 👑)

💜 Public Member Functions 💜

• virtual SoType getTypeId (void) const — hands you back the type id, the standard little identity check 🪪
• SoPackedColor (void) — the constructor, we love a fresh new node
• virtual void doAction (SoAction *action) — does the action thing
• virtual void GLRender (SoGLRenderAction *action) — the actual render moment, main character energy 🔥
• virtual void callback (SoCallbackAction *action) — runs the callback action
• SbBool isTransparent (void) — asks the big question: is it transparent or not 🫶

💙 Public Member Functions inherited from SoNode 💙

• void setOverride (const SbBool state) — sets the override state
• SbBool isOverride (void) const — is it overriding? inquiring minds
• void setNodeType (const NodeType type) — sets the node type
• NodeType getNodeType (void) const — gets the node type back
• virtual SoNode * copy (SbBool copyconnections=0) const — copies the node
• virtual SbBool affectsState (void) const — does it mess with the state
• virtual void GLRenderBelowPath (SoGLRenderAction *action) — render below the path
• virtual void GLRenderInPath (SoGLRenderAction *action) — render in the path
• virtual void GLRenderOffPath (SoGLRenderAction *action) — render off the path
• virtual void getBoundingBox (SoGetBoundingBoxAction *action) — grabs the bounding box
• virtual void getMatrix (SoGetMatrixAction *action) — grabs the matrix
• virtual void handleEvent (SoHandleEventAction *action) — handles the event
• virtual void pick (SoPickAction *action) — the pick
• virtual void rayPick (SoRayPickAction *action) — the ray pick, fancy
• virtual void search (SoSearchAction *action) — searches
• virtual void write (SoWriteAction *action) — writes it out
• virtual void audioRender (SoAudioRenderAction *action) — audio render, yes really 🔊
• virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts the primitives
• virtual void grabEventsSetup (void) — sets up the event grabbing
• virtual void grabEventsCleanup (void) — cleans up the event grabbing
• virtual void startNotify (void) — kicks off the notify
• uint32_t getNodeId (void) const — the node's id
• virtual SoChildList * getChildren (void) const — the children list
• virtual void writeInstance (SoOutput *out) — writes the instance
• virtual SoNode * addToCopyDict (void) const — adds itself to the copy dict
• virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copies the contents
• virtual SoFieldContainer * copyThroughConnection (void) const — copies through the connection

💚 Public Member Functions inherited from SoFieldContainer 💚

• void setToDefaults (void) — back to defaults, reset era
• SbBool hasDefaultValues (void) const — does it have default values
• SbBool fieldsAreEqual (const SoFieldContainer *container) const — are the fields equal
• void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0) — copies the field values over
• SbBool set (const char *const fielddata) — sets from field data
• void get (SbString &fielddata) — gets the field data out
• virtual int getFields (SoFieldList &l) const — gets the fields
• virtual int getAllFields (SoFieldList &l) const — gets all the fields, no crumbs left
• virtual SoField * getField (const SbName &name) const — gets one field by name
• virtual SoField * getEventIn (const SbName &name) const — gets an event in
• virtual SoField * getEventOut (const SbName &name) const — gets an event out
• SbBool getFieldName (const SoField *const field, SbName &name) const — gets a field's name
• SbBool enableNotify (const SbBool flag) — toggles notify
• SbBool isNotifyEnabled (void) const — is notify enabled
• SbBool set (const char *fielddata, SoInput *in) — sets from fielddata and input
• void get (SbString &fielddata, SoOutput *out) — gets into fielddata via output
• virtual SbBool validateNewFieldValue (SoField *field, void *newval) — checks a new field value
• virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0) — adds a write reference
• SbBool getIsBuiltIn (void) const — is it built in
• void setUserData (void *userdata) const — sets your user data
• void * getUserData (void) const — gets your user data back

💛 Public Member Functions inherited from SoBase 💛

• void ref (void) const — refs it up, keep it alive
• void unref (void) const — unrefs it
• void unrefNoDelete (void) const — unrefs but no delete
• int32_t getRefCount (void) const — the ref count
• void touch (void) — touches it, wake up bestie
• SbBool isOfType (SoType type) const — is it this type
• virtual SbName getName (void) const — its name
• virtual void setName (const SbName &newname) — renames it
• void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor
• void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes an auditor
• const SoAuditorList & getAuditors (void) const — gets the auditors list
• SbBool shouldWrite (void) — should it write
• void assertAlive (void) const — asserts it's alive, dramatic but fair 💀

🧚 Static Public Member Functions 🧚

• static SoType getClassTypeId (void) — the class type id
• static void initClass (void) — initializes the class, the classic ritual ✨

🌈 Static Public Member Functions inherited from SoNode 🌈

• static uint32_t getCompatibilityTypes (const SoType &nodetype) — gets compatibility types
• static SoType getClassTypeId (void) — class type id
• static SoNode * getByName (const SbName &name) — grabs a node by name
• static int getByName (const SbName &name, SoNodeList &l) — grabs nodes by name into a list
• static void initClass (void) — init the class
• static void initClasses (void) — init all the classes
• static uint32_t getNextNodeId (void) — the next node id
• static int getActionMethodIndex (const SoType type) — the action method index
• static void getBoundingBoxS (SoAction *action, SoNode *node) — static bounding box
• static void GLRenderS (SoAction *action, SoNode *node) — static GL render
• static void callbackS (SoAction *action, SoNode *node) — static callback
• static void getMatrixS (SoAction *action, SoNode *node) — static get matrix
• static void handleEventS (SoAction *action, SoNode *node) — static handle event
• static void pickS (SoAction *action, SoNode *node) — static pick
• static void rayPickS (SoAction *action, SoNode *node) — static ray pick
• static void searchS (SoAction *action, SoNode *node) — static search
• static void writeS (SoAction *action, SoNode *node) — static write
• static void audioRenderS (SoAction *action, SoNode *node) — static audio render
• static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive count

🦋 Static Public Member Functions inherited from SoFieldContainer 🦋

• static void initClass (void) — init the class
• static SoType getClassTypeId (void) — class type id
• static void initCopyDict (void) — inits the copy dict
• static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — adds a copy
• static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks a copy
• static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds a copy
• static void copyDone (void) — copying's done, we love closure

⭐ Static Public Member Functions inherited from SoBase ⭐

• static void initClass (void) — init the class
• static SoType getClassTypeId (void) — class type id
• static void addName (SoBase *const base, const char *const name) — adds a name
• static void removeName (SoBase *const base, const char *const name) — removes a name
• static void incrementCurrentWriteCounter (void) — bumps the current write counter up
• static void decrementCurrentWriteCounter (void) — bumps it back down
• static SoBase * getNamedBase (const SbName &name, SoType type) — gets a named base
• static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — gets named bases into a list
• static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads
• static void setInstancePrefix (const SbString &c) — sets the instance prefix
• static void setTraceRefs (SbBool trace) — toggles trace refs
• static SbBool getTraceRefs (void) — gets trace refs
• static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects a route
• static SbBool readRoute (SoInput *in) — reads a route

🍓 Public Attributes 🍓

• SoMFUInt32 orderedRGBA — the field itself, the moment, the star of the show 💖

🧸 Protected Member Functions 🧸

• virtual const SoFieldData * getFieldData (void) const — gets the field data
• virtual ~SoPackedColor () — the destructor, we don't talk about her 💀
• virtual void notify (SoNotList *list) — notifies

💜 Protected Member Functions inherited from SoNode 💜

• SoNode (void) — constructor
• virtual ~SoNode () — destructor
• virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads the instance

🎀 Protected Member Functions inherited from SoFieldContainer 🎀

• SoFieldContainer (void) — constructor
• ~SoFieldContainer () — destructor

🫧 Protected Member Functions inherited from SoBase 🫧

• SoBase (void) — constructor
• virtual ~SoBase () — destructor
• virtual void destroy (void) — destroys it
• SbBool hasMultipleWriteRefs (void) const — does it have multiple write refs
• SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header
• void writeFooter (SoOutput *out) const — writes the footer
• virtual const char * getFileFormatName (void) const — gets the file format name

🌸 Static Protected Member Functions 🌸

• static const SoFieldData ** getFieldDataPtr (void) — the field data pointer, get it

💫 Static Protected Member Functions inherited from SoNode 💫

• static const SoFieldData ** getFieldDataPtr (void) — field data pointer
• static void setNextActionMethodIndex (int index) — sets the next action method index
• static int getNextActionMethodIndex (void) — gets the next action method index
• static void incNextActionMethodIndex (void) — increments the next action method index
• static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types

🌟 Static Protected Member Functions inherited from SoBase 🌟

• static uint32_t getCurrentWriteCounter (void) — gets the current write counter
• static void staticDataLock (void) — locks the static data
• static void staticDataUnlock (void) — unlocks the static data

👑 Additional Inherited Members 👑

🌈 Public Types inherited from SoNode 🌈

enum NodeType — the whole roster, look at the lineup:

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
}

🦋 Protected Types inherited from SoBase 🦋

• enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the flags, short and sweet

🧚 Protected Attributes inherited from SoNode 🧚

• uint32_t uniqueId — its very own unique id, no duplicates allowed

💚 Protected Attributes inherited from SoFieldContainer 💚

• SbBool isBuiltIn — is it built in or not

⭐ Static Protected Attributes inherited from SoNode ⭐

• static uint32_t nextUniqueId = 0 — the next unique id, starting at 0
• static int nextActionMethodIndex = 0 — the next action method index, also starting at 0

---

🔥 Detailed Description 🔥

okay so the SoPackedColor class is a node for setting diffuse and transparency material values. that's the whole thing, that's her job 🎀

This node gives you a convenient way of setting diffuse colors and transparency values with packed 32-bit RGBA vectors. convenient, bestie. we love convenient ✨

🎀 FILE FORMAT/DEFAULTS: 🎀

PackedColor {
    orderedRGBA 0xccccccff
}

👀 See also 👀

• SoBaseColor

---

💅 Constructor & Destructor Documentation 💅

🌸 SoPackedColor::SoPackedColor (void ) 🌸

Constructor. it's giving new beginnings, fresh node, no baggage ✨

References orderedRGBA, and SoPackedColor().

Referenced by getFieldData(), and SoPackedColor().

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

Destructor. she's leaving the group chat, protected and virtual about it 😭

🫶 Member Function Documentation 🫶

okay bestie, this is the part where we meet the actual methods. they're iconic, they're useful, and yes we're going through every single one 💅

💖 SoType SoPackedColor::getTypeId (void ) const [virtual] 💖

this is the vibe check for object types, fr. it returns the type identification of an object derived from a class inheriting SoBase. it's what you use for run-time type checking and "downward" casting.

Usage example:

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

for the application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever: you need to override this method in all subclasses. typically you do it while setting up the full type system for extension classes, and that's usually done with the pre-defined macros from, for example, 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.

wanna know more about writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. ✨

Implements SoBase.

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

returns a pointer to the class-wide field data storage object for this instance. if there are no fields present, it returns NULL. that's it, that's the tea 🍵

Reimplemented from SoFieldContainer.

References SoPackedColor().

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

this function performs the typical operation of a node for any action. it's the main character of action handling, no cap.

Reimplemented from SoNode.

References SoOverrideElement::getDiffuseColorOverride(), SoAction::getState(), SoState::isElementEnabled(), SoNode::isOverride(), isTransparent(), orderedRGBA, SoOverrideElement::setDiffuseColorOverride(), SoBase::staticDataLock(), and SoBase::staticDataUnlock().

Referenced by callback(), and GLRender().

✨ 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 who wants to throw geometry primitives at OpenGL, overrides this method. slay 💅

Reimplemented from SoNode.

References doAction().

🌸 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 the application programmer can use the SoCallbackAction for extracting information about the scene graph. lowkey useful, highkey iconic.

Reimplemented from SoNode.

References doAction().

🦋 SbBool SoPackedColor::isTransparent (void ) 🦋

returns TRUE if there is at least one RGBA vector in the set which is not completely opaque. so if even one little vector is see-through-ish, this says yes bestie.

References orderedRGBA.

Referenced by doAction().

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

notifies all auditors for this instance when changes are made. it's the group chat ping for scene graph updates, fr fr.

Reimplemented from SoNode.

References SoNotList::getLastField(), SoNode::notify(), and orderedRGBA.

👑 Member Data Documentation 👑

💎 SoMFUInt32 SoPackedColor::orderedRGBA 💎

set of packed 32-bit RGBA vectors.

the most significant 24 bits specifies 8 bits each for the red, green and blue components.

the least significant 8 bits specifies the transparency value, where 0x00 means completely transparent, and 0xff completely opaque. so 0xff is the full-glam opaque era, and 0x00 is the invisible ghost vibe 👻

Referenced by doAction(), isTransparent(), notify(), and SoPackedColor().

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code.

---

💖 that's the whole page, bestie! it's from Coin, Version 2.5.0, and it's SoPackedColor(3). the footer didn't have a date on it, so no date to spill — just the source/version vibe. periodt. 💅✨