SoPathSwitch(3)

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

🌸 NAME 🌸

Ok so first things first bestie, this is the manual page for SoPathSwitch(3), and it lives in the Coin library. 💖

SoPathSwitch — the SoPathSwitch class traverses only when the current path matches a configurable path. That's the whole personality. Traverse? Only if the path matches. No match, no traversal. Periodt. 💅✨

🦋 SYNOPSIS 🦋

Like, the actual include situation:

#include <Inventor/nodes/SoPathSwitch.h>

It Inherits SoGroup. (Yes, so it's a group node, which means it comes with a whole entire family tree of inherited stuff. Buckle up. 🎀)

✨ Public Member Functions ✨

  • 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 callback (SoCallbackAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)

💜 Public Member Functions inherited from SoGroup 💜

These are the ones it gets handed down from SoGroup, no cap:

  • 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 write (SoWriteAction *action)
  • virtual SoChildList * getChildren (void) const
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

🌈 Public Member Functions inherited from SoNode 🌈

The SoNode hand-me-downs, iconic behavior honestly:

  • 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 rayPick (SoRayPickAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • SbUniqueId 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 field-container inheritance, it's giving very "my parent's whole résumé":

  • 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)
  • 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 💫

And here's the SoBase inheritance, the OG great-grandparent:

  • 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. (iykyk 💅)
  • 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 SoGroup ⭐

  • 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 🍓

Just the one, and it's THE one — the whole reason this node exists:

  • SoSFPath path

💅 Protected Member Functions 💅

  • 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)
  • virtual SoNotRec createNotRec (void)
  • void setOperation (const SoNotRec::OperationType opType=SoNotRec::UNSPECIFIED, const SoNode *cc=NULL, const SoNode *pc=NULL, const int ci=-1)

🌈 Protected Member Functions inherited from SoNode 🌈

  • SoNode (void)
  • virtual ~SoNode ()

🧚 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

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

👑 Public Types inherited from SoNode 👑

Like, a whole enum of node-type flags, bestie:

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 SoGroup 🌸

  • SoChildList * children

🎀 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

Ok that's the whole inheritance dump for part 1 — and bestie, we're not done yet, there's more coming in part 2. 👀💖

✨ Detailed Description ✨

Okay bestie, so here's the tea ☕ — the SoPathSwitch class? It's literally the bouncer of the scene graph. It only lets traversal happen when the current path matches a configurable path. No match, no entry. Periodt. 💅

🗂 FILE FORMAT/DEFAULTS 🗂

PathSwitch {
    path NULL
}

That's the whole vibe. path defaults to NULL. Keep reading for the deets. 🦋

🎀 Constructor & Destructor Documentation 🎀

SoPathSwitch::SoPathSwitch (void )

Default constructor. The classic no-args situation. ✨

SoPathSwitch::SoPathSwitch (int numchildren)

Constructor, but make it custom. 👑

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, don't stress about getting it perfect, it's just a hint. 🫶

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

Destructor. It cleans up after itself. Bye bestie! 👋😭

💖 Member Function Documentation 💖

SoType SoPathSwitch::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. It's giving type identity realness. 🔥

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. So when you need to know what something actually is, this is your girl. 💁‍♀️

Reimplemented from SoGroup.

const SoFieldData ** SoPathSwitch::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.

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

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

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoGroup.

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

This function performs the typical operation of a node for any action. It's the main character of action methods. ✨

Reimplemented from SoGroup.

void SoPathSwitch::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method. So if you're about that OpenGL life, you know what to do. 🎨

Reimplemented from SoGroup.

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances. Picking? We love a good pick me. 💅

Reimplemented from SoGroup.

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

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift 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. It's all about that box. 📦

Reimplemented from SoGroup.

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

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

Nodes influencing relevant state variables for how event handling is done also override this method. So like, if it's not your vibe, you don't have to handle it. 🙈

Reimplemented from SoGroup.

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

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any). Matrix math? In this economy? Yes bestie, it's happening. 🔢

Reimplemented from SoGroup.

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.

See also: SoSearchAction

Reimplemented from SoGroup.

void SoPathSwitch::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. It's like a little info dump, but make it callback. 📞

Reimplemented from SoGroup.

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.

Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables. Counting primitives? We love a math girlie. 🔺

Reimplemented from SoGroup.

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

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances. Sound on! 🔊

Reimplemented from SoGroup.

🌈 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 need not go all the way back to the root node.

So basically: no path? No match. Empty path? Match everything. And it doesn't have to reach all the way to the root — just up to (but not including) this SoPathSwitch. It's giving flexible. 💖

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. So like, the robots did this one, but make it cute. 🤖✨

And that's the whole page, bestie! This was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoPathSwitch(3) man page. Stay slaying, and remember: path matching is a lifestyle. 💅🦋🌟

📦 where this page comes from