SoVRMLSwitch(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

✨ NAME ✨

okay so bestie, welcome to SoVRMLSwitch(3) 💅 this is the Coin manpage for the SoVRMLSwitch class, and honestly? she's giving group-node realness.

SoVRMLSwitch is a group node — and the whole vibe is that it traverses selected children. that's it, that's the energy. she holds a bunch of children and she picks which ones get traversed. not all of them. selected ones. the way that she curates 😌

tl;dr bestie: it's a group node, and it's about traversing the children you selected. no cap 🫶 more deets coming in the next parts, stay with me 🌸

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLSwitch.h>

Inherits SoGroup.

okay bestie, part 2 is here and we're diving straight into the whole member-function extended family. 💖 no cap, it's a lot.

💅 Public Member Functions 💅

virtual SoType getTypeId (void) const
SoVRMLSwitch (void)
SoVRMLSwitch (int choices)
virtual SbBool affectsState (void) const
void addChoice (SoNode *choice)
void insertChoice (SoNode *choice, int idx)
SoNode * getChoice (int idx) const
int findChoice (SoNode *choice) const
int getNumChoices (void) const
void removeChoice (int idx)
void removeChoice (SoNode *node)
void removeAllChoices (void)
void replaceChoice (int idx, SoNode *choice)
void replaceChoice (SoNode *old, SoNode *choice)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *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 write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
void addChild (SoNode *child)
void insertChild (SoNode *child, int idx)
SoNode * getChild (int idx) const
int findChild (const SoNode *child) const
int getNumChildren (void) const
void removeChild (int idx)
void removeChild (SoNode *child)
void removeAllChildren (void)
void replaceChild (int idx, SoNode *node)
void replaceChild (SoNode *old, SoNode *node)
virtual SoChildList * getChildren (void) const

🦋 Public Member Functions inherited from SoGroup 🦋

these are the ones she got from her SoGroup mama:

SoGroup (void)
SoGroup (int nchildren)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

🌸 Public Member Functions inherited from SoNode 🌸

and these came straight from SoNode, periodt:

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

SoFieldContainer said "here, take these too":

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 SoBase is the great-grandma of them all:

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 this object's type is either the same as 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)

🌈 Static Public Member Functions inherited from SoGroup 🌈

static SoType getClassTypeId (void)
static void initClass (void) — sets up the initialization for data shared by all instances of this class, like sending the necessary info 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 the initialization for data shared by all instances of this class, like sending the necessary info 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 the initialization for data shared by all instances of this class, like sending the necessary info to the Coin type system.
static SoType getClassTypeId (void) — this static method hands you the SoType object that goes 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 the initialization for data shared by all instances of this class, like sending the necessary info to the Coin type system.
static SoType getClassTypeId (void) — this static method hands you the SoType object that goes 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 🍓

SoMFNode choice
SoSFInt32 whichChoice

🔒 Protected Member Functions 🔒

virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLSwitch (void)
virtual void notify (SoNotList *list)
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

🔐 Protected Member Functions inherited from SoGroup 🔐

virtual ~SoGroup ()
virtual SbBool readChildren (SoInput *in)
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 🌟

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

💖 DETAILED DESCRIPTION 💖

Okay bestie, gather round, because this is the part where it gets good. 🌈

The SoVRMLSwitch class is a group node for traversing selected children. That's the whole vibe. It's a group that looks at all its children and goes "okay, I'm gonna walk into, like, one of you" (or zero, no pressure). ✨

Fr fr, the detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium. We did not write this, we are simply hosting it, iconic of them to let us. 💅

Here's the whole structure, exactly as the standard lays it out:

Switch {
  exposedField    MFNode  choice      []
  exposedField    SFInt32 whichChoice -1    # [-1, inf)
}

The Switch grouping node traverses zero or one of the nodes specified in the choice field. And if you want the full lore on which node types are even legal to put in choice, section 4.6.5, Grouping and children nodes (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.5), describes all of it in detail. Go read it, it's giving encyclopedia but make it 3D. 🦋

The whichChoice field specifies the index of the child to traverse, and the first child has index 0 (zero-indexed, as the universe intended). If whichChoice is less than zero or greater than the number of nodes in the choice field, then nothing is chosen. No child, no traversal, we simply ✨ don't ✨. 😌

But here's the sneaky part — and this is important, no cap — all nodes under a Switch continue to receive and send events regardless of the value of whichChoice. So, like, even if a child isn't being traversed, it's still out here living its best event-driven life. For example, if an active SoVRMLTimeSensor is contained within an inactive choice of a Switch, the SoVRMLTimeSensor sends events regardless of the Switch's state. The Switch's mood does not affect it. It's independent. It's main character energy. 👑

🎀 Constructor & Destructor Documentation 🎀

`SoVRMLSwitch::SoVRMLSwitch (void )`

Constructor. That's it, that's the whole thing. Fresh Switch, no thoughts, empty choice. 💭

`SoVRMLSwitch::SoVRMLSwitch (int choices)`

Constructor. Here choices is the expected number of children. So if you already know how many little ones you're gonna have, you can tell it up front. Efficient. We love a prepared queen. 🌸

`SoVRMLSwitch::~SoVRMLSwitch (void ) [protected], [virtual]`

Destructor. She's protected and she's virtual, so she knows how to clean up after herself and any subclasses that come through. RIP to a real one. 😭🫶

💖 Member Function Documentation 💖

✨ Static Type Stuff ✨

SoType SoVRMLSwitch::getClassTypeId(void) [static] — okay so this static cutie returns the SoType object that's associated with objects of this class. type identification realness 💅
SoType SoVRMLSwitch::getTypeId(void) const [virtual] — returns the type identification of an object derived from a class inheriting SoBase. it's giving runtime type checking and "downward" casting energy fr fr.

Reimplemented from SoGroup.

const SoFieldData **SoVRMLSwitch::getFieldDataPtr(void) [static], [protected] — bestie this one is internal to the library, it's not likely to be of interest to the application programmer, no cap. returns the SoFieldData class which holds info about fields in this node.
const SoFieldData *SoVRMLSwitch::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. iconic behavior honestly.

Reimplemented from SoGroup.

void SoVRMLSwitch::initClass(void) [static] — sets up the class, that's the whole vibe 🌸

🔥 The Choice Management Era 🔥

SbBool SoVRMLSwitch::affectsState(void) const [virtual] — returns TRUE if the node could have any effect on the state during traversal. if it returns FALSE, no data in the traversal state will change from the pre-traversal state to the post-traversal state. the SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. all SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state. the default method returns TRUE, on a "better safe than sorry" philosophy. periodt.

Reimplemented from SoNode.

void SoVRMLSwitch::addChoice(SoNode * choiceptr) — adds choice to the choice field. simple as that ✨
void SoVRMLSwitch::insertChoice(SoNode * choiceptr, int idx) — inserts choice at index idx. we love a good insert 🎀
SoNode * SoVRMLSwitch::getChoice(int idx) const — returns the choice at index idx. hand it over 💅
int SoVRMLSwitch::findChoice(SoNode * choiceptr) const — finds the index for choice, or -1 if it's not found. the way it just says nope with a negative number, lowkey iconic.
int SoVRMLSwitch::getNumChoices(void) const — returns the number of choices. math girlies rise up 🔥
void SoVRMLSwitch::removeChoice(int idx) — removes the choice at index idx. bye bestie 👋
void SoVRMLSwitch::removeChoice(SoNode * choiceptr) — if choice is found, remove it. ghosting but make it API 💀
void SoVRMLSwitch::removeAllChoices(void) — removes all choices. full clear, no survivors, we love a reset 🧚
void SoVRMLSwitch::replaceChoice(int idx, SoNode * choiceptr) — replace the choice at index idx with choice. out with the old, in with the new ✨
void SoVRMLSwitch::replaceChoice(SoNode * old, SoNode * choiceptr) — find old, and replace it with choice. glow up moment fr fr.

🌈 Action Methods (the main character energy section) 🌈

void SoVRMLSwitch::doAction(SoAction * action) [virtual] — this function performs the typical operation of a node for any action. the generalist, the multitasker, the moment.

Reimplemented from SoGroup.

void SoVRMLSwitch::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. iykyk.

Reimplemented from SoGroup.

void SoVRMLSwitch::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. throwing geometry at OpenGL is such a mood honestly 💅

Reimplemented from SoGroup.

void SoVRMLSwitch::pick(SoPickAction * action) [virtual] — action method for SoPickAction. does common processing for SoPickAction action instances. the common processing queen 👑

Reimplemented from SoGroup.

void SoVRMLSwitch::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. geometry math girlies, this one's for you 📐

Reimplemented from SoGroup.

void SoVRMLSwitch::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. the way it reacts to events like a main character 😭

Reimplemented from SoGroup.

void SoVRMLSwitch::getMatrix(SoGetMatrixAction * action) [virtual] — action method for SoGetMatrixAction. updates action by accumulating with the transformation matrix of this node (if any). matrix math, we stay slaying ✨

Reimplemented from SoGroup.

void SoVRMLSwitch::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. all or nothing bestie, that's the rule fr fr.

See also: SoSearchAction

Reimplemented from SoGroup.

void SoVRMLSwitch::write(SoWriteAction * action) [virtual] — action method for SoWriteAction. writes out a node object, and any connected nodes, engines etc, if necessary. putting it all out there, no holding back 💖

Reimplemented from SoGroup.

void SoVRMLSwitch::audioRender(SoAudioRenderAction * action) [virtual] — action method for SoAudioRenderAction. does common processing for SoAudioRenderAction action instances. sound on, bestie 🔊

Reimplemented from SoGroup.