SoPathSwitch(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoPathSwitch 💖

okay bestie, gather round, because we're doing the SoPathSwitch(3) page from the Library Functions Manual and honestly? she's iconic. lowkey the whole point of her is: she only walks her children when the current path matches a path you get to configure. that's it. that's the vibe. 💅

✨ NAME ✨

SoPathSwitch — the SoPathSwitch class traverses only when current path matches a configurable path. periodt. 🦋

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoPathSwitch.h>

Inherits SoGroup.

👑 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

the whole family tree is showing up, and honestly she's serving inherited genes 💅

  • 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

🌈 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 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

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

🌟 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 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)
  • 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 *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

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

🔒 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

the enum girlies, all of them, no crumbs left behind 🍓

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 }

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 = 1
  • static int nextActionMethodIndex = 0

📖 Detailed Description 📖

okay so, deep breath, here's the whole entire deal:

The SoPathSwitch class traverses only when current path matches a configurable path. no cap. 🫶

FILE FORMAT/DEFAULTS:

PathSwitch {
    path NULL
}

🛠️ Constructor & Destructor Documentation 🛠️

SoPathSwitch::SoPathSwitch (void )

Default constructor. the little baby default, she's fresh out the box ✨

SoPathSwitch::SoPathSwitch (int numchildren)

Constructor. 👑

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. iykyk — it's a hint, not a promise, so don't stress about getting it pixel-perfect 💅

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

Destructor. say bye bestie 👋

🌟 MEMBER FUNCTION DOCUMENTATION 🌟

okay bestie, this is the part where we meet all the little methods that make SoPathSwitch do its thing. they're all inherited-ish overrides, they all say "Reimplemented from SoGroup" at the end like a lil signature, and yes we're covering every single one. no skipping. 💖

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

gives you back the type identification for any object derived from SoBase. it's the whole reason run-time type checking and "downward" casting even work. very demure, very runtime.

usage example, look at it, learn it, love it:

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

now for the app devs out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — listen up — you need to override this method in all your subclasses. that's typically part of setting up the full type system for extension classes, and it's usually done with the pre-defined macros available through, for instance, 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. iykyk.

want more tea on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. 👑

Reimplemented from SoGroup.

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

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

Reimplemented from SoGroup.

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

this one performs the typical operation of a node for any action. like, the standard move. the default choreography. 💅

Reimplemented from SoGroup.

🌈 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. go off, geometry.

Reimplemented from SoGroup.

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

action method for SoPickAction.

does the common processing for SoPickAction action instances. nothing dramatic, just doing its job fr fr.

Reimplemented from SoGroup.

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

action method for the SoGetBoundingBoxAction.

it calculates the bounding box and center coordinates for the node, then 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. math but make it cute ✨

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

Reimplemented from SoGroup.

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

action method for SoHandleEventAction.

it inspects the event data from action, and processes it if it's something this node should react to. main character energy only for the events that matter 😌

nodes that influence relevant state variables for how event handling is done also override this method.

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). if there's no matrix, well, nothing to accumulate, bestie.

Reimplemented from SoGroup.

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

action method for SoSearchAction.

it 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. all or nothing, no partial credit, periodt. 💀

See also: SoSearchAction

Reimplemented from SoGroup.

⭐ void SoPathSwitch::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. sneaky lil info grab 🙈

Reimplemented from SoGroup.

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

action method for the SoGetPrimitiveCountAction.

it calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. count 'em up 🔢

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

Reimplemented from SoGroup.

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

action method for SoAudioRenderAction.

does the 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. never ever 🚫
  • an empty path will always match. always always ✅

the path should go up to (not including) the SoPathSwitch node, but it need not go all the way back to the root node. so like, it can be a lil partial journey. not everything has to start at the root, bestie 💅

✍️ AUTHOR ✍️

Generated automatically by Doxygen for Coin from the source code. so not a human author, just the robot doing its lil documentation dance. 🤖✨

that's the whole page, bestie!! this was Coin Version 3.1.3, page SoPathSwitch(3) — thanks for reading all the way through, you ate that up and left no crumbs 🎀💖🦋

📦 where this page comes from