SoTVizNavigationToolBase Class Reference
[TerrainViz]

Base class for SoTVizViewer navigation tools. More...

#include <TerrainViz/viewer/SoTVizNavigationToolBase.h>

Inheritance diagram for SoTVizNavigationToolBase:

List of all members.

Public Member Functions
	SoTVizNavigationToolBase ()
virtual	~SoTVizNavigationToolBase ()
virtual void	loadFile (const char *fileName)=0
virtual void	enableMouseMoveAndResize (SbBool onOff)
virtual SbBool	isMouseMoveAndResizeEnabled () const
virtual void	enableCustomInteraction (SbBool onOff)
virtual SbBool	isCustomInteractionEnabled () const
virtual void	setOrigin (SbVec2f &newOrigin)
virtual SbVec2f	getOrigin () const
virtual void	setSize (float newSize)
virtual float	getSize () const
virtual void	notifyOrientation (float newOrientation)
virtual void	notifyElevation (float newRelativeElevation, float newGroundElevation, SoTVizCameraManager::lengthUnits newLengthUnit)
virtual void	notifySpeed (float newSpeed, SoTVizViewer::speedUnits newSpeedUnit)
virtual void	notifyPosition (SbVec3f &newPosition)

---

Detailed Description

Base class for SoTVizViewer navigation tools.

SoTVizNavigationToolBase class is the base class of all viewer navigation tools. It manages common items such as render area position and size, and event processing.

SEE ALSO

SoTVizNavigationTool, SoTVizViewer

Deprecated:

Deprecated since Open Inventor 9500
No longer supported.

---

Constructor & Destructor Documentation

SoTVizNavigationToolBase::SoTVizNavigationToolBase

(

)

Constructor.

virtual SoTVizNavigationToolBase::~SoTVizNavigationToolBase

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void SoTVizNavigationToolBase::enableCustomInteraction

(

SbBool

onOff

)

[virtual]

Enables/disables custom tool interaction.

virtual void SoTVizNavigationToolBase::enableMouseMoveAndResize

(

SbBool

onOff

)

[virtual]

Allows move and resize to be deactivated independently.

virtual SbVec2f SoTVizNavigationToolBase::getOrigin

(

)

const [virtual]

Returns origin of the tool.

virtual float SoTVizNavigationToolBase::getSize

(

)

const [virtual]

Returns size of the tool (between 0 an 1, normalized coordinates).

virtual SbBool SoTVizNavigationToolBase::isCustomInteractionEnabled

(

)

const [virtual]

Returns TRUE if custom tool interaction is enabled.

virtual SbBool SoTVizNavigationToolBase::isMouseMoveAndResizeEnabled

(

)

const [virtual]

Returns TRUE if move and resize can be deactivated independently.

virtual void SoTVizNavigationToolBase::loadFile

(

const char *

fileName

)

[pure virtual]

Loads the .iv file representing the tool.

Implemented in SoTVizAltimeterSpeedometer, and SoTVizCompass.

void SoTVizNavigationToolBase::notifyElevation	(	float	newRelativeElevation,
		float	newGroundElevation,
		SoTVizCameraManager::lengthUnits	newLengthUnit
	)			[inline, virtual]

This method is called by SoTVizViewer to notify the tool about new relative elevation, ground elevation, and length unit values.

Reimplemented in SoTVizAltimeterSpeedometer.

void SoTVizNavigationToolBase::notifyOrientation

(

float

newOrientation

)

[inline, virtual]

This method is called by SoTVizViewer to notify the tool about new orientation values (where the orientation is the rotation in radians around the north direction).

Reimplemented in SoTVizCompass.

void SoTVizNavigationToolBase::notifyPosition

(

SbVec3f &

newPosition

)

[inline, virtual]

This method is called by SoTVizViewer to notify the tool about new camera position values.

void SoTVizNavigationToolBase::notifySpeed	(	float	newSpeed,
		SoTVizViewer::speedUnits	newSpeedUnit
	)			[inline, virtual]

This method is called by SoTVizViewer to notify the tool about new camera speed and speed unit values.

Reimplemented in SoTVizAltimeterSpeedometer.

virtual void SoTVizNavigationToolBase::setOrigin

(

SbVec2f &

newOrigin

)

[virtual]

Sets origin of the tool.

virtual void SoTVizNavigationToolBase::setSize

(

float

newSize

)

[virtual]

Sets size of the tool (between 0 an 1, normalized coordinates).

---

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

• TerrainViz/viewer/SoTVizNavigationToolBase.h