SoTVizCompass Class Reference
[TerrainViz]

TerrainViz Class for displaying an orientation compass. More...

#include <TerrainViz/viewer/SoTVizCompass.h>

Inheritance diagram for SoTVizCompass:
SoTVizNavigationToolBase

List of all members.

Public Types

enum  predefinedTerrainCompass {
  TERRAINCOMPASS_DEFAULT,
  TERRAINCOMPASS_REVERSED,
  TERRAINCOMPASS_TRANSPARENT
}

Public Member Functions

 SoTVizCompass (SoTVizViewer &viewer)
virtual ~SoTVizCompass ()
virtual void loadFile (const char *fileName)
virtual void loadPredefined (predefinedTerrainCompass)
virtual void notifyOrientation (float newOrientation)

Detailed Description

TerrainViz Class for displaying an orientation compass.

This class is used to display a compass in SoTVizViewer. Three different compass designs are provided. The models are loaded from .iv files.

SEE ALSO

SoTVizNavigationToolBase, SoTVizNavigationTool, SoTVizViewer

Deprecated:

Deprecated since Open Inventor 9500
No longer supported.

Member Enumeration Documentation

Enumerator:
TERRAINCOMPASS_DEFAULT 

Default compass.

TERRAINCOMPASS_REVERSED 

Reversed compass.

TERRAINCOMPASS_TRANSPARENT 

Transparent compass.


Constructor & Destructor Documentation

SoTVizCompass::SoTVizCompass ( SoTVizViewer viewer  ) 

Constructor.

Needs a reference to SoTVizViewer to interact with.

virtual SoTVizCompass::~SoTVizCompass (  )  [virtual]

Destructor.


Member Function Documentation

virtual void SoTVizCompass::loadFile ( const char *  fileName  )  [virtual]

Method to load the .iv file representing the compass.

The file root must contain two separator nodes, one named "CompassFixedPart" and the other named "CompassMobilePart" for the two parts of the compass. A rotation node is then internally inserted and centered to control the mobile part.

Implements SoTVizNavigationToolBase.

virtual void SoTVizCompass::loadPredefined ( predefinedTerrainCompass   )  [virtual]

Loads a predefined tool.

virtual void SoTVizCompass::notifyOrientation ( float  newOrientation  )  [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 from SoTVizNavigationToolBase.


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

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/