SoVRMLGroup(3)
๐ SoVRMLGroup(3) ๐
okay bestie, gather round ๐ซถ this is the manual page for SoVRMLGroup, and it's giving main character VRML parent node energy. It groups VRML nodes, and because this page is a whole saga, part 1 is all about the class guts and the inherited member lists. We are keeping every single signature, enum, attribute, and inherited thing exactly as it appears, no cap. ๐
โจ NAME โจ
SoVRMLGroup โ The SoVRMLGroup class is used for grouping VRML nodes.
โจ SYNOPSIS โจ
๐ซถ Includes, inheritance, and inherited-by
#include <Inventor/VRMLnodes/SoVRMLGroup.h>
Inherits SoVRMLParent.
Inherited by SoVRMLCollision, and SoVRMLTransform.
๐ Public Types ๐
The class has its own enum, and then it inherits a whole enum from SoNode. Slay.
enum CacheEnabled { OFF, ON, AUTO }
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
}
๐ธ Public Member Functions ๐ธ
These are the class's own member functions. Yes, all of them. Periodt.
virtual SoType getTypeId (void) const
SoVRMLGroup (void)
SoVRMLGroup (int numChildren)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void notify (SoNotList *list)
Public Member Functions inherited from SoVRMLParent
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
Public Member Functions inherited from SoGroup
SoGroup (void)
SoGroup (int nchildren)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *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 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 โญ
The static roster, because sometimes you need the class-level tea. โ
static SoType getClassTypeId (void)
static void initClass (void)
static void setNumRenderCaches (int num)
static int getNumRenderCaches (void)
Static Public Member Functions inherited from SoVRMLParent
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 ๐
These are the public fields. They are the vibe. Do not lose them.
SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling
SoSFVec3f bboxCenter
SoSFVec3f bboxSize
Public Attributes inherited from SoVRMLParent
SoMFNode children
๐ Protected Member Functions ๐
Protected means the class is protective of its business, but we still list every single one. ๐
virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLGroup ()
virtual SbBool cullTest (SoState *state)
Protected Member Functions inherited from SoVRMLParent
SoVRMLParent (void)
SoVRMLParent (int approxchildren)
virtual ~SoVRMLParent ()
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 plus protected? It's giving "best of both worlds" honestly. โจ
static const SoFieldData ** getFieldDataPtr (void)
Static Protected Member Functions inherited from SoVRMLParent
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)
๐ Static Protected Attributes ๐
Attributes, but make them static and protected. Strawberry emoji because it felt right. ๐
static int numRenderCaches = 2
Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0
๐ Additional Inherited Members ๐
The extra inherited goodies. Still important, still included, still iconic. ๐
Protected Types inherited from SoBase:
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
Protected Attributes inherited from SoVRMLParent:
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
โจ Detailed Description โจ
Okay so the SoVRMLGroup class is literally the vibe for grouping VRML nodes together. No cap.
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:
Group {
eventIn MFNode addChildren
eventIn MFNode removeChildren
exposedField MFNode children []
field SFVec3f bboxCenter 0 0 0 # (-inf,inf)
field SFVec3f bboxSize -1 -1 -1 # (0,inf) or -1,-1,-1
}
A Group node contains children nodes without introducing a new transformation. It is equivalent to a Transform node containing an identity transform. More details on the children, addChildren, and removeChildren fields and eventIns can be found in 4.6.5, Grouping and children nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.5).
The bboxCenter and bboxSize fields specify a bounding box that encloses the Group node's children. This is a hint that may be used for optimization purposes. The results are undefined if the specified bounding box is smaller than the actual bounding box of the children at any time. A default bboxSize value, (-1, -1, -1), implies that the bounding box is not specified and, if needed, is calculated by the browser. A description of the bboxCenter and bboxSize fields is contained in 4.6.4, Bounding boxes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.4).
๐ Constructor & Destructor Documentation ๐
๐ SoVRMLGroup::SoVRMLGroup (void ) ๐
Constructor. Referenced by getFieldData().
๐ธ SoVRMLGroup::SoVRMLGroup (int numchildren) ๐ธ
Constructor. numchildren is the expected number of children. References SoVRMLParent::SoVRMLParent().
๐ฆ SoVRMLGroup::~SoVRMLGroup () [protected], [virtual] ๐ฆ
Destructor.
๐ Member Function Documentation ๐
SoType SoVRMLGroup::getTypeId (void ) const [virtual] ๐
This is the function that tells you what type this object is. It's used for run-time type checking and for "downward" casting. Basically, it's the ID check, bestie. ๐
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
}
}
Now, if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others: you need to override this method in all subclasses. 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, check the class documentation of the toplevel superclasses for the various class groups. ๐
- Reimplemented from:
SoVRMLParent - Reimplemented in:
SoVRMLCollision, andSoVRMLTransform - Referenced by:
GLRenderBelowPath()
const SoFieldData * SoVRMLGroup::getFieldData (void ) const [protected], [virtual] ๐๏ธ
This one gives you a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. ๐ซ
- Reimplemented from:
SoVRMLParent - Reimplemented in:
SoVRMLCollision, andSoVRMLTransform - References:
SoNode::rayPickS(), andSoVRMLGroup()
void SoVRMLGroup::setNumRenderCaches (int num) [static] ๐ง
Sets the maximum number of render caches per group node.
int SoVRMLGroup::getNumRenderCaches (void ) [static] ๐ง
Returns the maximum number of render caches per group node.
- Referenced by:
GLRenderBelowPath()
void SoVRMLGroup::doAction (SoAction * action) [virtual] ๐ฌ
This function performs the typical operation of a node for any action. It's the all-rounder, bestie. โจ
- Reimplemented from:
SoVRMLParent - Reimplemented in:
SoVRMLTransform - References:
SoVRMLParent::doAction(),SoAction::getState(),SoState::pop(), andSoState::push() - Referenced by:
audioRender(),rayPick(), andsearch()
void SoVRMLGroup::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. Lowkey handy. ๐ง
- Reimplemented from:
SoGroup - Reimplemented in:
SoVRMLTransform - References:
SoGroup::callback(),cullTest(),SoAction::getState(),SoState::pop(), andSoState::push() - Referenced by:
SoVRMLTransform::callback()
void SoVRMLGroup::GLRender (SoGLRenderAction * action) [virtual] ๐จ
Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. It's giving main character rendering energy. ๐
- Reimplemented from:
SoGroup - Reimplemented in:
SoVRMLCollision - References:
SoAction::getCurPathCode(),GLRenderBelowPath(), andGLRenderInPath()
void SoVRMLGroup::getBoundingBox (SoGetBoundingBoxAction * action) [virtual] ๐ฆ
Action method for the SoGetBoundingBoxAction. It calculates bounding box and center coordinates for the 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 calculates their bounding box also overrides this method to change the relevant state variables.
- Reimplemented from:
SoGroup - Reimplemented in:
SoVRMLTransform - References:
SoGetBoundingBoxAction::extendBy()SoGroup::getBoundingBox()SoGetBoundingBoxAction::getCenter()SoAction::getCurPathCode()SoAction::getState()SbVec3f::getValue()SoGetBoundingBoxAction::getXfBoundingBox()SbMatrix::identity()SoGetBoundingBoxAction::isCenterSet()SbBox3f::isEmpty()SoGetBoundingBoxAction::isInCameraSpace()SoGetBoundingBoxAction::isResetPath()SbBox3f::makeEmpty()SoState::pop()SoState::push()SoGetBoundingBoxAction::resetCenter()SoGetBoundingBoxAction::setCenter()SbXfBox3f::setTransform()
- Referenced by:
SoVRMLTransform::getBoundingBox()
void SoVRMLGroup::getMatrix (SoGetMatrixAction * action) [virtual] ๐งฎ
Action method for SoGetMatrixAction. Updates action by accumulating with the transformation matrix of this node (if any). Math but make it fashion. โจ
- Reimplemented from:
SoGroup - Reimplemented in:
SoVRMLTransform - References:
SoVRMLParent::getChildren(),SoAction::getPathCode(), andSoChildList::traverseInPath()
void SoVRMLGroup::rayPick (SoRayPickAction * action) [virtual] ๐ฆ
Action method for SoRayPickAction. Checks the ray specification of the action and tests for intersection with the data of the node. Nodes influencing relevant state variables for how picking is done also overrides this method.
- Reimplemented from:
SoNode - Reimplemented in:
SoVRMLTransform - References:
doAction(),SoAction::getState(), andSoRayPickAction::hasWorldSpaceRay() - Referenced by:
SoVRMLTransform::rayPick()
void SoVRMLGroup::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. No partial credit, bestie. ๐ฏ
See also: SoSearchAction
- Reimplemented from:
SoVRMLParent - References:
doAction(),SoSearchAction::isFound(), andSoNode::search()
void SoVRMLGroup::write (SoWriteAction * action) [virtual] โ๏ธ
Action method for SoWriteAction. Writes out a node object, and any connected nodes, engines etc, if necessary. It's the scribe of the group. ๐
- Reimplemented from:
SoVRMLParent - References:
SoVRMLParent::write()
void SoVRMLGroup::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:
SoVRMLParent - Reimplemented in:
SoVRMLTransform - References:
SoVRMLParent::getPrimitiveCount(),SoAction::getState(),SoState::pop(), andSoState::push()
void SoVRMLGroup::audioRender (SoAudioRenderAction * action) [virtual] ๐
Action method for SoAudioRenderAction. Does common processing for SoAudioRenderAction action instances. It's the sound check, periodt. ๐ง
- Reimplemented from:
SoGroup - Reimplemented in:
SoVRMLTransform - References:
doAction(),SoVRMLParent::doAction(),SoAction::getPathCode(),SoAction::getState(),SoState::pop(), andSoState::push()
void SoVRMLGroup::GLRenderBelowPath (SoGLRenderAction * action) [virtual] โฌ๏ธ
Implements the SoAction::BELOW_PATH traversal method for the rendering action.
- Reimplemented from:
SoNode - Reimplemented in:
SoVRMLTransform - References:
SoGLRenderAction::abortNow()cullTest()SbPList::getArrayPtr()SoVRMLParent::getChildren()SbPList::getLength()SoBase::getName()getNumRenderCaches()SoAction::getState()getTypeId()SoNode::GLRenderBelowPath()SoAction::hasTerminated()SoState::isCacheOpen()SoState::pop()SoAction::popCurPath()SoAction::popPushCurPath()SoDebugError::post()SoDebugError::postInfo()SoState::push()SoAction::pushCurPath()SoNode::SoNode()
- Referenced by:
GLRender(),SoVRMLTransform::GLRenderBelowPath(), andGLRenderInPath()
void SoVRMLGroup::GLRenderInPath (SoGLRenderAction * action) [virtual] โก๏ธ
Implements the SoAction::IN_PATH traversal method for the rendering action.
- Reimplemented from:
SoNode - Reimplemented in:
SoVRMLTransform - References:
SoGLRenderAction::abortNow()SoNode::affectsState()SbPList::getArrayPtr()SoVRMLParent::getChildren()SoAction::getCurPathCode()SoAction::getPathCode()SoAction::getState()GLRenderBelowPath()SoNode::GLRenderInPath()SoNode::GLRenderOffPath()SoAction::hasTerminated()SoState::pop()SoAction::popCurPath()SoState::push()SoAction::pushCurPath()SoNode::SoNode()
- Referenced by:
GLRender(), andSoVRMLTransform::GLRenderInPath()
void SoVRMLGroup::GLRenderOffPath (SoGLRenderAction * action) [virtual] ๐ซ
Implements the SoAction::OFF_PATH traversal method for the rendering action.
- Reimplemented from:
SoNode
void SoVRMLGroup::notify (SoNotList * l) [virtual] ๐
Notifies all auditors for this instance when changes are made. It's the gossip girl of the scene graph. ๐
- Reimplemented from:
SoVRMLParent - Reimplemented in:
SoVRMLCollision, andSoVRMLTransform - References:
SoVRMLParent::notify() - Referenced by:
SoVRMLCollision::notify(), andSoVRMLTransform::notify()
SbBool SoVRMLGroup::cullTest (SoState * state) [protected], [virtual] ๐งน
Returns TRUE if children can be culled. Basically, can we skip them? ๐
- References:
SbBox3f::isEmpty() - Referenced by:
callback(), andGLRenderBelowPath()
โจ Author โจ
Generated automatically by Doxygen for Coin from the source code. No cap, the robots wrote this one. ๐ค
That's the whole vibe, bestie! This page comes from Coin version 2.5.0 and it's the manual for SoVRMLGroup(3). The footer didn't give a date, so that's all the source/version tea we have. Stay iconic! ๐โจ
๐ฆ where this page comes from
- fedora 43: Coin2-devel 2.5.0-52.fc43 ยท GPL-2.0-only
- fedora 43: Coin2-devel 2.5.0-52.fc43 ยท GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 ยท GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.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