Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all 
NAME
SoVRMLGroup -
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:
SYNOPSIS
#include <Inventor/VRMLnodes/SoVRMLGroup.h>
Inherits SoVRMLParent.
Inherited by SoVRMLCollision, and SoVRMLTransform.
Public Types
enum CacheEnabled { OFF, ON, AUTO }
Public Member Functions
virtual SoType getTypeId (void) const
Returns the type identification of an object derived from a class inheriting SoBase.
This is used for run-time type checking and 'downward' casting.
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)
Static Public Member Functions
static SoType getClassTypeId (void)
static void initClass (void)
static void setNumRenderCaches (int num)
static int getNumRenderCaches (void)
Public Attributes
SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling
SoSFVec3f bboxCenter
SoSFVec3f bboxSize
Protected Member Functions
virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLGroup ()
virtual SbBool cullTest (SoState *state)
Static Protected Member Functions
static const SoFieldData ** getFieldDataPtr (void)
Static Protected Attributes
static int numRenderCaches = 2
Additional Inherited Members
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/x3d/specifications/vrml/ISO-
IEC-14772-VRML97/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/x3d/specifications/vrml/ISO-
IEC-14772-VRML97/part1/concepts.html#4.6.4).
Constructor & Destructor Documentation
SoVRMLGroup::SoVRMLGroup (void)
Constructor.
SoVRMLGroup::SoVRMLGroup (intnumchildren)
Constructor. numchildren is the expected number of children.
SoVRMLGroup::~SoVRMLGroup () [protected], [virtual]
Destructor.
Member Function Documentation
SoType SoVRMLGroup::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
}
}
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.
Reimplemented from SoVRMLParent.
Reimplemented in SoVRMLCollision, and SoVRMLTransform.
const SoFieldData * SoVRMLGroup::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 SoVRMLParent.
Reimplemented in SoVRMLCollision, and SoVRMLTransform.
void SoVRMLGroup::setNumRenderCaches (intnum) [static]
Set the maximum number of render caches per group node.
int SoVRMLGroup::getNumRenderCaches (void) [static]
Returns the maximum number of render caches per group node.
void SoVRMLGroup::doAction (SoAction *action) [virtual]
This function performs the typical operation of a node for any action.
Reimplemented from SoVRMLParent.
Reimplemented in SoVRMLTransform.
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.
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 who wants to throw geometry primitives at OpenGL overrides this method.
Reimplemented from SoGroup.
Reimplemented in SoVRMLCollision.
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 calculates their bounding box also overrides this
method to change the relevant state variables.
Reimplemented from SoGroup.
Reimplemented in SoVRMLTransform.
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.
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 overrides this
method.
Reimplemented from SoNode.
Reimplemented in SoVRMLTransform.
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.
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.
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 calculates their primitive count also overrides this
method to change the relevant state variables.
Reimplemented from SoVRMLParent.
Reimplemented in SoVRMLTransform.
void SoVRMLGroup::audioRender (SoAudioRenderAction *action) [virtual]
Action method for SoAudioRenderAction.
Does common processing for SoAudioRenderAction action instances.
Reimplemented from SoGroup.
Reimplemented in SoVRMLTransform.
void SoVRMLGroup::GLRenderBelowPath (SoGLRenderAction *action) [virtual]
Implements the SoAction::BELOW_PATH traversal method for the rendering action.
Reimplemented from SoNode.
Reimplemented in SoVRMLTransform.
void SoVRMLGroup::GLRenderInPath (SoGLRenderAction *action) [virtual]
Implements the SoAction::IN_PATH traversal method for the rendering action.
Reimplemented from SoNode.
Reimplemented in SoVRMLTransform.
void SoVRMLGroup::GLRenderOffPath (SoGLRenderAction *action) [virtual]
Implements the SoAction::OFF_PATH traversal method for the rendering action.
Reimplemented from SoNode.
void SoVRMLGroup::notify (SoNotList *l) [virtual]
Notifies all auditors for this instance when changes are made.
Reimplemented from SoVRMLParent.
Reimplemented in SoVRMLTransform, and SoVRMLCollision.
SbBool SoVRMLGroup::cullTest (SoState *state) [protected], [virtual]
Returns TRUE if children can be culled.
Author
Generated automatically by Doxygen for Coin from the source code.