#include <Inventor/nodes/SoGroup.h>
Inheritance diagram for SoGroup:
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 important note about SoGroup nodes: 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.
Public Member Functions | |
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 |
Static Public Member Functions | |
void | initClass (void) |
Protected Member Functions | |
virtual | ~SoGroup () |
virtual SbBool | readInstance (SoInput *in, unsigned short flags) |
virtual SbBool | readChildren (SoInput *in) |
virtual void | copyContents (const SoFieldContainer *from, SbBool copyconnections) |
Protected Attributes | |
SoChildList * | children |
Friends | |
class | SoUnknownNode |
|
Default constructor. |
|
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. |
|
Destructor. |
|
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Reimplemented from SoNode. Reimplemented in SoAnnotation, SoArray, SoBlinker, SoExtSelection, SoLOD, SoLevelOfDetail, SoLocateHighlight, SoMultipleCopy, SoPathSwitch, SoSelection, SoSeparator, SoSwitch, SoTransformSeparator, SoWWWAnchor, SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, SoVRMLSwitch, and SoVRMLTransform. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Remove child from the set of children managed by this group node. Will decrease the reference count of child by 1. 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 in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch. |
|
Do not manage the children anymore. Will dereference all children by 1 as they are removed. Please note that this method is not virtual in the original SGI Inventor API. Reimplemented in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch. |
|
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 in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch. |
|
Replace oldchild with newchild. 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 in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch. |
|
This function performs the typical operation of a node for any action. Reimplemented from SoNode. Reimplemented in SoArray, SoLOD, SoLevelOfDetail, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, SoVRMLSwitch, and SoVRMLTransform. |
|
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. Reimplemented from SoNode. Reimplemented in SoAnnotation, SoArray, SoLOD, SoLevelOfDetail, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLCollision, SoVRMLGroup, SoVRMLLOD, and SoVRMLSwitch. |
|
Action method for SoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. Reimplemented from SoNode. Reimplemented in SoArray, SoLOD, SoLevelOfDetail, SoMultipleCopy, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, SoVRMLSwitch, and SoVRMLTransform. |
|
Action method for the SoGetBoundingBoxAction. Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables. Reimplemented from SoNode. Reimplemented in SoArray, SoBlinker, SoLOD, SoLevelOfDetail, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, SoVRMLSwitch, and SoVRMLTransform. |
|
Action method for SoGetMatrixAction. Updates action by accumulating with the transformation matrix of this node (if any). Reimplemented from SoNode. Reimplemented in SoArray, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLBillboard, SoVRMLGroup, SoVRMLSwitch, and SoVRMLTransform. |
|
Action method for SoHandleEventAction. Inspects the event data from action, and processes it if it is something which this node should react to. Nodes influencing relevant state variables for how event handling is done also overrides this method. Reimplemented from SoNode. Reimplemented in SoArray, SoExtSelection, SoLocateHighlight, SoMultipleCopy, SoPathSwitch, SoSelection, SoSeparator, SoSwitch, SoWWWAnchor, SoVRMLAnchor, and SoVRMLSwitch. |
|
Action method for SoPickAction. Does common processing for SoPickAction action instances. Reimplemented from SoNode. Reimplemented in SoArray, SoMultipleCopy, SoPathSwitch, SoSwitch, SoTransformSeparator, SoVRMLBillboard, and SoVRMLSwitch. |
|
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.
Reimplemented from SoNode. Reimplemented in SoArray, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoVRMLBillboard, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch. |
|
Action method for SoWriteAction. Writes out a node object, and any connected nodes, engines etc, if necessary. Reimplemented from SoNode. Reimplemented in SoBlinker, SoSwitch, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch. |
|
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 SoNode. Reimplemented in SoArray, SoLOD, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLGroup, SoVRMLLOD, SoVRMLParent, and SoVRMLTransform. |
|
Action method for SoAudioRenderAction. Does common processing for SoAudioRenderAction action instances. Reimplemented from SoNode. Reimplemented in SoArray, SoLOD, SoLevelOfDetail, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, SoTransformSeparator, SoVRMLGroup, SoVRMLLOD, SoVRMLSwitch, and SoVRMLTransform. |
|
Returns list of children. Reimplemented from SoNode. Reimplemented in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch. |
|
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.
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. |
|
Read all children of this node from in and attach them below this group in left-to-right order. Returns |
|
Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is 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. Note that for simply copying e.g. a node from application code, it should be sufficient to do:
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:
Reimplemented from SoNode. Reimplemented in SoVRMLLOD, SoVRMLParent, and SoVRMLSwitch. |
|
List of managed child nodes. Reimplemented in SoVRMLParent. |