The SoVRMLGroup class is used for grouping VRML nodes. More...

#include <Inventor/VRMLnodes/SoVRMLGroup.h>

Inheritance diagram for SoVRMLGroup:

Public Types
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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

Public Member Functions
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)

virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

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=FALSE) const

virtual void	grabEventsSetup (void)

virtual void	grabEventsCleanup (void)

virtual void	startNotify (void)

SbUniqueId	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=FALSE)

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

void	get (SbString &fielddata, SoOutput *out)

virtual SbBool	validateNewFieldValue (SoField field, void newval)

SbBool	getIsBuiltIn (void) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) 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
	Returns `TRUE` if the type of this object is either of the same type or inherited from type. More...

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
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 SbUniqueId	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	cleanupClass (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)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

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 input, SoBase &base, SoType expectedtype)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

static SbBool	getTraceRefs (void)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static SbBool	readRoute (SoInput *input)

Public Attributes
SoSFEnum	renderCaching

SoSFEnum	boundingBoxCaching

SoSFEnum	renderCulling

SoSFEnum	pickCulling

SoSFVec3f	bboxCenter

SoSFVec3f	bboxSize

Public Attributes inherited from SoVRMLParent
SoMFNode	children

Protected Member Functions
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)

virtual SoNotRec	createNotRec (void)

void	setOperation (const SoNotRec::OperationType opType=SoNotRec::UNSPECIFIED, const SoNode cc=NULL, const SoNode pc=NULL, const int ci=-1)

Protected Member Functions inherited from SoNode
	SoNode (void)

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~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 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
static int	numRenderCaches = 2

Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId = 1

static int	nextActionMethodIndex = 0

Additional Inherited Members
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
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Detailed Description

The SoVRMLGroup class is used for grouping VRML nodes.

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/documents/specifications/14772/V2.0/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/documents/specifications/14772/V2.0/part1/concepts.html#4.6.4).

Constructor & Destructor Documentation

◆ SoVRMLGroup() [1/2]

SoVRMLGroup::SoVRMLGroup ( void )

Constructor.

◆ SoVRMLGroup() [2/2]

SoVRMLGroup::SoVRMLGroup ( int numchildren )

Constructor. numchildren is the expected number of children.

◆ ~SoVRMLGroup()

SoVRMLGroup::~SoVRMLGroup ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

SoType SoVRMLGroup::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

◆ getTypeId()

SoType SoVRMLGroup::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoVRMLParent.

Reimplemented in SoVRMLCollision, and SoVRMLTransform.

◆ getFieldDataPtr()

const SoFieldData ** SoVRMLGroup::getFieldDataPtr ( void )

staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns the SoFieldData class which holds information about fields in this node.

◆ getFieldData()

const SoFieldData * SoVRMLGroup::getFieldData ( void ) const

protectedvirtual

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

Reimplemented from SoVRMLParent.

Reimplemented in SoVRMLCollision, and SoVRMLTransform.

◆ initClass()

void SoVRMLGroup::initClass ( void )

static

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

◆ setNumRenderCaches()

void SoVRMLGroup::setNumRenderCaches ( int num )

static

Set the maximum number of render caches per group node.

◆ getNumRenderCaches()

int SoVRMLGroup::getNumRenderCaches ( void )

static

Returns the maximum number of render caches per group node.

◆ doAction()

void SoVRMLGroup::doAction ( SoAction * action )

virtual

This function performs the typical operation of a node for any action.

Reimplemented from SoVRMLParent.

Reimplemented in SoVRMLTransform.

◆ callback()

void SoVRMLGroup::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 SoGroup.

Reimplemented in SoVRMLTransform.

◆ GLRender()

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 want to throw geometry primitives at OpenGL override this method.

Reimplemented from SoGroup.

Reimplemented in SoVRMLCollision.

◆ getBoundingBox()

void SoVRMLGroup::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 calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoGroup.

Reimplemented in SoVRMLTransform.

◆ getMatrix()

void SoVRMLGroup::getMatrix ( SoGetMatrixAction * action )

virtual

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoGroup.

Reimplemented in SoVRMLTransform.

◆ rayPick()

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 override this method.

Reimplemented from SoNode.

Reimplemented in SoVRMLTransform.

◆ search()

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.

See also: SoSearchAction

Reimplemented from SoVRMLParent.

◆ write()

void SoVRMLGroup::write ( SoWriteAction * action )

virtual

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoVRMLParent.

◆ getPrimitiveCount()

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 calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoVRMLParent.

Reimplemented in SoVRMLTransform.

◆ audioRender()

void SoVRMLGroup::audioRender ( SoAudioRenderAction * action )

virtual

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances.

Reimplemented from SoGroup.

Reimplemented in SoVRMLTransform.

◆ GLRenderBelowPath()

void SoVRMLGroup::GLRenderBelowPath ( SoGLRenderAction * action )

virtual

Implements the SoAction::BELOW_PATH traversal method for the rendering action.

Reimplemented from SoNode.

Reimplemented in SoVRMLTransform.

◆ GLRenderInPath()

void SoVRMLGroup::GLRenderInPath ( SoGLRenderAction * action )

virtual

Implements the SoAction::IN_PATH traversal method for the rendering action.

Reimplemented from SoNode.

Reimplemented in SoVRMLTransform.

◆ GLRenderOffPath()

void SoVRMLGroup::GLRenderOffPath ( SoGLRenderAction * action )

virtual

Implements the SoAction::OFF_PATH traversal method for the rendering action.

Reimplemented from SoNode.

◆ notify()

void SoVRMLGroup::notify ( SoNotList * l )

virtual

Notifies all auditors for this instance when changes are made.

Reimplemented from SoVRMLParent.

Reimplemented in SoVRMLTransform, and SoVRMLCollision.

◆ cullTest()

SbBool SoVRMLGroup::cullTest ( SoState * state )

protectedvirtual

Returns TRUE if children can be culled.

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

SoVRMLGroup.h
Group.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoVRMLGroup() [1/2]

◆ SoVRMLGroup() [2/2]

◆ ~SoVRMLGroup()

Member Function Documentation

◆ getClassTypeId()

◆ getTypeId()

◆ getFieldDataPtr()

◆ getFieldData()

◆ initClass()

◆ setNumRenderCaches()

◆ getNumRenderCaches()

◆ doAction()

◆ callback()

◆ GLRender()

◆ getBoundingBox()

◆ getMatrix()

◆ rayPick()

◆ search()

◆ write()

◆ getPrimitiveCount()

◆ audioRender()

◆ GLRenderBelowPath()

◆ GLRenderInPath()

◆ GLRenderOffPath()

◆ notify()

◆ cullTest()