KeySwitchMatrixManipulator is a decorator which allows the type of camera manipulator being used to be switched by pressing a key. More...

Inheritance diagram for osgGA::KeySwitchMatrixManipulator:

[legend]

Collaboration diagram for osgGA::KeySwitchMatrixManipulator:

[legend]

Public Types
typedef std::pair< std::string, osg::ref_ptr< CameraManipulator > >	NamedManipulator

typedef std::map< int, NamedManipulator >	KeyManipMap

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
virtual const char *	className () const
	return the name of the object's class type. More...

void	addMatrixManipulator (int key, std::string name, CameraManipulator *cm)
	Add a camera manipulator with an associated name, and a key to trigger the switch,.

void	addNumberedMatrixManipulator (CameraManipulator *cm)
	Add a camera manipulator with an autogenerated keybinding which is '1' + previous number of camera's registerd.

unsigned int	getNumMatrixManipulators () const

void	selectMatrixManipulator (unsigned int num)

KeyManipMap &	getKeyManipMap ()
	Get the complete list of manipulators attached to this keyswitch manipulator. More...

const KeyManipMap &	getKeyManipMap () const
	Get the const complete list of manipulators attached to this keyswitch manipulator. More...

CameraManipulator *	getCurrentMatrixManipulator ()
	Get the current active manipulators. More...

const CameraManipulator *	getCurrentMatrixManipulator () const
	Get the const current active manipulators. More...

CameraManipulator *	getMatrixManipulatorWithIndex (unsigned int key)
	Get manipulator assigned to a specified index. More...

const CameraManipulator *	getMatrixManipulatorWithIndex (unsigned int key) const
	Get const manipulator assigned to a specified index. More...

CameraManipulator *	getMatrixManipulatorWithKey (unsigned int key)
	Get manipulator assigned to a specified key. More...

const CameraManipulator *	getMatrixManipulatorWithKey (unsigned int key) const
	Get const manipulator assigned to a specified key. More...

virtual void	setCoordinateFrameCallback (CoordinateFrameCallback *cb)
	set the coordinate frame which callback tells the manipulator which way is up, east and north. More...

virtual void	setByMatrix (const osg::Matrixd &matrix)
	Set the position of the matrix manipulator using a 4x4 Matrix. More...

virtual void	setByInverseMatrix (const osg::Matrixd &matrix)
	set the position of the matrix manipulator using a 4x4 Matrix. More...

virtual osg::Matrixd	getMatrix () const
	get the position of the manipulator as 4x4 Matrix. More...

virtual osg::Matrixd	getInverseMatrix () const
	get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix. More...

virtual osgUtil::SceneView::FusionDistanceMode	getFusionDistanceMode () const
	Get the FusionDistanceMode. More...

virtual float	getFusionDistanceValue () const
	Get the FusionDistanceValue. More...

virtual void	setNode (osg::Node *n)
	Attach a node to the manipulator, automatically detaching any previously attached node. More...

virtual const osg::Node *	getNode () const
	Return const node if attached. More...

virtual osg::Node *	getNode ()
	Return node if attached. More...

virtual void	setHomePosition (const osg::Vec3d &eye, const osg::Vec3d &center, const osg::Vec3d &up, bool autoComputeHomePosition=false)
	Manually set the home position, and set the automatic compute of home position. More...

virtual void	setAutoComputeHomePosition (bool flag)
	Set whether the automatic compute of the home position is enabled. More...

virtual void	computeHomePosition ()

virtual void	finishAnimation ()
	finish any active manipulator animations. More...

virtual void	home (const GUIEventAdapter &ee, GUIActionAdapter &aa)
	Move the camera to the default position. More...

virtual void	init (const GUIEventAdapter &ee, GUIActionAdapter &aa)
	Start/restart the manipulator. More...

virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &us)
	Handle events, return true if handled, false otherwise. More...

virtual void	getUsage (osg::ApplicationUsage &usage) const
	Get the keyboard and mouse usage of this manipulator. More...

Public Member Functions inherited from osgGA::CameraManipulator
CoordinateFrameCallback *	getCoordinateFrameCallback ()
	get the coordinate frame callback which tells the manipulator which way is up, east and north. More...

const CoordinateFrameCallback *	getCoordinateFrameCallback () const
	get the coordinate frame callback which tells the manipulator which way is up, east and north. More...

osg::CoordinateFrame	getCoordinateFrame (const osg::Vec3d &position) const
	get the coordinate frame. More...

osg::Vec3d	getSideVector (const osg::CoordinateFrame &cf) const

osg::Vec3d	getFrontVector (const osg::CoordinateFrame &cf) const

osg::Vec3d	getUpVector (const osg::CoordinateFrame &cf) const

virtual void	updateCamera (osg::Camera &camera)
	update the camera for the current frame, typically called by the viewer classes. More...

void	setIntersectTraversalMask (unsigned int mask)
	Set the mask to use when set up intersection traversal such as used in manipulators that follow terrain or have collision detection. More...

unsigned int	getIntersectTraversalMask () const
	Get the mask to use when set up intersection traversal such as used in manipulators that follow terrain or have collision detection. More...

virtual void	getHomePosition (osg::Vec3d &eye, osg::Vec3d &center, osg::Vec3d &up) const
	Get the manually set home position. More...

bool	getAutoComputeHomePosition () const
	Get whether the automatic compute of the home position is enabled. More...

virtual void	computeHomePosition (const osg::Camera *camera=NULL, bool useBoundingBox=false)
	Compute the home position. More...

virtual void	home (double)
	Move the camera to the default position. More...

virtual bool	handle (osgGA::Event event, osg::Object object, osg::NodeVisitor *nv)
	Handle event. More...

Public Member Functions inherited from osgGA::GUIEventHandler
	GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgGA, GUIEventHandler)

virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object , osg::NodeVisitor )
	Handle events, return true if handled, false otherwise. More...

Public Member Functions inherited from osgGA::EventHandler
	EventHandler (const EventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

	META_Object (osgGA, EventHandler)

virtual bool	run (osg::Object object, osg::Object data)
	NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(Node* node, NodeVisitor* nv) method. More...

virtual void	operator() (osg::Node node, osg::NodeVisitor nv)
	Event traversal node callback method. More...

virtual void	event (osg::NodeVisitor nv, osg::Drawable drawable)
	Event traversal drawable callback method. More...

Public Member Functions inherited from osg::NodeCallback
	NodeCallback (const NodeCallback &nc, const CopyOp &copyop)

	META_Object (osg, NodeCallback)

Public Member Functions inherited from osg::Callback
	Callback (const Callback &cb, const CopyOp &copyop)

	META_Object (osg, Callback)

bool	traverse (osg::Object object, osg::Object data)
	traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node, and data is NodeVisitor. More...

void	setNestedCallback (osg::Callback *cb)

osg::Callback *	getNestedCallback ()

const osg::Callback *	getNestedCallback () const

void	addNestedCallback (osg::Callback *nc)

void	removeNestedCallback (osg::Callback *nc)

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...

virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...

virtual bool	isSameKindAs (const Object *) const

virtual const char *	libraryName () const =0
	return the name of the object's library. More...

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template

Public Member Functions inherited from osg::Referenced
	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

OpenThreads::Mutex *	getRefMutex () const

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Public Member Functions inherited from osg::Drawable::EventCallback
	EventCallback (const EventCallback &, const CopyOp &)

	META_Object (osg, EventCallback)

Additional Inherited Members
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Protected Member Functions inherited from osgGA::CameraManipulator
	CameraManipulator (const CameraManipulator &mm, const osg::CopyOp &copyOp=osg::CopyOp::SHALLOW_COPY)

std::string	getManipulatorName () const

Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...

Protected Member Functions inherited from osg::Referenced
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

Protected Attributes inherited from osgGA::CameraManipulator
unsigned int	_intersectTraversalMask

bool	_autoComputeHomePosition

osg::Vec3d	_homeEye

osg::Vec3d	_homeCenter

osg::Vec3d	_homeUp

osg::ref_ptr< CoordinateFrameCallback >	_coordinateFrameCallback

Protected Attributes inherited from osg::Callback
ref_ptr< Callback >	_nestedCallback

Protected Attributes inherited from osg::Object
std::string	_name

DataVariance	_dataVariance

osg::UserDataContainer *	_userDataContainer

Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet

OpenThreads::Atomic	_refCount

OpenThreads::Mutex *	_refMutex

int	_refCount

void *	_observerSet

Detailed Description

KeySwitchMatrixManipulator is a decorator which allows the type of camera manipulator being used to be switched by pressing a key.

E.g. '1' for a TrackballManipulator, '2' for a DriveManipulator, '3' for a FlightManipulator. The manipulators available, and the associated switch keys, can be configured.

Member Function Documentation

◆ className()

virtual const char* osgGA::KeySwitchMatrixManipulator::className ( ) const

inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Reimplemented from osgGA::CameraManipulator.

◆ finishAnimation()

virtual void osgGA::KeySwitchMatrixManipulator::finishAnimation ( )

virtual

finish any active manipulator animations.

Reimplemented from osgGA::CameraManipulator.

◆ getCurrentMatrixManipulator() [1/2]

CameraManipulator* osgGA::KeySwitchMatrixManipulator::getCurrentMatrixManipulator ( )

inline

Get the current active manipulators.

◆ getCurrentMatrixManipulator() [2/2]

const CameraManipulator* osgGA::KeySwitchMatrixManipulator::getCurrentMatrixManipulator ( ) const

inline

Get the const current active manipulators.

◆ getFusionDistanceMode()

virtual osgUtil::SceneView::FusionDistanceMode osgGA::KeySwitchMatrixManipulator::getFusionDistanceMode ( ) const

inlinevirtual

Get the FusionDistanceMode.

Used by SceneView for setting up stereo convergence.

Reimplemented from osgGA::CameraManipulator.

◆ getFusionDistanceValue()

virtual float osgGA::KeySwitchMatrixManipulator::getFusionDistanceValue ( ) const

inlinevirtual

Get the FusionDistanceValue.

Used by SceneView for setting up stereo convergence.

Reimplemented from osgGA::CameraManipulator.

◆ getInverseMatrix()

virtual osg::Matrixd osgGA::KeySwitchMatrixManipulator::getInverseMatrix ( ) const

inlinevirtual

get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix.

Implements osgGA::CameraManipulator.

◆ getKeyManipMap() [1/2]

KeyManipMap& osgGA::KeySwitchMatrixManipulator::getKeyManipMap ( )

inline

Get the complete list of manipulators attached to this keyswitch manipulator.

◆ getKeyManipMap() [2/2]

const KeyManipMap& osgGA::KeySwitchMatrixManipulator::getKeyManipMap ( ) const

inline

Get the const complete list of manipulators attached to this keyswitch manipulator.

◆ getMatrix()

virtual osg::Matrixd osgGA::KeySwitchMatrixManipulator::getMatrix ( ) const

inlinevirtual

get the position of the manipulator as 4x4 Matrix.

Implements osgGA::CameraManipulator.

◆ getMatrixManipulatorWithIndex() [1/2]

CameraManipulator* osgGA::KeySwitchMatrixManipulator::getMatrixManipulatorWithIndex ( unsigned int key )

Get manipulator assigned to a specified index.

◆ getMatrixManipulatorWithIndex() [2/2]

const CameraManipulator* osgGA::KeySwitchMatrixManipulator::getMatrixManipulatorWithIndex ( unsigned int key ) const

Get const manipulator assigned to a specified index.

◆ getMatrixManipulatorWithKey() [1/2]

CameraManipulator* osgGA::KeySwitchMatrixManipulator::getMatrixManipulatorWithKey ( unsigned int key )

Get manipulator assigned to a specified key.

◆ getMatrixManipulatorWithKey() [2/2]

const CameraManipulator* osgGA::KeySwitchMatrixManipulator::getMatrixManipulatorWithKey ( unsigned int key ) const

Get const manipulator assigned to a specified key.

◆ getNode() [1/2]

virtual const osg::Node* osgGA::KeySwitchMatrixManipulator::getNode ( ) const

inlinevirtual

Return const node if attached.

Reimplemented from osgGA::CameraManipulator.

◆ getNode() [2/2]

virtual osg::Node* osgGA::KeySwitchMatrixManipulator::getNode ( )

inlinevirtual

Return node if attached.

Reimplemented from osgGA::CameraManipulator.

◆ getUsage()

virtual void osgGA::KeySwitchMatrixManipulator::getUsage ( osg::ApplicationUsage & usage ) const

virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

◆ handle()

virtual bool osgGA::KeySwitchMatrixManipulator::handle	(	const GUIEventAdapter &	ea,
		GUIActionAdapter &	us
	)

virtual

Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::CameraManipulator.

◆ home()

virtual void osgGA::KeySwitchMatrixManipulator::home	(	const GUIEventAdapter &	,
		GUIActionAdapter &
	)

virtual

Move the camera to the default position.

May be ignored by manipulators if home functionality is not appropriate.

Reimplemented from osgGA::CameraManipulator.

◆ init()

virtual void osgGA::KeySwitchMatrixManipulator::init	(	const GUIEventAdapter &	,
		GUIActionAdapter &
	)

inlinevirtual

Start/restart the manipulator.

FIXME: what does this actually mean? Provide examples.

Reimplemented from osgGA::CameraManipulator.

◆ setAutoComputeHomePosition()

virtual void osgGA::KeySwitchMatrixManipulator::setAutoComputeHomePosition ( bool flag )

virtual

Set whether the automatic compute of the home position is enabled.

Reimplemented from osgGA::CameraManipulator.

◆ setByInverseMatrix()

virtual void osgGA::KeySwitchMatrixManipulator::setByInverseMatrix ( const osg::Matrixd & matrix )

inlinevirtual

set the position of the matrix manipulator using a 4x4 Matrix.

Implements osgGA::CameraManipulator.

◆ setByMatrix()

virtual void osgGA::KeySwitchMatrixManipulator::setByMatrix ( const osg::Matrixd & matrix )

inlinevirtual

Set the position of the matrix manipulator using a 4x4 Matrix.

Implements osgGA::CameraManipulator.

◆ setCoordinateFrameCallback()

virtual void osgGA::KeySwitchMatrixManipulator::setCoordinateFrameCallback ( CoordinateFrameCallback * cb )

virtual

set the coordinate frame which callback tells the manipulator which way is up, east and north.

Reimplemented from osgGA::CameraManipulator.

◆ setHomePosition()

virtual void osgGA::KeySwitchMatrixManipulator::setHomePosition	(	const osg::Vec3d &	eye,
		const osg::Vec3d &	center,
		const osg::Vec3d &	up,
		bool	autoComputeHomePosition = `false`
	)

virtual

Manually set the home position, and set the automatic compute of home position.

Reimplemented from osgGA::CameraManipulator.

◆ setNode()

virtual void osgGA::KeySwitchMatrixManipulator::setNode ( osg::Node * )

virtual

Attach a node to the manipulator, automatically detaching any previously attached node.

setNode(NULL) detaches previous nodes. May be ignored by manipulators which do not require a reference model.

Reimplemented from osgGA::CameraManipulator.

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

/home/karlu20/private/installs/OpenSceneGraph/include/osgGA/KeySwitchMatrixManipulator

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ className()

◆ finishAnimation()

◆ getCurrentMatrixManipulator() [1/2]

◆ getCurrentMatrixManipulator() [2/2]

◆ getFusionDistanceMode()

◆ getFusionDistanceValue()

◆ getInverseMatrix()

◆ getKeyManipMap() [1/2]

◆ getKeyManipMap() [2/2]

◆ getMatrix()

◆ getMatrixManipulatorWithIndex() [1/2]

◆ getMatrixManipulatorWithIndex() [2/2]

◆ getMatrixManipulatorWithKey() [1/2]

◆ getMatrixManipulatorWithKey() [2/2]

◆ getNode() [1/2]

◆ getNode() [2/2]

◆ getUsage()

◆ handle()

◆ home()

◆ init()

◆ setAutoComputeHomePosition()

◆ setByInverseMatrix()

◆ setByMatrix()

◆ setCoordinateFrameCallback()

◆ setHomePosition()

◆ setNode()