SoPathSwitch(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoPathSwitch 💖

okay so bestie, we are deep in the Library Functions Manual and today's main character is SoPathSwitch(3) 🎀

NAME energy, real quick: SoPathSwitch is the class that traverses only when current path matches a configurable path. that's it, that's the whole flex. no cap. ✨

🌈 SYNOPSIS 🌈

first things first, you gotta pull it in:

#include <Inventor/nodes/SoPathSwitch.h>

and jsyk, it Inherits SoGroup. so all that SoGroup DNA is running through its veins, plus the family tree above it. 👑

🫶 Public Member Functions 🫶

these are the ones SoPathSwitch claims as its own:

virtual SoType getTypeId (void) const
SoPathSwitch (void)
SoPathSwitch (int numchildren)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void pick (SoPickAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void search (SoSearchAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void audioRender (SoAudioRenderAction *action)

🌸 Public Member Functions inherited from SoGroup 🌸

the inherited girlies, straight from SoGroup:

SoGroup (void)
SoGroup (int nchildren)
virtual void addChild (SoNode *node)
virtual void insertChild (SoNode *child, int newchildindex)
virtual SoNode * getChild (int index) const
virtual int findChild (const SoNode *node) const
virtual int getNumChildren (void) const
virtual void removeChild (int childindex)
virtual void removeChild (SoNode *child)
virtual void removeAllChildren (void)
virtual void replaceChild (int index, SoNode *newchild)
virtual void replaceChild (SoNode *oldchild, SoNode *newchild)
virtual void callback (SoCallbackAction *action)
virtual void write (SoWriteAction *action)
virtual SoChildList * getChildren (void) const

🦋 Public Member Functions inherited from SoNode 🦋

and the SoNode side of the family:

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=0) const
virtual SbBool affectsState (void) const
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual SoFieldContainer * copyThroughConnection (void) const

✨ Public Member Functions inherited from SoFieldContainer ✨

the SoFieldContainer lineup:

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
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 *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const

💜 Public Member Functions inherited from SoBase 💜

and finally the SoBase origin story:

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

🎀 Static Public Member Functions 🎀

the static girlies that belong to SoPathSwitch itself:

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

Static Public Member Functions inherited from SoGroup

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)
static void initClasses (void)
static uint32_t 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)
static SoType getClassTypeId (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)
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 *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *in)

⭐ Public Attributes ⭐

one (1) public attribute and she's iconic:

SoSFPath path

🧚 Protected Member Functions 🧚

protected = keep your hands off unless you're a subclass, bestie:

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

Protected Member Functions inherited from SoGroup

virtual ~SoGroup ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual SbBool readChildren (SoInput *in)
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)

Protected Member Functions inherited from SoNode

SoNode (void)
virtual ~SoNode ()

Protected Member Functions inherited from SoFieldContainer

SoFieldContainer (void)
~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

🔥 Static Protected Member Functions 🔥

static const SoFieldData ** getFieldDataPtr (void)

Static Protected Member Functions inherited from SoGroup

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 extras that come along for the ride:

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 }

Protected Types inherited from SoBase

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

Protected Attributes inherited from SoGroup

SoChildList * children

Protected Attributes inherited from SoNode

uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

🌟 Detailed Description 🌟

okay so here's the tea, plain and simple: the SoPathSwitch class traverses only when current path matches a configurable path. like a bouncer at the club — if your path isn't on the list, you're not getting in, and none of the children below get traversed. 💀

FILE FORMAT/DEFAULTS:

PathSwitch {
    path NULL
}

see that path NULL? that's the default, bestie. out of the box, the path is NULL. 🙈

🎀 Constructor & Destructor Documentation 🎀

💖 SoPathSwitch::SoPathSwitch (void ) 💖

Default constructor. just a lil guy, freshly made, no args. ✨

Referenced by getFieldData().

🌸 SoPathSwitch::SoPathSwitch (int numchildren) 🌸

Constructor. now this one takes an argument.

The argument should be the approximate number of children which is expected to be inserted below this node. The number need not be exact, as it is only used as a hint for better memory resource allocation. so like, it's a vibe check number, not a contract — it's just helping memory do its little optimization thing. 🧚

💜 SoPathSwitch::~SoPathSwitch () [protected], [virtual] 💜

Destructor. she's protected, she's virtual, she's saying goodbye. 😭

✨ Member Function Documentation ✨

💫 SoType SoPathSwitch::getTypeId (void ) const [virtual]

okay bestie, this one is THE vibe check for types 💅 It hands you back the type identification of any object derived from SoBase, which is literally how run-time type checking works and how "downward" casting gets done safely.

Usage example, look at it, it's giving:

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 all my application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. No skipping it, fr fr. That's typically done as part of setting up the full type system for extension classes, which usually happens by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

Want the whole tea on writing Coin extensions? See the class documentation of the toplevel superclasses for the various class groups. 📚

Reimplemented from SoGroup.

🌟 const SoFieldData * SoPathSwitch::getFieldData (void ) const [protected], [virtual]

This one returns a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. Simple as. 🫶

Reimplemented from SoGroup.

References SoPathSwitch().

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

This function performs the typical operation of a node for any action. It's the main character of node behavior, honestly.

Reimplemented from SoGroup.

References SoGroup::doAction(), and SoAction::getCurPath().

Referenced by search().

🌈 void SoPathSwitch::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.

Reimplemented from SoGroup.

References SoAction::getCurPath(), and SoGroup::GLRender().

🎀 void SoPathSwitch::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does the common processing for SoPickAction action instances.

Reimplemented from SoGroup.

References SoAction::getCurPath(), and SoGroup::pick().

🦋 void SoPathSwitch::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for the node, and modifies the values of the action so it encompasses the bounding box for this node, and shifts the center point for the scene more towards the one for this node. 📦

Nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoGroup.

References SoGroup::getBoundingBox(), and SoAction::getCurPath().

💜 void SoPathSwitch::handleEvent (SoHandleEventAction * action) [virtual]

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it's something which this node should react to. iykyk 👀

Nodes influencing relevant state variables for how event handling is done also override this method.

Reimplemented from SoGroup.

References SoAction::getCurPath(), and SoGroup::handleEvent().

🌸 void SoPathSwitch::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoGroup.

References SoAction::getCurPath(), and SoGroup::getMatrix().

⭐ void SoPathSwitch::search (SoSearchAction * action) [virtual]

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction — if any of the requested criteria is a miss, the search is not deemed successful for the node. no cap 💀

See also: SoSearchAction

Reimplemented from SoGroup.

References doAction(), SoSearchAction::isFound(), SoSearchAction::isSearchingAll(), SoGroup::search(), and SoNode::search().

👑 void SoPathSwitch::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Counting, but make it iconic 🔢

Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoGroup.

References SoAction::getCurPath(), and SoGroup::getPrimitiveCount().

🧚 void SoPathSwitch::audioRender (SoAudioRenderAction * action) [virtual]

Action method for SoAudioRenderAction.

Does the common processing for SoAudioRenderAction action instances. 🔊

Reimplemented from SoGroup.

References SoGroup::audioRender(), and SoAction::getCurPath().

🎀 Member Data Documentation 🎀

💖 SoSFPath SoPathSwitch::path

The path that must match the current action path.

  • A NULL path will never match.
  • An empty path will always match.
  • The path should go up to (not including) the SoPathSwitch node, but it need not go all the way back to the root node.
bestie pls internalize this one, the matching rules are literally the whole point of the node 💅

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap on the SoPathSwitch(3) page, pookie 🫶 this lil doc was brought to you by Coin, Version 2.5.0 — slay, go forth and path-switch responsibly ✨💅

📦 where this page comes from