SceneExaminer Class Reference
[Nodes]

Tool class for building a basic interactive OpenInventor application with scene "examiner" viewing behavior. More...

#include <Inventor/ViewerComponents/nodes/SceneExaminer.h>

Inheritance diagram for SceneExaminer:

List of all members.

Public Types
enum	InteractionMode {   NAVIGATION,   SELECTION }
enum	NavigationMode {   ORBIT,   PLANE }
Public Member Functions
	SceneExaminer ()
virtual	~SceneExaminer ()
void	enableSelection (bool enabled)
bool	isSelectionEnabled ()
void	enableZoom (bool enabled)
bool	isZoomEnabled ()
void	enablePan (bool enabled)
bool	isPanEnabled ()
void	enableOrbit (bool enabled)
bool	isOrbitEnabled ()
void	enableRotate (bool enabled)
bool	isRotateEnabled ()
void	enableSeek (bool enabled)
bool	isSeekEnabled ()
void	setNavigationMode (SceneExaminer::NavigationMode mode)
bool	isSpinEnabled () const
void	enableSpin (bool enable)
SceneExaminer::NavigationMode	getNavigationMode ()
void	setInteractionMode (SceneExaminer::InteractionMode mode)
SceneExaminer::InteractionMode	getInteractionMode ()
virtual void	setCameraMode (SceneInteractor::CameraMode mode)
void	setSeekMode (bool onOrOff)
void	addInteractionModeListener (SiInteractionModeListener *listener)
void	removeInteractionModeListener (SiInteractionModeListener *listener)

---

Detailed Description

Tool class for building a basic interactive OpenInventor application with scene "examiner" viewing behavior.

The SceneExaminer is an extension of the SceneInteractor node that provides camera and headlight manipulations like panning, zooming and orbiting similar to the classic Open Inventor viewer classes SoXtExaminerViewer (NavigationMode ORBIT) and SoXtPlaneViewer (NavigationMode PLANE).

Similar behavior includes a 'headlight', i.e. an SoDirectionalLight node automatically aligned with the camera's view direction.

The SceneExaminer is not directly comparable with a classic OpenInventor viewer as it does not provide any GUI (no buttons, no popup menu) and fewer interactive features (no animation). However it does provide a touch event handler that allows manipulating a scene on a touch device.

See parent class SceneInteractor for more details about the structure of the internal scene graph.

The SceneExaminer uses an instance of SoCameraInteractor to manipulate the camera in response to OpenInventor events.

Notes:

• Window system integration
  The SceneExaminer needs a component that integrates the Open Inventor 3D rendering window with the native window system. System dependent tasks include creating a window, placing the window in the application's user interface, initializing OpenGL and processing the native event/message loop. System independent support for this is provided by the SoRenderAreaCore class. Example components are provided for various window systems, for example, WinRenderArea for native Microsoft Windows.

• Event handling
  The SceneExaminer needs a component that builds OpenInventor events (SoEvent) from native system events. System independent support for this is provided by the SoEventBuilder class. Example components are provided for various window systems, for example, WinEventToSoEvent for native Microsoft Windows.

• Library
  A basic version of SceneExaminer is a supported part of the Open Inventor API and a prebuilt library is provided.

• Source code
  The basic version of SceneExaminer is also provided as source code to allow applications to customize and build their own interactive tool class.
  See $OIVHOME/source/Inventor/ViewerComponents/nodes.

• Interaction Modes
  Similar to the classic Open Inventor viewer classes, SceneExaminer is either in NAVIGATION mode (the default, similar to viewing mode) or SELECTION mode. The user must press the ESC key to toggle between interaction modes. (Of course this behavior can be modified or replaced by implementing an alternate version of SceneExaminer.) In navigation mode, Open Inventor events are automatically handled to modify the camera as defined in the Usage section below. Events that are defined in this section are not sent to the application scene graph, but all other events are sent to the application scene graph. Also specific viewing behaviors can be disabled as needed (see for example enableZoom()). In selection mode, all events are sent to the application scene graph.

• Scene graph
  The application scene graph should be the last child of the SceneExaminer. The initial application scene graph can be added by simply calling the inherited method addChild(). But note that if you need to replace the application scene graph, for example loading a new data set, do not call removeAllChildren(). That would also remove the SceneExaminer's camera, headlight and event handler nodes. Add an SoSeparator to the SceneExaminer to serve as the "scene graph holder", then add and remove the application scene graph from this node.

• Clip planes
  SceneExaminer automatically adjusts the 'near' and 'far' clipping planes when events modifying the camera are handled. This adjustment, based on the bounding box of the scene, ensures that shapes will not be clipped as the camera orbits and also that depth buffer precision is maximized. This adjustment is only done in InteractionMode NAVIGATION and can be disabled by setting the environment variable "OIV_SCENE_EXAMINER_AUTO_CLIPPING_PLANES" to false.
  Note: Updating clipping planes after a camera move can be not sufficient. If the scene graph is modified or if a dragger or a rendered shape is moved, they can disappear or become partially clipped. A classic implementation of a render area must adjust clipping planes before each rendering by calling the provided method adjustClippingPlanes(). See render area's implementations available in $OIVHOME/source/Inventor/gui folder for examples of adjustClippingPlanes use.

• Compatibility
  Please note that some interaction behaviors are different than the classic Open Inventor viewer classes (e.g. SoXtExaminerViewer):
  
  
  • In Orbit mode: Left Mouse + Shift: does : Zoom in/out.
  • In Plane mode: Left Mouse + Middle Mouse or Left Mouse + Shift: does : Roll the scene.
  • The Mouse wheel in both modes performs a dolly relative to the cursor position, not the center of the viewport.
    
    
  • The classic Alt key behavior is not implemented. This key is reserved for application use.
  • The Right Mouse button does not display a popup menu. This button is reserved for application use.

USAGE

• Orbit mode:
  
  
  • With a mouse:
    • Left Mouse: Rotate the scene or seek to point if seek mode is activated.
    • Middle Mouse or Left Mouse + Ctrl: Pan the scene.
    • Left Mouse + Middle Mouse or Middle Mouse + Ctrl or Left Mouse + Shift: Zoom in/out.
    • Mouse Wheel: Zoom in/out (zoom center is the mouse cursor location).
    • Escape key: Switch between navigation mode and selection mode.
    • S key: Activate/Deactivate seek mode.
      
      
  • With a touchscreen:
    • 1 finger: Rotate the scene.
    • 2 fingers: Rotate the scene on the screen plane, zoom in/out and pan (rotation and zoom center are located between the two fingers).
    • Double tap: Seek to the point located by the finger.
    • Long tap: Enable/Disable selection mode.
      
      
  • Spin animation:
    When spin animation is enabled (enableSpin()), press mouse button / touch, drag in the direction of desired spin and release mouse button / touch while still dragging.
    
    
• Plane mode:
  
  
  • With a mouse:
    • Left Mouse: Zoom in/out or seek to point if seek mode is activated.
    • Middle Mouse or Left Mouse + Ctrl: Pan the scene.
    • Left Mouse + Middle Mouse or Middle Mouse + Ctrl or Left Mouse + Shift: Roll the scene.
    • Mouse Wheel: Zoom in/out (zoom center is the mouse cursor location).
    • Escape key: Switch between navigation mode and selection mode.
    • S key: Activate/Deactivate seek mode.
      
      
  • With a touchscreen:
    • 1 finger: Pan the scene.
    • 2 fingers: Rotate the scene on the screen plane, zoom in/out and pan (rotation and zoom center are located between the two fingers).
    • Double tap: Seek to the point located by the finger.
    • Long tap: Enable/Disable selection mode.

SEE ALSO

SceneInteractor, SceneOrbiter, SoCameraInteractor, SiInteractionModeListener

---

Member Enumeration Documentation

enum SceneExaminer::InteractionMode

Interaction Mode (navigation or selection).

Enumerator:

NAVIGATION
SELECTION

enum SceneExaminer::NavigationMode

Navigation Mode.

Enumerator:

ORBIT
PLANE

---

Constructor & Destructor Documentation

SceneExaminer::SceneExaminer

(

)

Constructor.

virtual SceneExaminer::~SceneExaminer

(

)

[virtual]

Destructor.

---

Member Function Documentation

void SceneExaminer::addInteractionModeListener

(

SiInteractionModeListener *

listener

)

Add interaction listener.

void SceneExaminer::enableOrbit

(

bool

enabled

)

Enable or disable camera orbiting.

Default is true.

void SceneExaminer::enablePan

(

bool

enabled

)

Enable or disable camera panning.

Default is true.

void SceneExaminer::enableRotate

(

bool

enabled

)

Enable or disable camera rotation.

Default is true.

void SceneExaminer::enableSeek

(

bool

enabled

)

Enable or disable seek.

Default is true.

void SceneExaminer::enableSelection

(

bool

enabled

)

Enable or disable selection mode.

Default is true.

void SceneExaminer::enableSpin

(

bool

enable

)

Enables or disables the spin animation.

Default is false.

When spin animation is enabled, the user can use the mouse to start a spin animation by "flinging". Press the mouse button / touch, drag in the direction of desired spin and release the mouse button / touch while still dragging. This is equivalent to spin animation in the classic viewer classes, e.g. SoWinExaminerViewer.

void SceneExaminer::enableZoom

(

bool

enabled

)

Enable or disable zoom.

Default is true.

SceneExaminer::InteractionMode SceneExaminer::getInteractionMode

(

)

Returns the current interaction mode.

SceneExaminer::NavigationMode SceneExaminer::getNavigationMode

(

)

Returns the current navigation mode.

bool SceneExaminer::isOrbitEnabled

(

)

Returns if camera orbiting is enabled.

bool SceneExaminer::isPanEnabled

(

)

Returns if camera panning is enabled.

bool SceneExaminer::isRotateEnabled

(

)

Returns if camera rotation is enabled.

bool SceneExaminer::isSeekEnabled

(

)

Returns if seek is enabled.

bool SceneExaminer::isSelectionEnabled

(

)

Returns if selection is enabled.

bool SceneExaminer::isSpinEnabled

(

)

const

Returns true if spin animation is enabled.

bool SceneExaminer::isZoomEnabled

(

)

Returns if zoom is enabled.

void SceneExaminer::removeInteractionModeListener

(

SiInteractionModeListener *

listener

)

Remove interaction listener.

virtual void SceneExaminer::setCameraMode

(

SceneInteractor::CameraMode

mode

)

[virtual]

Select perspective or orthographic camera.

Default is perspective.

Reimplemented from SceneInteractor.

void SceneExaminer::setInteractionMode

(

SceneExaminer::InteractionMode

mode

)

Set interaction mode to navigation or selection.

Default is NAVIGATION.

void SceneExaminer::setNavigationMode

(

SceneExaminer::NavigationMode

mode

)

Set navigation mode.

Default is ORBIT.

void SceneExaminer::setSeekMode

(

bool

onOrOff

)

Set the interaction into or out off seek mode (default is off).

---

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

• Inventor/ViewerComponents/nodes/SceneExaminer.h