SoGroup(3)

📦 version 2.5.0, in fedora 43, fedora 44

💅 SoGroup(3) — Library Functions Manual

okay bestie, gather round, because today we're decoding SoGroup from the Library Functions Manual, and honestly? she's the moment. 🎀

✨ NAME ✨

SoGroup — the class that's basically a whole group chat but for nodes. She manages other node instances. Mother hen energy, fr fr. 👑

🦋 SYNOPSIS 🦋

First things first, you gotta let her in the building:

#include <Inventor/nodes/SoGroup.h>

She Inherits from SoNode. Yeah, she comes from good stock. 💖

And the girlies that Inherited by her (aka her children, her legacy, her little minions)? Let me list them, no skips:

SoArray, SoLOD, SoLevelOfDetail, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

A whole family tree. Slay. 🌸

🌈 Public Member Functions

here's the main cast, verbatim, don't come for me:

virtual SoType getTypeId (void) const
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 doAction (SoAction *action)
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 search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual SoChildList * getChildren (void) const
two constructors, a whole pile of child-wrangling methods, and then every single action hook you could ever need. she does it ALL and she does it in style. 💅

💜 Public Member Functions inherited from SoNode

the stuff she got from her parent, SoNode, all of it, zero cuts:

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

more inheritance, more blessings:

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

and the OG ancestor, SoBase. she's where the ref-counting lives, bestie:

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

these ones you don't even need an instance for, they're just there:

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)

🎀 Protected Member Functions

the VIP-only section, not for just anyone:

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

one protected attribute, and she's a big deal:

  • SoChildList * children — the actual list of children she's mothering. this is the data, bestie. 🍼

🎀 Protected Attributes inherited from SoNode

  • uint32_t uniqueId

💖 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🦋 Friends

she keeps a small circle, and it's literally one entry:

  • class SoUnknownNode

✨ Additional Inherited Members

the deep lore. the stuff at the bottom that nobody reads but is still important. 🫡

💜 Public Types inherited from SoNode

here's the enum, every single flag, no skips:

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
    }
these are bitmask values btw, they're all powers-of-two-ish flags you OR together. iykyk. 💅

🌸 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

and that's where part 1 wraps, bestie — the vibes are immaculate, the inheritance tree is giving royal family, and we've only just started. more coming. stay tuned. 🌈💖

✨ Detailed Description ✨

okay bestie, let's get into it. so the SoGroup class is literally a node that manages other node instances. it's giving manager energy. 💅

The internal scene data structures in Coin are managed as directed graphs. The graphs are built by setting up a hierarchy through the use of group nodes (either of this type, or from subclasses like SoSeparator) which is then traversed when applying actions (like SoGLRenderAction) to it.

SoGroup, SoSeparator, and other classes derived from SoGroup, are the "tools" the application programmer uses when making the layout of the scene graph.

An often asked question about SoGroup nodes is: "Why is there noSoGroup::getParent() method?" The answer to this is that nodes in the scene graph can have multiple parents, so a simple getParent() method wouldn't work. If you have a node pointer (or other node identification) of a node that you want to remove from the scene graph, what you need to do is to use an SoSearchAction to find all paths down to the node, and then invoke SoGroup::removeChild() from all found parents of the node.

The function would look something like this:

void getParents(SoNode * node, SoNode * root, SoPathList & parents)
{
  SoSearchAction sa;
  sa.setNode(node);
  sa.setInterest(SoSearchAction::ALL);
  sa.apply(root);
  parents = sa.getPaths();
}

Or if you know that your node of interest has only a single parent:

SoGroup * getParent(SoNode * node, SoNode * root)
{
  SoSearchAction sa;
  sa.setNode(node);
  sa.setInterest(SoSearchAction::FIRST);
  sa.apply(root);
  SoPath * p = sa.getPath();
  assert(p && "not found");
  if (p->getLength() < 2) { return NULL; } // no parent
  return (SoGroup *)p->getNodeFromTail(1);
}

An important note about a potential problem using SoGroup nodes which it is not common to stumble on, but which makes hard to find bugs when one does: you should not change the scene graph layout during any action traversal, as that is not allowed by the internal Coin code. I.e. do not use addChild(), removeChild(), insertChild() or replaceChild() from any callback that is triggered directly or indirectly from an action traversal. The most common way of getting hit by this error, would be something like the following (simplified) example:

#include <Inventor/Qt/SoQt.h>
#include <Inventor/Qt/viewers/SoQtExaminerViewer.h>

#include <Inventor/nodes/SoEventCallback.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoCone.h>
#include <Inventor/manips/SoPointLightManip.h>
#include <Inventor/events/SoMouseButtonEvent.h>

SoPointLightManip * global_pointlightmanip;
SoSeparator * global_root;

// Remove pointlight when clicking right mouse button.
static void
mySelectionC(void * ud, SoEventCallback * n)
{
  const SoMouseButtonEvent * mbe = (SoMouseButtonEvent*) n->getEvent();

  if ((mbe->getButton() == SoMouseButtonEvent::BUTTON2) &&
      (mbe->getState() == SoButtonEvent::DOWN)) {
    if (global_pointlightmanip) {
      global_root->removeChild(global_pointlightmanip);
      global_pointlightmanip = NULL;
    }
  }
}

int
main(int argc, char ** argv)
{
  QWidget * window = SoQt::init(argv[0]);

  global_root = new SoSeparator;
  global_root->ref();

  SoEventCallback * ecb = new SoEventCallback;
  ecb->addEventCallback(SoMouseButtonEvent::getClassTypeId(), mySelectionC, 0);
  global_root->addChild(ecb);

  global_root->addChild(new SoCone);

  global_pointlightmanip = new SoPointLightManip;
  global_root->addChild(global_pointlightmanip);

  SoQtExaminerViewer * viewer = new SoQtExaminerViewer(window);
  viewer->setSceneGraph(global_root);
  viewer->show();

  SoQt::show(window);
  SoQt::mainLoop();

  global_root->unref();
  delete viewer;

  return 0;
}

What happens in the above case is this: when clicking with the right mouse button, the SoQtExaminerViewer converts the Qt event to a Coin event, which is sent down the scene graph with an SoHandleEventAction. The action traversal reaches the "global_root" SoSeparator node, where it sees that it should further traverse 3 child nodes (first the SoEventCallback, then the SoCone, then the SoPointLightManip). When it then traverses the SoEventCallback, the mySelectionC() callback will be invoked, which removes the last child. But the SoHandleEventAction will still continue it's traversal as if the global_root node has 3 children -- and the code will crash.

(This exact example would perhaps be straight-forward to handle internally in Coin, but there are other ways to change the scene graph layout that are very difficult to handle properly. So in general, changing layout during action traversal is not allowed.)

What to do in these cases is to change the code inside the callback to not do any operations that immediately changes the layout of the scene graph, but to delay it for after the traversal is done. This can e.g. be done by using a Coin sensor.

FILE FORMAT/DEFAULTS:

Group {
}

🎀 Constructor & Destructor Documentation 🎀

💖 SoGroup::SoGroup (void ) 💖

Default constructor.

References: children, and SoGroup().
Referenced by: copyContents(), getChildren(), getFieldData(), SoGroup(), SoGroup(), SoSeparator::SoSeparator(), SoVRMLLOD::SoVRMLLOD(), SoVRMLParent::SoVRMLParent(), and SoVRMLSwitch::SoVRMLSwitch().

💖 SoGroup::SoGroup (int nchildren) 💖

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.

References: children, and SoGroup().

💖 SoGroup::~SoGroup () [protected], [virtual] 💖

Destructor.

References: children.

💅 Member Function Documentation 💅

🌸 SoType SoGroup::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
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. 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.

Implements SoBase.

Reimplemented in SoAnnotation, SoArray, SoBlinker, SoExtSelection, SoGeoSeparator, SoLevelOfDetail, SoLocateHighlight, SoLOD, SoMultipleCopy, SoPathSwitch, SoSelection, SoSeparator, SoShadowGroup, SoSwitch, SoTransformSeparator, SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, SoVRMLSwitch, SoVRMLTransform, and SoWWWAnchor.

Referenced by: GLRender().

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

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

Reimplemented in SoAnnotation, SoArray, SoBlinker, SoExtSelection, SoGeoSeparator, SoLevelOfDetail, SoLocateHighlight, SoLOD, SoMultipleCopy, SoPathSwitch, SoSelection, SoSeparator, SoShadowGroup, SoSwitch, SoTransformSeparator, SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, SoVRMLSwitch, SoVRMLTransform, and SoWWWAnchor.

References: SoGroup().
Referenced by: write().

🌸 void SoGroup::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 in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References: SoChildList::append(), getChildren(), and SoNode::SoNode().
Referenced by: SoFile::copyChildren(), copyContents(), readChildren(), SoNodeKitListPart::setContainerType(), and SoBaseKit::setPart().

🌸 void SoGroup::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 in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References: getChildren(), getNumChildren(), SoChildList::insert(), SoDebugError::post(), and SoNode::SoNode().
Referenced by: SoBaseKit::setPart().

🌸 SoNode * SoGroup::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 in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References: SbPList::getArrayPtr(), getChildren(), getNumChildren(), and SoNode::SoNode().
Referenced by: SoSwitch::affectsState(), copyContents(), SoLOD::GLRenderInPath(), and SoLOD::GLRenderOffPath().

🌸 int SoGroup::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.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References: SbPList::find(), getChildren(), and SoNode::SoNode().
Referenced by: SoSwitch::notify(), removeChild(), replaceChild(), and SoInteractionKit::setAnySurrogatePath().

🌸 int SoGroup::getNumChildren (void ) const [virtual] 🌸

Returns number of child nodes managed by this group.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References: getChildren(), and SbPList::getLength().
Referenced by: SoSwitch::affectsState(), copyContents(), SoLevelOfDetail::doAction(), SoLOD::doAction(), SoSwitch::doAction(), getBoundingBox(), getChild(), insertChild(), SoBlinker::notify(), removeChild(), replaceChild(), SoSceneKit::setCameraNumber(), SoLOD::whichToTraverse(), write(), and SoSwitch::write().

🌸 void SoGroup::removeChild (int childindex) [virtual] 🌸

Remove node at childindex in our list of children.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References getChildren(), getNumChildren(), SoDebugError::post(), and SoChildList::remove().

Referenced by removeChild(), and SoBaseKit::setPart().

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

Okurrr bestie 💅 removeChild is giving "you're not in my group chat anymore" energy. It removes child from the set of children this group node is managing, and it will decrease the reference count of child by 1. So it's a real goodbye, not a soft block 😭

This is a convenience method, meaning it's not doing any fancy footwork itself. It just calls findChild() with child as the argument, and then calls removeChild(int) if the child is found. Simple as that, periodt 💖

Please note that this method is not virtual in the original SGI Inventor API. So don't come for it.
  • Reimplemented in: SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.
  • References: findChild(), SoType::getName(), SbName::getString(), SoBase::getTypeId(), SoDebugError::post(), removeChild(), and SoNode::SoNode().

void SoGroup::removeAllChildren (void ) [virtual]

This one is the "clean slate" icon ✨ It does not manage the children anymore, and it will dereference all children by 1 as they are removed. So basically everyone gets their ref count lowered on the way out the door 👑

Please note that this method is not virtual in the original SGI Inventor API.
  • Reimplemented in: SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.
  • References: getChildren().
  • Referenced by: copyContents(), and SoBaseKit::readInstance().

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

Swap szn 🔄 This replaces the child at index with newChild. It dereferences the child previously at index, and increases the reference count of newChild by 1. So the new kid gets a plus one, the old kid gets a minus one. Balanced, as all things should be ⚖️

Please note that this method is not virtual in the original SGI Inventor API.
  • Reimplemented in: SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.
  • References: getChildren(), SoChildList::set(), and SoNode::SoNode().
  • Referenced by: replaceChild(), and SoBaseKit::setPart().

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

The "it's not you, it's me" replacement 💔 This replaces oldchild with newchild. It dereferences oldchild by 1, and increases the reference count of newchild by 1.

This is a convenience method, so it simply calls findChild() with oldchild as the argument, and calls replaceChild(int, SoNode*) if the child is found. No cap 🧢

Please note that this method is not virtual in the original SGI Inventor API.
  • Reimplemented in: SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.
  • References: findChild(), SoType::getName(), getNumChildren(), SbName::getString(), SoBase::getTypeId(), SoDebugError::post(), SoDebugError::postInfo(), replaceChild(), and SoNode::SoNode().

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

This function performs the typical operation of a node for any action. It's the main character of action methods 👑

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoLevelOfDetail, SoLOD, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, SoVRMLSwitch, and SoVRMLTransform.
  • References: getChildren(), SoAction::getPathCode(), SoChildList::traverse(), and SoChildList::traverseInPath().
  • Referenced by: audioRender(), SoSeparator::audioRender(), callback(), SoArray::doAction(), SoLevelOfDetail::doAction(), SoMultipleCopy::doAction(), SoPathSwitch::doAction(), SoSeparator::doAction(), SoTransformSeparator::doAction(), SoVRMLBillboard::doAction(), SoVRMLParent::doAction(), SoVRMLTransform::doAction(), getMatrix(), getPrimitiveCount(), handleEvent(), pick(), search(), SoVRMLBillboard::search(), and write().

void SoGroup::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 want to throw geometry primitives at OpenGL — override this method. It's giving "I'm the render plug" 💅

  • Reimplemented from: SoNode.
  • Reimplemented in: SoAnnotation, SoArray, SoLevelOfDetail, SoLOD, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, SoVRMLLOD, and SoVRMLSwitch.
  • References: SoGLRenderAction::abortNow(), SoNode::affectsState(), SbPList::getArrayPtr(), getChildren(), SoAction::getCurPathCode(), SbPList::getLength(), SoBase::getName(), SoAction::getPathCode(), SoAction::getState(), getTypeId(), SoNode::GLRender(), SoAction::hasTerminated(), SoAction::popCurPath(), SoAction::popPushCurPath(), SoDebugError::post(), SoAction::pushCurPath(), and SoNode::SoNode().
  • Referenced by: SoPathSwitch::GLRender(), and SoTransformSeparator::GLRender().

void SoGroup::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. Very "here's the tea" ☕

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoGeoSeparator, SoLevelOfDetail, SoLOD, SoMultipleCopy, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, SoVRMLSwitch, and SoVRMLTransform.
  • References: doAction().
  • Referenced by: SoSeparator::callback(), SoTransformSeparator::callback(), and SoVRMLGroup::callback().

void SoGroup::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. Big "let me wrap my head around this" energy 📦

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoBlinker, SoGeoSeparator, SoLevelOfDetail, SoLOD, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, SoVRMLSwitch, and SoVRMLTransform.
  • References: SoGetBoundingBoxAction::getCenter(), getChildren(), getNumChildren(), SoAction::getPathCode(), SoGetBoundingBoxAction::isCenterSet(), SoGetBoundingBoxAction::resetCenter(), SoGetBoundingBoxAction::setCenter(), and SoChildList::traverse().
  • Referenced by: SoSwitch::doAction(), SoArray::getBoundingBox(), SoBlinker::getBoundingBox(), SoLevelOfDetail::getBoundingBox(), SoLOD::getBoundingBox(), SoMultipleCopy::getBoundingBox(), SoPathSwitch::getBoundingBox(), SoSeparator::getBoundingBox(), SoTransformSeparator::getBoundingBox(), SoVRMLBillboard::getBoundingBox(), SoVRMLGroup::getBoundingBox(), and SoVRMLLOD::getBoundingBox().

void SoGroup::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction. It updates action by accumulating with the transformation matrix of this node (if any). Math girlies rise up 📐

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoGeoSeparator, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLGroup, SoVRMLSwitch, and SoVRMLTransform.
  • References: doAction(), and SoAction::getCurPathCode().
  • Referenced by: SoArray::getMatrix(), SoMultipleCopy::getMatrix(), SoPathSwitch::getMatrix(), and SoVRMLTransform::getMatrix().

void SoGroup::handleEvent (SoHandleEventAction * action) [virtual]

Action method for SoHandleEventAction. It inspects the event data from action, and processes it if it is something which this node should react to. Like checking your notifications and deciding which ones are worth replying to 📱

Nodes influencing relevant state variables for how event handling is done also overrides this method.

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoExtSelection, SoLocateHighlight, SoMultipleCopy, SoPathSwitch, SoSelection, SoSeparator, SoSwitch, SoVRMLAnchor, SoVRMLSwitch, and SoWWWAnchor.
  • References: doAction().
  • Referenced by: SoArray::handleEvent(), SoMultipleCopy::handleEvent(), SoPathSwitch::handleEvent(), and SoVRMLAnchor::handleEvent().

void SoGroup::pick (SoPickAction * action) [virtual]

Action method for SoPickAction. It does common processing for SoPickAction action instances. Very "pick me, choose me" 💅

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoMultipleCopy, SoPathSwitch, SoSwitch, SoTransformSeparator, SoVRMLBillboard, and SoVRMLSwitch.
  • References: doAction().
  • Referenced by: SoPathSwitch::pick(), and SoTransformSeparator::pick().

void SoGroup::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. It's giving detective mode 🔍

See also: SoSearchAction

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.
  • References: doAction(), SoSearchAction::isFound(), and SoNode::search().
  • Referenced by: SoArray::search(), SoMultipleCopy::search(), SoPathSwitch::search(), SoVRMLLOD::search(), and SoVRMLParent::search().

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

Action method for SoWriteAction. It writes out a node object, and any connected nodes, engines etc, if necessary. So it's the "let me put this in writing" moment ✍️

  • Reimplemented from: SoNode.
  • Reimplemented in: SoBlinker, SoSwitch, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.
  • References: SoFieldContainer::addWriteReference(), doAction(), getFieldData(), getNumChildren(), SoWriteAction::getOutput(), SoOutput::getStage(), SoOutput::isBinary(), SoBase::ref(), SoFieldData::write(), SoOutput::write(), SoBase::writeFooter(), and SoBase::writeHeader().

void SoGroup::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. Math class but make it fashion 📊

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoGeoSeparator, SoLOD, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, and SoVRMLTransform.
  • References: doAction().
  • Referenced by: SoPathSwitch::getPrimitiveCount(), SoVRMLParent::getPrimitiveCount(), and SoVRMLTransform::getPrimitiveCount().

void SoGroup::audioRender (SoAudioRenderAction * action) [virtual]

Action method for SoAudioRenderAction. It does common processing for SoAudioRenderAction action instances. Sound check 🎧

  • Reimplemented from: SoNode.
  • Reimplemented in: SoArray, SoLevelOfDetail, SoLOD, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLGroup, SoVRMLLOD, SoVRMLSwitch, and SoVRMLTransform.
  • References: doAction().
  • Referenced by: SoLevelOfDetail::audioRender(), SoPathSwitch::audioRender(), and SoTransformSeparator::audioRender().

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

Returns list of children. That's it, that's the tweet 🐦

  • Reimplemented from: SoNode.
  • Reimplemented in: SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References SoGroup().

And bestie, it's referenced by:

  • addChild()
  • doAction()
  • SoLevelOfDetail::doAction()
  • SoLOD::doAction()
  • SoSwitch::doAction()
  • findChild()
  • getBoundingBox()
  • getChild()
  • getNumChildren()
  • GLRender()
  • insertChild()
  • removeAllChildren()
  • removeChild()
  • replaceChild()
  • SoSwitch::write()

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

Okay so this method is mainly for internal use during file import operations, no cap. 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. Like, don't panic, just return FALSE.

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

Reimplemented from SoNode.

Reimplemented in SoSeparator, SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References SoInput::getIVVersion(), SoInput::isBinary(), readChildren(), and SoNode::readInstance().

Referenced by SoSeparator::readInstance(), SoVRMLLOD::readInstance(), and SoVRMLSwitch::readInstance().

SbBool SoGroup::readChildren (SoInput * in) [protected], [virtual]

Read all children of this node from in and attach them below this group in left-to-right order. Returns FALSE upon read error. Periodt.

References addChild(), SoInput::eof(), SoInput::isBinary(), SoReadError::post(), SoDebugError::postInfo(), SoBase::read(), SoInput::read(), SoBase::SoBase(), and SoNode::SoNode().

Referenced by readInstance().

void SoGroup::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. It's giving "clone but not the external links".

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.

⚠️ bestie, for copying nodes from application code, you should not invoke this function directly. Instead, call the SoNode::copy() function:
SoNode * mynewnode = templatenode->copy();

The same also goes for engines. No cap.

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..]
}

Reimplemented from SoNode.

Reimplemented in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch.

References addChild(), SoNode::copyContents(), SoFieldContainer::findCopy(), getChild(), getNumChildren(), removeAllChildren(), SoFieldContainer::SoFieldContainer(), SoGroup(), and SoNode::SoNode().

💖 Member Data Documentation 💖

SoChildList* SoGroup::children [protected]

List of managed child nodes. It's literally the whole vibe of this group. 🦋

Referenced by SoVRMLLOD::copyContents(), SoVRMLParent::copyContents(), SoVRMLSwitch::copyContents(), SoLOD::doAction(), SoSwitch::doAction(), SoVRMLLOD::getChildren(), SoVRMLParent::getChildren(), SoVRMLSwitch::getChildren(), SoSeparator::getMatrix(), SoTransformSeparator::getMatrix(), SoLOD::GLRenderBelowPath(), SoSeparator::GLRenderBelowPath(), SoSeparator::GLRenderInPath(), SoVRMLLOD::readInstance(), SoVRMLSwitch::readInstance(), SoVRMLLOD::removeAllChildren(), SoVRMLParent::removeAllChildren(), SoVRMLSwitch::removeAllChildren(), SoVRMLParent::removeChild(), SoVRMLParent::removeChild(), SoSwitch::search(), SoGroup(), SoGroup(), and ~SoGroup().

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. So you know it's official. 💅

That's the whole page, bestie! 💖 This manual was brought to you by Coin, Version 2.5.0, and the page SoGroup(3) — auto-generated by Doxygen, so it's dated the exact moment it was built. Stay iconic! ✨

📦 where this page comes from