---

SoGroup Class Reference

The SoGroup class is a node which managed other node instances. More...

#include <Inventor/nodes/SoGroup.h>

Inheritance diagram for SoGroup::

List of all members.

Public Methods
	SoGroup (void)
	SoGroup (int nchildren)
void	addChild (SoNode *const node)
void	insertChild (SoNode *const child, const int newchildindex)
SoNode *	getChild (const int index) const
int	findChild (const SoNode *const node) const
int	getNumChildren (void) const
void	removeChild (const int childindex)
void	removeChild (SoNode *const child)
void	removeAllChildren (void)
void	replaceChild (const int index, SoNode *const newchild)
void	replaceChild (SoNode *const oldchild, SoNode *const 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)
SoChildList *	getChildren (void) const
Static Public Methods
void	initClass (void)
Protected Methods
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

---

Detailed Description

The SoGroup class is a node which managed other node instances.

The internal scene datastructures in Coin is 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.

---

Constructor & Destructor Documentation

SoGroup::SoGroup (  void )

Default constructor.

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.

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

Destructor.

---

Member Function Documentation

void SoGroup::initClass (  void )  [static]

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, and SoWWWAnchor.

void SoGroup::addChild (  SoNode *const node )

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

void SoGroup::insertChild (  SoNode *const child, const int newchildindex )

Insert a child node at position newchildindex.

SoNode * SoGroup::getChild (  const int index )  const

Returns pointer to child node at index.

int SoGroup::findChild (  const SoNode *const node )  const

Returns index in our list of children for child node, or -1 if node is not a child of this group node.

int SoGroup::getNumChildren (  void )  const

Returns number of child nodes managed by this group.

void SoGroup::removeChild (  const int childindex )

Remove node at childindex in our list of children.

void SoGroup::removeChild (  SoNode *const child )

Remove child from the set of children managed by this group node. Will decrease the reference count of child by 1.

void SoGroup::removeAllChildren (  void )

Do not manage the children anymore. Will dereference all children by 1 as they are removed.

void SoGroup::replaceChild (  const int index, SoNode *const newchild )

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

void SoGroup::replaceChild (  SoNode *const oldchild, SoNode *const newchild )

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

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

This function performs the typical operation of a node for any action. Reimplemented from SoNode. Reimplemented in SoArray, SoLOD, SoLevelOfDetail, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, and SoTransformSeparator.

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 wants to throw geometry primitives at OpenGL overrides this method. Reimplemented from SoNode. Reimplemented in SoAnnotation, SoArray, SoLOD, SoLevelOfDetail, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, and SoTransformSeparator.

void SoGroup::callback (  SoCallbackAction * action )  [virtual]

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, and SoTransformSeparator.

void SoGroup::getBoundingBox (  SoGetBoundingBoxAction * action )  [virtual]

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, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, and SoTransformSeparator.

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

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, and SoTransformSeparator.

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

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, and SoWWWAnchor.

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

Action method for SoPickAction. Does common processing for SoPickAction action instances. Reimplemented from SoNode. Reimplemented in SoArray, SoMultipleCopy, SoPathSwitch, SoSwitch, and SoTransformSeparator.

void SoGroup::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. See also: SoSearchAction Reimplemented from SoNode. Reimplemented in SoArray, SoMultipleCopy, SoPathSwitch, SoSeparator, and SoSwitch.

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

Action method for SoWriteAction. Writes out a node object, and any connected nodes, engines etc, if necessary. Reimplemented from SoNode. Reimplemented in SoBlinker, and SoSwitch.

void SoGroup::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 SoNode. Reimplemented in SoArray, SoLOD, SoMultipleCopy, SoPathSwitch, SoSeparator, SoSwitch, and SoTransformSeparator.

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

Returns list of children. Reimplemented from SoNode.

SbBool SoGroup::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. flags is used internally during binary import when reading user extension nodes, group nodes or engines. Reimplemented from SoNode. Reimplemented in SoSeparator.

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.

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. This is the method that should be overridden by subclasses which needs to account for internal data that are not handled automatically. 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.

---

Member Data Documentation

SoChildList * SoGroup::children [protected]

List of managed child nodes.

---

The documentation for this class was generated from the following files:

• SoGroup.cpp
• SoGroup.h

---