Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SceneExaminer Class Reference

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:

Public Types

enum  InteractionMode {
  NAVIGATION ,
  SELECTION
}
 Interaction Mode (navigation or selection) More...
 
enum  NavigationMode {
  ORBIT ,
  PLANE
}
 Navigation Mode. More...
 
- Public Types inherited from SceneInteractor
enum  CameraMode {
  PERSPECTIVE ,
  ORTHOGRAPHIC
}
 Type of camera (perspective or orthographic) More...
 
- Public Types inherited from SoSeparator
enum  CacheEnabled {
  OFF ,
  ON ,
  AUTO
}
 Possible values for caching. More...
 
enum  FastEditing {
  DISABLE = 0x01 ,
  KEEP_ZBUFFER = 0x02 ,
  CLEAR_ZBUFFER = 0x03
}
 Fast editing policy enumeration values. More...
 

Public Member Functions

 SceneExaminer ()
 Constructor.
 
virtual ~SceneExaminer ()
 Destructor.
 
void enableSelection (bool enabled)
 Enable or disable selection mode.
 
bool isSelectionEnabled ()
 Returns if selection is enabled.
 
void enableZoom (bool enabled)
 Enable or disable zoom.
 
bool isZoomEnabled ()
 Returns if zoom is enabled.
 
void enablePan (bool enabled)
 Enable or disable camera panning.
 
bool isPanEnabled ()
 Returns if camera panning is enabled.
 
void enableOrbit (bool enabled)
 Enable or disable camera orbiting.
 
bool isOrbitEnabled ()
 Returns if camera orbiting is enabled.
 
void enableRotate (bool enabled)
 Enable or disable camera rotation.
 
bool isRotateEnabled ()
 Returns if camera rotation is enabled.
 
void enableSeek (bool enabled)
 Enable or disable seek.
 
bool isSeekEnabled ()
 Returns if seek is enabled.
 
void setNavigationMode (SceneExaminer::NavigationMode mode)
 Set navigation mode.
 
bool isSpinEnabled () const
 Returns true if spin animation is enabled.
 
void enableSpin (bool enable)
 Enables or disables the spin animation.
 
SceneExaminer::NavigationMode getNavigationMode ()
 Returns the current navigation mode.
 
void setInteractionMode (SceneExaminer::InteractionMode mode)
 Set interaction mode to navigation or selection.
 
SceneExaminer::InteractionMode getInteractionMode ()
 Returns the current interaction mode.
 
virtual void setCameraMode (SceneInteractor::CameraMode mode)
 Select perspective or orthographic camera.
 
void setSeekMode (bool onOrOff)
 Set the interaction into or out off seek mode (default is off).
 
void addInteractionModeListener (SiInteractionModeListener *listener)
 Add interaction listener.
 
void removeInteractionModeListener (SiInteractionModeListener *listener)
 Remove interaction listener.
 
- Public Member Functions inherited from SceneInteractor
 SceneInteractor ()
 Constructor.
 
virtual ~SceneInteractor ()
 Destructor.
 
void adjustClippingPlanes (const SbViewportRegion &vpRegion)
 Adjust near and far clipping planes to minimize clipping of objects in the scene.
 
void viewAll (const SbViewportRegion &viewport)
 Move the camera to view the scene defined by the given path.
 
void viewAxis (const SbVec3f &direction, const SbVec3f &up)
 Moves the camera to be aligned with the given direction vector while keeping the "up" direction of the camera parallel to the specified up vector.
 
SoCameraInteractorgetCameraInteractor ()
 Returns the current camera interactor.
 
SoCameragetCamera () const
 Returns the current camera.
 
SceneInteractor::CameraMode getCameraMode ()
 Returns the current camera mode.
 
void enableHeadLight (bool enabled)
 Enable or disable headlight.
 
bool isHeadLightEnabled ()
 Returns if headlight is enabled.
 
- Public Member Functions inherited from SoSeparator
virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoSeparator ()
 Creates a separator node with default settings.
 
 SoSeparator (int nChildren)
 Constructor that takes approximate number of children.
 
- Public Member Functions inherited from SoGroup
 SoGroup ()
 Creates an empty group node.
 
 SoGroup (int nChildren)
 Constructor that takes approximate number of children.
 
virtual void addChild (SoNode *child)
 Adds a child as last one in group.
 
virtual void insertChild (SoNode *child, int newChildIndex)
 Adds a child so that it becomes the one with the given index.
 
virtual SoNodegetChild (int index) const
 Returns pointer the child node with the given index.
 
virtual int findChild (const SoNode *child) const
 Finds index of given child within group.
 
virtual int getNumChildren () const
 Returns number of children.
 
virtual void removeChild (int index)
 Removes child with given index from group.
 
virtual void removeChild (SoNode *child)
 Removes first instance of given child from group.
 
virtual void removeAllChildren ()
 Removes all children from group.
 
virtual void replaceChild (int index, SoNode *newChild)
 Replaces child with given index with new child.
 
virtual void replaceChild (SoNode *oldChild, SoNode *newChild)
 Replaces first instance of given child with new child.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Additional Inherited Members

- Static Public Member Functions inherited from SoSeparator
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoGroup
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Public Attributes inherited from SoSeparator
SoSFEnum boundingBoxCaching
 Whether to cache during bounding box traversal.
 
SoSFEnum renderCulling
 Whether to cull during rendering traversal.
 
SoSFEnum pickCulling
 Whether to cull during picking traversal.
 
SoSFEnum fastEditing
 Specifies the fast edit mode of the separator node.
 
SoSFInt32 renderUnitId
 Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.
 
SoDEPRECATED SoSFEnum renderCaching
 Whether to cache during rendering traversal.
 
- Public Attributes inherited from SoGroup
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

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

Definition at line 169 of file SceneExaminer.h.

Member Enumeration Documentation

◆ InteractionMode

Interaction Mode (navigation or selection)

Enumerator
NAVIGATION 
SELECTION 

Definition at line 177 of file SceneExaminer.h.

◆ NavigationMode

Navigation Mode.

Enumerator
ORBIT 
PLANE 

Definition at line 186 of file SceneExaminer.h.

Constructor & Destructor Documentation

◆ SceneExaminer()

SceneExaminer::SceneExaminer ( )

Constructor.

◆ ~SceneExaminer()

virtual SceneExaminer::~SceneExaminer ( )
virtual

Destructor.

Member Function Documentation

◆ addInteractionModeListener()

void SceneExaminer::addInteractionModeListener ( SiInteractionModeListener listener)

Add interaction listener.

◆ enableOrbit()

void SceneExaminer::enableOrbit ( bool  enabled)

Enable or disable camera orbiting.

Default is true.

◆ enablePan()

void SceneExaminer::enablePan ( bool  enabled)

Enable or disable camera panning.

Default is true.

◆ enableRotate()

void SceneExaminer::enableRotate ( bool  enabled)

Enable or disable camera rotation.

Default is true.

◆ enableSeek()

void SceneExaminer::enableSeek ( bool  enabled)

Enable or disable seek.

Default is true.

◆ enableSelection()

void SceneExaminer::enableSelection ( bool  enabled)

Enable or disable selection mode.

Default is true.

◆ enableSpin()

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.

◆ enableZoom()

void SceneExaminer::enableZoom ( bool  enabled)

Enable or disable zoom.

Default is true.

◆ getInteractionMode()

SceneExaminer::InteractionMode SceneExaminer::getInteractionMode ( )

Returns the current interaction mode.

◆ getNavigationMode()

SceneExaminer::NavigationMode SceneExaminer::getNavigationMode ( )

Returns the current navigation mode.

◆ isOrbitEnabled()

bool SceneExaminer::isOrbitEnabled ( )

Returns if camera orbiting is enabled.

◆ isPanEnabled()

bool SceneExaminer::isPanEnabled ( )

Returns if camera panning is enabled.

◆ isRotateEnabled()

bool SceneExaminer::isRotateEnabled ( )

Returns if camera rotation is enabled.

◆ isSeekEnabled()

bool SceneExaminer::isSeekEnabled ( )

Returns if seek is enabled.

◆ isSelectionEnabled()

bool SceneExaminer::isSelectionEnabled ( )

Returns if selection is enabled.

◆ isSpinEnabled()

bool SceneExaminer::isSpinEnabled ( ) const

Returns true if spin animation is enabled.

◆ isZoomEnabled()

bool SceneExaminer::isZoomEnabled ( )

Returns if zoom is enabled.

◆ removeInteractionModeListener()

void SceneExaminer::removeInteractionModeListener ( SiInteractionModeListener listener)

Remove interaction listener.

◆ setCameraMode()

virtual void SceneExaminer::setCameraMode ( SceneInteractor::CameraMode  mode)
virtual

Select perspective or orthographic camera.

Default is perspective.

Reimplemented from SceneInteractor.

◆ setInteractionMode()

void SceneExaminer::setInteractionMode ( SceneExaminer::InteractionMode  mode)

Set interaction mode to navigation or selection.

Default is NAVIGATION.

◆ setNavigationMode()

void SceneExaminer::setNavigationMode ( SceneExaminer::NavigationMode  mode)

Set navigation mode.

Default is ORBIT.

◆ setSeekMode()

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: