SoVRMLParent(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLParent 💖

okay bestie, you've landed on SoVRMLParent(3) from the Library Functions Manual, and yes this is the right page, welcome, come sit with me 🫶

🌸 NAME 🌸

SoVRMLParent — the SoVRMLParent node is a superclass for all VRML grouping nodes.

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLParent.h>

Inherits SoGroup.

Inherited by SoVRMLAnchor, SoVRMLBillboard, and SoVRMLGroup.

💅 Public Member Functions 💅

virtual SoType getTypeId (void) const
virtual SbBool affectsState (void) const
virtual void addChild (SoNode *child)
virtual void insertChild (SoNode *child, int idx)
virtual SoNode * getChild (int idx) const
virtual int findChild (const SoNode *child) const
virtual int getNumChildren (void) const
virtual void removeChild (int idx)
virtual void removeChild (SoNode *child)
virtual void removeAllChildren (void)
virtual void replaceChild (int idx, SoNode *child)
virtual void replaceChild (SoNode *old, SoNode *child)
virtual SoChildList * getChildren (void) const
virtual void doAction (SoAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

🎀 Public Member Functions inherited from SoGroup 🎀

SoGroup (void)
SoGroup (int nchildren)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void audioRender (SoAudioRenderAction *action)

🦋 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=0) 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)
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=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 💜

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 void updateChildList (const SoNode *const *nodes, const int
    numnodes, SoChildList &cl)
static void updateChildList (SoNode *nodewithsfnode, SoChildList &cl)

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

SoMFNode children

🫶 Protected Member Functions 🫶

virtual const SoFieldData * getFieldData (void) const
SoVRMLParent (void)
SoVRMLParent (int approxchildren)
virtual ~SoVRMLParent ()
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)

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

🫶 Protected Attributes 🫶

SoMFNode addChildren
SoMFNode removeChildren

🦋 Protected Attributes inherited from SoGroup 🦋

SoChildList * children

🌸 Protected Attributes inherited from SoNode 🌸

uint32_t uniqueId

🎀 Protected Attributes inherited from SoFieldContainer 🎀

SbBool isBuiltIn

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

Protected Types inherited from SoBase:

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

Static Protected Attributes inherited from SoNode:

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

👑 Detailed Description 👑

The SoVRMLParent node is a superclass for all VRML grouping nodes.

periodt, that's the whole vibe — it's the blueprint the other grouping nodes are built on 💅

🛠️ Constructor & Destructor Documentation 🛠️

SoVRMLParent::SoVRMLParent (void ) [protected]

Constructor.

Referenced by getChildren(), getFieldData(), and SoVRMLGroup::SoVRMLGroup().

SoVRMLParent::SoVRMLParent (int numchildren) [protected]

Destructor. numchildren is the expected number of children.

okay bestie, ngl, the docs literally call this one "Destructor" even though it's the constructor taking numchildren — I'm just telling you what the page says, I don't make the rules 🙈

References SoGroup::SoGroup().

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

Destructor.

🔥 Member Function Documentation 🔥

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used 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
  }
}

okay bestie, so if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others? 💅 this method needs to be overridden in all subclasses. no skipping, fr fr. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using 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. ✨

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. 📚

  • Reimplemented from SoGroup.
  • Reimplemented in SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, and SoVRMLTransform.

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

Hands you back a pointer to the class-wide field data storage object for this instance, bestie. If no fields are present, it returns NULL — so like, check before you go dereferencing, okay? 🙈

  • Reimplemented from SoGroup.
  • Reimplemented in SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, and SoVRMLTransform.
  • References: SoVRMLParent().

SbBool SoVRMLParent::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. honestly? iconic of it.

  • Reimplemented from SoNode.

void SoVRMLParent::addChild (SoNode * node) [virtual]

Append a child node to the list of children nodes this group node is managing. 🌸

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: children, and SoNode::SoNode().

void SoVRMLParent::insertChild (SoNode * child, int newchildindex) [virtual]

Insert a child node at position newchildindex. 📍

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: children, and SoNode::SoNode().

SoNode * SoVRMLParent::getChild (int index) const [virtual]

Returns pointer to child node at index. 🫶

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: children.

int SoVRMLParent::findChild (const SoNode * node) const [virtual]

Returns index in our list of children for child node, or -1 if node is not a child of this group node. so like, -1 means "she's not here bestie". 💀

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: children, and SoNode::SoNode().

int SoVRMLParent::getNumChildren (void ) const [virtual]

Returns number of child nodes managed by this group. headcount check, but make it scene graph. 🧚

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: children.

void SoVRMLParent::removeChild (int childindex) [virtual]

Remove node at childindex in our list of children. bye bestie 👋

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: SoGroup::children, and children.

void SoVRMLParent::removeChild (SoNode * child) [virtual]

Remove child from the set of children managed by this group node. Will decrease the reference count of child by 1. count your refs, queen 👑

This is a convenience method. It will simply call findChild() with child as argument, and then call removeChild(int) if the child is found.

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: SoGroup::children, children, and SoNode::SoNode().

void SoVRMLParent::removeAllChildren (void ) [virtual]

Do not manage the children anymore. Will dereference all children by 1 as they are removed. full clear-out, no leftovers. 🧹

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: SoGroup::children, and children.

void SoVRMLParent::replaceChild (int index, SoNode * newchild) [virtual]

Replace child at index with newChild. 🔁

Dereferences the child previously at index, and increases the reference count of newChild by 1.

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: children, and SoNode::SoNode().

void SoVRMLParent::replaceChild (SoNode * oldchild, SoNode * newchild) [virtual]

Replace oldchild with newchild. glow-up arc fr fr ✨

Dereferences oldchild by 1, and increases the reference count of newchild by 1.

This is a convenience method. It will simply call findChild() with oldchild as argument, and call replaceChild(int, SoNode*) if the child is found.

Please note that this method is not virtual in the original SGI Inventor API. 👀
  • Reimplemented from SoGroup.
  • References: children, and SoNode::SoNode().

SoChildList * SoVRMLParent::getChildren (void ) const [virtual]

Returns list of children. the whole squad, in one list. 🌈

  • Reimplemented from SoGroup.
  • References: SoGroup::children, children, SoVRMLParent(), and updateChildList().
  • Referenced by: SoVRMLGroup::getMatrix(), SoVRMLCollision::GLRender(), SoVRMLBillboard::GLRenderBelowPath(), SoVRMLGroup::GLRenderBelowPath(), SoVRMLBillboard::GLRenderInPath(), and SoVRMLGroup::GLRenderInPath().

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

This function performs the typical operation of a node for any action. the main character moment of node methods 💅

  • Reimplemented from SoGroup.
  • Reimplemented in SoVRMLBillboard, SoVRMLGroup, and SoVRMLTransform.
  • References: SoGroup::doAction().
  • Referenced by: SoVRMLGroup::audioRender(), and SoVRMLGroup::doAction().

void SoVRMLParent::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. it's giving all-or-nothing, no partial credit.

See also: SoSearchAction

  • Reimplemented from SoGroup.
  • Reimplemented in SoVRMLBillboard, and SoVRMLGroup.
  • References: SoGroup::search().

void SoVRMLParent::write (SoWriteAction * action) [virtual]

Action method for SoWriteAction. ✍️

Writes out a node object, and any connected nodes, engines etc, if necessary.

  • Reimplemented from SoGroup.
  • Reimplemented in SoVRMLGroup.
  • References: SoFieldContainer::addWriteReference(), SoWriteAction::getOutput(), SoOutput::getStage(), SoFieldData::write(), SoBase::writeFooter(), and SoBase::writeHeader().
  • Referenced by: SoVRMLGroup::write().

void SoVRMLParent::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 calculates their primitive count also overrides this method to change the relevant state variables.

  • Reimplemented from SoGroup.
  • Reimplemented in SoVRMLGroup, and SoVRMLTransform.
  • References: SoGroup::getPrimitiveCount().
  • Referenced by: SoVRMLGroup::getPrimitiveCount().

void SoVRMLParent::updateChildList (const SoNode *const * nodes, const int numnodes, SoChildList & cl) [static]

A convenience method that can be used to update cl to match the list of nodes in nodes. sync check, but for children. 🦋

  • References: SoChildList::append(), SbPList::getArrayPtr(), SbPList::getLength(), and SoNode::SoNode().
  • Referenced by: SoVRMLAppearance::getChildren(), SoVRMLGeometry::getChildren(), SoVRMLLOD::getChildren(), getChildren(), SoVRMLShape::getChildren(), SoVRMLSwitch::getChildren(), and updateChildList().

void SoVRMLParent::updateChildList (SoNode * nodewithsfnode, SoChildList & cl) [static]

A convenience method that is used to sync the nodes in cl with all nodes in SoSFNode fields in nodewithsfnode. 🎀

  • References: SbList< Type >::append(), SbList< Type >::getArrayPtr(), SoField::getClassTypeId(), SoFieldData::getField(), SoFieldContainer::getFieldData(), SbList< Type >::getLength(), SoFieldData::getNumFields(), SoField::getTypeId(), SoNode::SoNode(), and updateChildList().

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

Notifies all auditors for this instance when changes are made. 📣 telling everyone who's listening, because communication is key bestie.

  • Reimplemented from SoNode.
  • Reimplemented in SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, and SoVRMLTransform.
  • References: children, SoNotList::getLastField(), and SoFieldContainer::notify().
  • Referenced by: SoVRMLBillboard::notify(), and SoVRMLGroup::notify().

SbBool SoVRMLParent::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]

This method is mainly intended for internal use during file import operations. 🗂️

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE. corrupted input? return FALSE, do not spiral. 💀

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

  • Reimplemented from SoGroup.
  • References: children, and SoNode::readInstance().

void SoVRMLParent::copyContents (const SoFieldContainer * from, SbBool copyconnections) [protected], [virtual]

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE. 🫶

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                  SbBool copyconnections)
{
  // let parent superclasses do their thing (copy fields, copy
  // instance name, etc etc)
  SoNode::copyContents(from, copyconnections);

  // [..then copy internal data..]
}

okay so this one's the blueprint bestie 💅 — that's literally the recipe for overriding copyContents() in your own node. let the superclasses handle their own stuff first (SoNode::copyContents(from, copyconnections) does the fields, the instance name, all of it ✨), and then you copy your own internal data. order matters, don't skip the parent call, no cap 🫶

Reimplemented from SoGroup.

References addChildren, SoGroup::children, SoNode::copyContents(), removeChildren, and SoFieldContainer::SoFieldContainer().

🎀 Member Data Documentation 🎀

💖 SoMFNode SoVRMLParent::children 💖

the children nodes, fr fr. this is the whole vibe of the node — it's where all the actual content lives 🌸

Referenced by addChild(), findChild(), getChild(), getChildren(), getNumChildren(), insertChild(), notify(), readInstance(), removeAllChildren(), removeChild(), removeChild(), replaceChild(), and replaceChild().

ngl the list lowkey reads like it glitched with removeChild() and replaceChild() showing up twice each 💀 but that's exactly how it is, so we're keeping it exactly as-is 🧚

🌈 SoMFNode SoVRMLParent::addChildren [protected] 🌈

an event in that's used to add children to this node ✨ it's protected, so it's giving backstage-pass energy — internal business, not your average everyday API 👑

Referenced by copyContents().

🦋 SoMFNode SoVRMLParent::removeChildren [protected] 🦋

an event in that's used to remove children from this node 🎀 also protected, also very much an internal-machinery moment 💅

Referenced by copyContents().

👑 Author 👑

generated automatically by Doxygen for Coin from the source code 🌟 (yes the docs literally wrote themselves, we stan a self-documenting icon 💖)

aaaand that's a wrap bestie!! 🎉 this page is from Coin, Version 2.5.0, filed under SoVRMLParent(3) — go forth and parent some nodes, you absolute legend 🫶✨💜

📦 where this page comes from