Base class for building a basic OpenInventor application without using the classic viewer classes. More...

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

Inheritance diagram for SceneInteractor:

Public Types
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
	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.

virtual void	setCameraMode (SceneInteractor::CameraMode mode)
	Select perspective or orthographic 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.

Related Symbols inherited from SoSeparator
#define	SO_RENDERUNITID_NONE (-1)
	Don't traverse any children.

#define	SO_RENDERUNITID_INHERIT (-2)
	Inherit value from state.

#define	SO_RENDERUNITID_ALL (-3)
	Traverse all children.

Detailed Description

Base class for building a basic OpenInventor application without using the classic viewer classes.

The SceneInteractor is a simple extension of the SoSeparator node that allows handling of Open Inventor events. This class should be overridden as it provides only empty event handlers. See, for example, SceneExaminer and SceneOrbiter.

This node is intended to be used as the root of a scene graph. The SceneInteractor is a custom SoSeparator whose children are:

An SoEventCallback node that handles keyboard, mouse and touch events.
A camera (switch between perspective and orthographic camera).
A headlight.
The application's scene graph, which should be the last child.

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

Class diagram of the SceneInteractor showing the relationship between the SoEventCallback, the SoCamera, the SoDirectionalLight (used as headlight) and the SoCameraInteractor.

Detail of the scene graph rooted by a SceneInteractor:

Notes:

A basic version of SceneInteractor is a supported part of the Open Inventor API, but the prebuilt library is located in the example folders, not in the usual folder.
The basic version of SceneInteractor is also provided as source code in the example folders to allow applications to customize and build their own interactive tool class.
See $OIVHOME/source/Inventor/gui/ViewerComponents
This class can only be used with ViewerComponents and will not work with other viewer (like SoXtRenderArea)

Member Enumeration Documentation

◆ CameraMode

enum SceneInteractor::CameraMode

Type of camera (perspective or orthographic)

Enumerator
PERSPECTIVE
ORTHOGRAPHIC

Definition at line 114 of file SceneInteractor.h.

Constructor & Destructor Documentation

◆ SceneInteractor()

SceneInteractor::SceneInteractor ( )

Constructor.

◆ ~SceneInteractor()

virtual SceneInteractor::~SceneInteractor ( )

virtual

Destructor.

Member Function Documentation

◆ adjustClippingPlanes()

void SceneInteractor::adjustClippingPlanes ( const SbViewportRegion & vpRegion )

Adjust near and far clipping planes to minimize clipping of objects in the scene.

This adjustment, based on the bounding box of the scene, ensures that shapes will not be clipped and also that depth buffer precision is maximized. This method should be called before each render traversal.

◆ enableHeadLight()

void SceneInteractor::enableHeadLight ( bool enabled )

Enable or disable headlight.

Default is true.

◆ getCamera()

SoCamera * SceneInteractor::getCamera ( ) const

Returns the current camera.

◆ getCameraInteractor()

SoCameraInteractor * SceneInteractor::getCameraInteractor ( )

Returns the current camera interactor.

◆ getCameraMode()

SceneInteractor::CameraMode SceneInteractor::getCameraMode ( )

Returns the current camera mode.

◆ isHeadLightEnabled()

bool SceneInteractor::isHeadLightEnabled ( )

Returns if headlight is enabled.

◆ setCameraMode()

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

virtual

Select perspective or orthographic camera.

Default is perspective.

Reimplemented in SceneExaminer, and SceneOrbiter.

◆ viewAll()

void SceneInteractor::viewAll ( const SbViewportRegion & viewport )

Move the camera to view the scene defined by the given path.

Equivalent to calling the SoCamera method viewAll(). Camera position is changed, but not orientation.

◆ viewAxis()

void SceneInteractor::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.

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

Inventor/ViewerComponents/nodes/SceneInteractor.h

Open Inventor Release 2024.2.1

Public Types

Public Member Functions

Additional Inherited Members