SoVRMLParent(3)
💖 SoVRMLParent(3) — Library Functions Manual 🌈
okay so bestie, welcome to the manual page for SoVRMLParent 💅 this one is a whole mood because it's a superclass — like, it's the mom of all the VRML grouping nodes, and every other grouping node in the VRML family is basically its daughter. iconic honestly ✨
quick heads up: this page is LONG (we're talking 2 parts, and you're holding part 1, so don't go anywhere, part 2 is literally right there 🫶)
📛 NAME
SoVRMLParent — the SoVRMLParent node is a superclass for all VRML grouping nodes.
that's it, that's the whole vibe check, she's a mom node 👑
✨ 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=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)
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 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 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
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)
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)🧚 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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }💫 Protected Types inherited from SoBase
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }💫 Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0📖 Detailed Description
The SoVRMLParent node is a superclass for all VRML grouping nodes.
(yeah bestie, that's the whole detailed description — she's a base class, she doesn't need a whole essay, she just is 🫶 the actual gossip lives in the subclasses)
🛠️ Constructor & Destructor Documentation
🌷 SoVRMLParent::SoVRMLParent (void ) [protected]
Constructor.
🌷 SoVRMLParent::SoVRMLParent (int numchildren) [protected]
Destructor. numchildren is the expected number of children.
okay so listen 🙈 the page literally says "Destructor." right here on a constructor — I'm just the messenger, I'm not editing the original, I'm reporting it faithfully like a good bestie 💅
🌷 SoVRMLParent::~SoVRMLParent () [protected], [virtual]
Destructor.
and that's a wrap on part 1, bestie — do NOT close the tab, part 2 is coming and it's got more ✨
🌸 Member Function Documentation 🌸
✨ SoType SoVRMLParent::getTypeId (void ) const [virtual]
okay so bestie, this one hands you back the type identification of an object derived from a class inheriting SoBase. it's literally the thing that makes run-time type checking and "downward" casting work, no cap. 💅
Usage example:
void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
}so if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others — listen up 🫶 — this method needs to be overridden in all subclasses. that's just the vibe. it's 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 info on writing Coin extensions, go peek at 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]
returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it just returns NULL. iconic, minimal, we respect it. 🎀
Reimplemented from SoGroup.
Reimplemented in SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, and SoVRMLTransform.
✨ SbBool SoVRMLParent::affectsState (void ) const [virtual]
returns TRUE if the node could have any effect on the state during traversal. like, could it change things? could it be a little agent of chaos? that's the question. 💀
if it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. for example, the SoSeparator node will return FALSE, because it pushes and pops the state before and after traversal of its children. and all SoShape nodes will also return FALSE, because just pushing out geometry data to the rendering engine won't affect the actual rendering state. see? logic. we love her. ✨
the default method returns TRUE, on a "better safe than sorry" philosophy. honestly? relatable. 🙈
Reimplemented from SoNode.
✨ void SoVRMLParent::addChild (SoNode * node) [virtual]
appends a child node to the list of children nodes this group node is managing. go forth and procreate (nodes). 🌱
please note that this method is not virtual in the original SGI Inventor API.
Reimplemented from SoGroup.
✨ void SoVRMLParent::insertChild (SoNode * child, int newchildindex) [virtual]
inserts a child node at position newchildindex. 🎯
newchildindex must be <= this->getNumChildren()
please note that this method is not virtual in the original SGI Inventor API.
Reimplemented from SoGroup.
✨ SoNode * SoVRMLParent::getChild (int index) const [virtual]
returns a pointer to the child node at index. you asked, she delivers. 🫶
please note that this method is not virtual in the original SGI Inventor API.
Reimplemented from SoGroup.
✨ int SoVRMLParent::findChild (const SoNode * node) const [virtual]
returns the index in our list of children for the child node, or -1 if node is not a child of this group node. so basically, if you get a -1, she's not your mother. 😭
please note that this method is not virtual in the original SGI Inventor API.
Reimplemented from SoGroup.
✨ int SoVRMLParent::getNumChildren (void ) const [virtual]
returns the number of child nodes managed by this group. the headcount. the census. the roster. 🔥
please note that this method is not virtual in the original SGI Inventor API.
Reimplemented from SoGroup.
✨ void SoVRMLParent::removeChild (int childindex) [virtual]
removes the node at childindex in our list of children. bye bestie, you were lowkey great while it lasted. 🦋
please note that this method is not virtual in the original SGI Inventor API.
Reimplemented from SoGroup.
✨ void SoVRMLParent::removeChild (SoNode * child) [virtual]
removes child from the set of children managed by this group node. will decrease the reference count of child by 1. ⚠️ keep track of those refs, bestie, they're the whole ballgame.
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.
✨ void SoVRMLParent::removeAllChildren (void ) [virtual]
do not manage the children anymore. will dereference all children by 1 as they are removed. it's giving spring cleaning, it's giving scorched earth, it's giving slay. 🧹✨
please note that this method is not virtual in the original SGI Inventor API.
Reimplemented from SoGroup.
✨ void SoVRMLParent::replaceChild (int index, SoNode * newchild) [virtual]
replaces the child at index with newChild. 🔄
dereferences the child previously at index, and increases the reference count of newChild by 1.
index must be < this->getNumChildren()
please note that this method is not virtual in the original SGI Inventor API.
Reimplemented from SoGroup.
✨ void SoVRMLParent::replaceChild (SoNode * oldchild, SoNode * newchild) [virtual]
replaces oldchild with newchild. the glow-up arc is real. 🌈
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.
✨ SoChildList * SoVRMLParent::getChildren (void ) const [virtual]
returns the list of children. the whole friend group, in one SoChildList. 💖
Reimplemented from SoGroup.
✨ void SoVRMLParent::doAction (SoAction * action) [virtual]
this function performs the typical operation of a node for any action. it's the main character doing main character things. 👑
Reimplemented from SoGroup.
Reimplemented in SoVRMLBillboard, SoVRMLGroup, and SoVRMLTransform.
✨ 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. one wrong criterion and it's over, no partial credit. 💀
see also SoSearchAction
Reimplemented from SoGroup.
Reimplemented in SoVRMLBillboard, and SoVRMLGroup.
✨ 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.
✨ 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.
✨ 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 them up bestie, they should be matching. 🎀
✨ 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. ✨
✨ void SoVRMLParent::notify (SoNotList * l) [protected], [virtual]
notifies all auditors for this instance when changes are made. 📣 the group chat is blowing up.
Reimplemented from SoNode.
Reimplemented in SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, and SoVRMLTransform.
✨ 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. > so yeah — corrupt input? handle it, return FALSE, don't have a meltdown. 😭
flags is used internally during binary import when reading user extension nodes, group nodes or engines.
Reimplemented from SoGroup.
✨ 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..]
}fr fr — call your superclass first. skipping that step is how you get mysterious bugs and a sad bestie. 🙈
Reimplemented from SoGroup.
💜 Member Data Documentation 💜
✨ SoMFNode SoVRMLParent::children
the children nodes. that's it. that's the field. your whole little node family lives here. 🫶
✨ SoMFNode SoVRMLParent::addChildren [protected]
an event in that is used to add children to this node. ➕
✨ SoMFNode SoVRMLParent::removeChildren [protected]
an event in that is used to remove children from this node. ➖
🌟 Author 🌟
generated automatically by Doxygen for Coin from the source code. so like, a robot wrote this about a robot, and honestly? she ate. 💅✨
and that's the whole page bestie!! 🎀 this was SoVRMLParent(3), from Coin Version 3.1.3 — go forth and parent your VRML nodes responsibly, mwah 💖🦋
📦 where this page comes from
- fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
- fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
- fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
- fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms