Base class for all group nodes. More...

#include <Inventor/nodes/SoGroup.h>

Inheritance diagram for SoGroup:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoGroup ()
	Creates an empty group node.

	SoGroup (int nChildren)
	Constructor that takes approximate number of children.

virtual void	addChild (SoNode *child)
	Adds a child as last one in group.

virtual void	insertChild (SoNode *child, int newChildIndex)
	Adds a child so that it becomes the one with the given index.

virtual SoNode *	getChild (int index) const
	Returns pointer the child node with the given index.

virtual int	findChild (const SoNode *child) const
	Finds index of given child within group.

virtual int	getNumChildren () const
	Returns number of children.

virtual void	removeChild (int index)
	Removes child with given index from group.

virtual void	removeChild (SoNode *child)
	Removes first instance of given child from group.

virtual void	removeAllChildren ()
	Removes all children from group.

virtual void	replaceChild (int index, SoNode *newChild)
	Replaces child with given index with new child.

virtual void	replaceChild (SoNode oldChild, SoNode newChild)
	Replaces first instance of given child with new child.

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Detailed Description

Base class for all group nodes.

This node defines the base class for all group nodes. SoGroup is a node that contains an ordered list of child nodes. The ordering of the child nodes represents the traversal order for all operations (for example, rendering, picking, and so on). This node is simply a container for the child nodes and does not alter the traversal state in any way. During traversal, state accumulated for a child is passed on to each successive child and then to the parents of the group (SoGroup does not push or pop traversal state as SoSeparator does).

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SoGLRenderAction

SoCallbackAction

SoGetBoundingBoxAction

SoHandleEventAction

SoRayPickAction

SoGetMatrixAction
Does nothing unless the group is in the middle of the path chain the action is being applied to. If so, the children up to and including the next node in the chain are traversed.

SoSearchAction
If searching for group nodes, compares with this group. Otherwise, continues to search children.

SoWriteAction
Writes out the group node. This method also deals with any field data associated with the group node. As a result, this method is used for most subclasses of SoGroup as well.

Constructor & Destructor Documentation

◆ SoGroup() [1/2]

SoGroup::SoGroup ( )

Creates an empty group node.

◆ SoGroup() [2/2]

SoGroup::SoGroup ( int nChildren )

Constructor that takes approximate number of children.

Space is allocated to contain the specified number of children, but the group does not contain any actual child nodes.

Member Function Documentation

◆ addChild()

virtual void SoGroup::addChild ( SoNode * child )

virtual

Adds a child as last one in group.

Reimplemented in SoExtSelection.

◆ findChild()

virtual int SoGroup::findChild ( const SoNode * child ) const

virtual

Finds index of given child within group.

Returns -1 if not found.

◆ getChild()

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

virtual

Returns pointer the child node with the given index.

◆ getClassTypeId()

static SoType SoGroup::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getNumChildren()

virtual int SoGroup::getNumChildren ( ) const

virtual

Returns number of children.

◆ getTypeId()

virtual SoType SoGroup::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Reimplemented in SoGeoLOD, SoAnnotation, SoArray, SoBillboard, SoBlinker, SoExtSelection, SoInteractiveSwitch, SoLevelOfDetail, SoLevelOfSimplification, SoLocateHighlight, SoLOD, SoMultiPathSwitch, SoMultipleCopy, SoMultipleInstance, SoMultipleInstanceBase, SoMultiSwitch, SoNurbsGroup, SoOverlayGroup, SoPathSwitch, SoRenderToTarget, SoSelection, SoSeparator, SoShadowGroup, SoSwitch, SoTransformSeparator, SoVertexAttribFeedback, SoWWWAnchor, SoMultiDataSeparator, DicomInfo, Gnomon, PlaneGeometryIntersection, Ruler, SceneView, SliceOrientationMarkers, SliceScaleBar, TextBox, ViewManager, SoVolumeClippingGroup, SoVolumeGroup, and SoVolumeMaskGroup.

◆ insertChild()

virtual void SoGroup::insertChild	(	SoNode *	child,
		int	newChildIndex
	)

virtual

Adds a child so that it becomes the one with the given index.

◆ removeAllChildren()

virtual void SoGroup::removeAllChildren ( )

virtual

Removes all children from group.

◆ removeChild() [1/2]

virtual void SoGroup::removeChild ( int index )

virtual

Removes child with given index from group.

◆ removeChild() [2/2]

virtual void SoGroup::removeChild ( SoNode * child )

inlinevirtual

Removes first instance of given child from group.

Definition at line 183 of file SoGroup.h.

◆ replaceChild() [1/2]

virtual void SoGroup::replaceChild	(	int	index,
		SoNode *	newChild
	)

virtual

Replaces child with given index with new child.

◆ replaceChild() [2/2]

virtual void SoGroup::replaceChild	(	SoNode *	oldChild,
		SoNode *	newChild
	)

inlinevirtual

Replaces first instance of given child with new child.

Definition at line 203 of file SoGroup.h.

Member Data Documentation

◆ boundingBoxIgnoring

SoSFBool SoGroup::boundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

Default is FALSE.

Definition at line 130 of file SoGroup.h.

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

Inventor/nodes/SoGroup.h

Open Inventor Release 2024.1.3

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

Constructor & Destructor Documentation

◆ SoGroup() [1/2]

◆ SoGroup() [2/2]

Member Function Documentation

◆ addChild()

◆ findChild()

◆ getChild()

◆ getClassTypeId()

◆ getNumChildren()

◆ getTypeId()

◆ insertChild()

◆ removeAllChildren()

◆ removeChild() [1/2]

◆ removeChild() [2/2]

◆ replaceChild() [1/2]

◆ replaceChild() [2/2]

Member Data Documentation

◆ boundingBoxIgnoring