Tool class for building a basic interactive OpenInventor application with scene "examiner" viewing behavior. More...
#include <Inventor/ViewerComponents/nodes/SceneExaminer.h>
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. | |
SoCameraInteractor * | getCameraInteractor () |
Returns the current camera interactor. | |
SoCamera * | getCamera () 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 SoNode * | getChild (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 SoNode * | copy (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 SoField * | getField (const SbName &fieldName) const |
Returns a the field of this object whose name is fieldName. | |
virtual SoField * | getEventIn (const SbName &fieldName) const |
Returns a the eventIn with the given name. | |
virtual SoField * | getEventOut (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 SoNode * | getByName (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. | |
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:
SceneInteractor, SceneOrbiter, SoCameraInteractor, SiInteractionModeListener
Definition at line 169 of file SceneExaminer.h.
Interaction Mode (navigation or selection)
Enumerator | |
---|---|
NAVIGATION | |
SELECTION |
Definition at line 177 of file SceneExaminer.h.
SceneExaminer::SceneExaminer | ( | ) |
Constructor.
|
virtual |
Destructor.
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 |
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).