http://www.sim.no/ http://www.coin3d.org/

---

SoViewerNavigationMode Class Reference
[Node Classes]

#include <Inventor/nodes/SoViewerNavigationMode.h>

Inheritance diagram for SoViewerNavigationMode:

List of all members.

---

Detailed Description

Node for setting the default viewer navigation mode for a scene graph.

This node provides a way to hint to the SoSceneManager (or SoEventManager) which navigation mode you want to use with a scene graph.

The node must be placed before the first camera in the scene graph, or it will not be found by the system that searches for this node.

Currently, the mode field of the node is not monitored for dynamic changes, so updating it will not change the viewer mode. Doing this is a possibility for future enhancement.

Public Member Functions
virtual SoType	getTypeId (void) const
	SoViewerNavigationMode (void)
Static Public Member Functions
static SoType	getClassTypeId (void)
static void	initClass (void)
Public Attributes
SoSFString	mode
Protected Member Functions
virtual const SoFieldData *	getFieldData (void) const
virtual	~SoViewerNavigationMode (void)
Static Protected Member Functions
static const SoFieldData **	getFieldDataPtr (void)

---

Constructor & Destructor Documentation

SoViewerNavigationMode::SoViewerNavigationMode

(

void

)

Constructor.

SoViewerNavigationMode::~SoViewerNavigationMode

(

void

)

[protected, virtual]

Destructor.

---

Member Function Documentation

SoType SoViewerNavigationMode::getClassTypeId

(

void

)

[static]

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

Reimplemented from SoNode.

SoType SoViewerNavigationMode::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.

Implements SoBase.

const SoFieldData ** SoViewerNavigationMode::getFieldDataPtr

(

void

)

[static, protected]

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

Reimplemented from SoNode.

const SoFieldData * SoViewerNavigationMode::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 SoFieldContainer.

void SoViewerNavigationMode::initClass

(

void

)

[static]

Static class initializer. It is called from SoNavigation::init, so there should be no need to call this directly.

Reimplemented from SoNode.

---

Member Data Documentation

SoSFString SoViewerNavigationMode::mode

The mode field is used for setting the name of the desired mode. If the mode is not found in the system, no mode will be used.

The builtin modes are currently limited to "examiner", "panner", "zoomer", and "rotater". In addition, application developers can extend the list with their own custom modes.

---

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

• SoViewerNavigationMode.h
• SoViewerNavigationMode.cpp

---

Copyright © 1998-2008 by Kongsberg SIM. All rights reserved.