H3D::ViewpointGroup Class Reference
[X3D node classes.]

ViewpointGroup is used to control display of viewpoints on the viewpoint list. More...

#include <H3D/ViewpointGroup.h>

Inheritance diagram for H3D::ViewpointGroup:

Inheritance graph

List of all members.

Public Member Functions

 ViewpointGroup (Inst< SFSetBind > _set_bind=0, Inst< SFVec3f > _centerOfRotation=0, Inst< SFString > _description=0, Inst< SFBool > _jump=0, Inst< SFNode > _metadata=0, Inst< SFOrientation > _orientation=0, Inst< SFPosition > _position=0, Inst< SFBool > _retainUserOffsets=0, Inst< SFTime > _bindTime=0, Inst< SFBool > _isBound=0, Inst< SFMatrix4f > _accForwardMatrix=0, Inst< SFMatrix4f > _accInverseMatrix=0, Inst< SFVec3f > _center=0, Inst< MFChild > _children=0, Inst< SFBool > _displayed=0, Inst< SFVec3f > _size=0)
 Constructor.
virtual void traverseSG (TraverseInfo &ti)
 Traverse the scenegraph.
virtual void toStackTop ()
 Move this instance to the stack top.
virtual void removeFromStack ()
 Remove the bindable node from the stack.
bool containsViewpoint (X3DViewpointNode *vp) const
 Returns true if the given viewpoint is in the children field any ViewpointGroups in the the children field.

Public Attributes

auto_ptr< SFVec3fcenter
 The center field provides a position offset from origin of local coordinate system.
auto_ptr< MFChildchildren
 The children field is a sequence of nodes of type X3DViewpointNode.
auto_ptr< SFBooldisplayed
 The displayed field determines whether this ViewpointGroup is displayed in the current viewpoint list.
auto_ptr< SFVec3fsize
 The size field provides the size of a proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodedatabase for this node.


Detailed Description

ViewpointGroup is used to control display of viewpoints on the viewpoint list.

Use of ViewpointGroup allows a viewpoint list to have a tree structure, similar to a bookmark list.

The children field is a sequence of nodes of type X3DViewpointNode.

The description field provides a simple description or navigation hint to be displayed for this ViewpointGroup.

The displayed field determines whether this ViewpointGroup is displayed in the current viewpoint list.

The center and size fields are defined identically as the corresponding ProximitySensor definitions. The center field provides a position offset from origin of local coordinate system. The size field provides the size of a proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list. A size field of 0 0 0 specifies that the ViewpointGroup is always usable and displayed.

The retainUserOffsets field specifies whether the user is returned to the originally defined viewpoint position/orientation after local navigation.


Member Function Documentation

bool ViewpointGroup::containsViewpoint ( X3DViewpointNode vp  )  const

Returns true if the given viewpoint is in the children field any ViewpointGroups in the the children field.

References children.

void ViewpointGroup::traverseSG ( TraverseInfo ti  )  [virtual]

Traverse the scenegraph.

Check changes of viewpoint position since last scene graph traversal.

Parameters:
ti The TraverseInfo object containing information about the traversal.

Reimplemented from H3D::X3DViewpointNode.

References center, displayed, H3D::X3DViewpointNode::getActive(), size, and H3D::X3DViewpointNode::totalPosition.


Member Data Documentation

The center field provides a position offset from origin of local coordinate system.

Access type: inputOutput
Default value: 0 0 0

Referenced by traverseSG(), and ViewpointGroup().

The children field is a sequence of nodes of type X3DViewpointNode.

Access type: inputOutput
Default value: NULL

Referenced by containsViewpoint().

The displayed field determines whether this ViewpointGroup is displayed in the current viewpoint list.

Access type: inputOutput
Default value: TRUE

Referenced by traverseSG(), and ViewpointGroup().

The size field provides the size of a proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list.

A size field of 0 0 0 specifies that the ViewpointGroup is always usable and displayed.

Access type: inputOutput
Default value: TRUE

Referenced by traverseSG(), and ViewpointGroup().


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

Generated on Fri Nov 7 10:31:22 2008 for H3D API by  doxygen 1.5.7