osgGA::KeySwitchMatrixManipulator Class Reference

Inheritance diagram for osgGA::KeySwitchMatrixManipulator:

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

Public Member Functions
virtual const char *	className () const
void	addMatrixManipulator (int key, std::string name, CameraManipulator *cm)
void	addNumberedMatrixManipulator (CameraManipulator *cm)
unsigned int	getNumMatrixManipulators () const
void	selectMatrixManipulator (unsigned int num)
KeyManipMap &	getKeyManipMap ()
const KeyManipMap &	getKeyManipMap () const
CameraManipulator *	getCurrentMatrixManipulator ()
const CameraManipulator *	getCurrentMatrixManipulator () const
CameraManipulator *	getMatrixManipulatorWithIndex (unsigned int key)
const CameraManipulator *	getMatrixManipulatorWithIndex (unsigned int key) const
CameraManipulator *	getMatrixManipulatorWithKey (unsigned int key)
const CameraManipulator *	getMatrixManipulatorWithKey (unsigned int key) const
virtual void	setCoordinateFrameCallback (CoordinateFrameCallback *cb)
virtual void	setByMatrix (const osg::Matrixd &matrix)
virtual void	setByInverseMatrix (const osg::Matrixd &matrix)
virtual osg::Matrixd	getMatrix () const
virtual osg::Matrixd	getInverseMatrix () const
virtual osgUtil::SceneView::FusionDistanceMode	getFusionDistanceMode () const
virtual float	getFusionDistanceValue () const
virtual void	setNode (osg::Node *n)
virtual const osg::Node *	getNode () const
virtual osg::Node *	getNode ()
virtual void	setHomePosition (const osg::Vec3d &eye, const osg::Vec3d &center, const osg::Vec3d &up, bool autoComputeHomePosition=false)
virtual void	setAutoComputeHomePosition (bool flag)
virtual void	computeHomePosition ()
virtual void	home (const GUIEventAdapter &ee, GUIActionAdapter &aa)
virtual void	init (const GUIEventAdapter &ee, GUIActionAdapter &aa)
virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &us)
virtual void	getUsage (osg::ApplicationUsage &usage) const
Public Member Functions inherited from osgGA::CameraManipulator
CoordinateFrameCallback *	getCoordinateFrameCallback ()
const CoordinateFrameCallback *	getCoordinateFrameCallback () const
osg::CoordinateFrame	getCoordinateFrame (const osg::Vec3d &position) const
osg::Vec3d	getSideVector (const osg::CoordinateFrame &cf) const
osg::Vec3d	getFrontVector (const osg::CoordinateFrame &cf) const
osg::Vec3d	getUpVector (const osg::CoordinateFrame &cf) const
void	setIntersectTraversalMask (unsigned int mask)
unsigned int	getIntersectTraversalMask () const
virtual void	getHomePosition (osg::Vec3d &eye, osg::Vec3d &center, osg::Vec3d &up) const
bool	getAutoComputeHomePosition () const
virtual void	computeHomePosition (const osg::Camera *camera=NULL, bool useBoundingBox=false)
virtual void	home (double)
Public Member Functions inherited from osgGA::GUIEventHandler
	GUIEventHandler ()
	GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop)
	META_Object (osgGA, GUIEventHandler)
virtual void	operator() (osg::Node *node, osg::NodeVisitor *nv)
virtual void	event (osg::NodeVisitor *nv, osg::Drawable *drawable)
virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
bool	handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *object, osg::NodeVisitor *nv)
bool	handleWithCheckAgainstIgnoreHandledEventsMask (const GUIEventAdapter &ea, GUIActionAdapter &aa)
void	setIgnoreHandledEventsMask (unsigned int mask)
unsigned int	getIgnoreHandledEventsMask () const
Public Member Functions inherited from osg::NodeCallback
	NodeCallback ()
	NodeCallback (const NodeCallback &nc, const CopyOp &)
	META_Object (osg, NodeCallback)
void	traverse (Node *node, NodeVisitor *nv)
void	setNestedCallback (NodeCallback *nc)
NodeCallback *	getNestedCallback ()
const NodeCallback *	getNestedCallback () const
void	addNestedCallback (NodeCallback *nc)
void	removeNestedCallback (NodeCallback *nc)
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const =0
virtual Object *	clone (const CopyOp &) const =0
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	setName (const std::string &name)
void	setName (const char *name)
const std::string &	getName () const
void	setDataVariance (DataVariance dv)
DataVariance	getDataVariance () const
virtual void	computeDataVariance ()
void	setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () const
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
template<typename T >
void	setUserValue (const std::string &name, const T &value)
virtual void	resizeGLObjectBuffers (unsigned int)
virtual void	releaseGLObjects (osg::State *=0) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const
Public Member Functions inherited from osg::Drawable::EventCallback
	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 ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()
Public Attributes inherited from osg::NodeCallback
ref_ptr< NodeCallback >	_nestedCallback
Protected Member Functions inherited from osgGA::CameraManipulator
	CameraManipulator ()
	CameraManipulator (const CameraManipulator &mm, const osg::CopyOp &copyOp=osg::CopyOp::SHALLOW_COPY)
virtual	~CameraManipulator ()
std::string	getManipulatorName () 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

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 TrackballManipultor, '2' for a DriveManipulator, '3' for a FlightManipulator. The manipulators available, and the associated switch keys, can be configured.

Member Typedef Documentation

typedef std::map<int, NamedManipulator> osgGA::KeySwitchMatrixManipulator::KeyManipMap

typedef std::pair<std::string, osg::ref_ptr<CameraManipulator> > osgGA::KeySwitchMatrixManipulator::NamedManipulator

Member Function Documentation

void osgGA::KeySwitchMatrixManipulator::addMatrixManipulator	(	int	key,
		std::string	name,
		CameraManipulator *	cm
	)

Add a camera manipulator with an associated name, and a key to trigger the switch,

void osgGA::KeySwitchMatrixManipulator::addNumberedMatrixManipulator

(

CameraManipulator *

cm

)

Add a camera manipulator with an autogenerated keybinding which is '1' + previous number of camera's registerd.

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.

virtual void osgGA::KeySwitchMatrixManipulator::computeHomePosition ( )

virtual

CameraManipulator* osgGA::KeySwitchMatrixManipulator::getCurrentMatrixManipulator ( )

inline

Get the current active manipulators.

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

inline

Get the const current active manipulators.

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

inlinevirtual

Get the FusionDistanceMode. Used by SceneView for setting up stereo convergence.

Reimplemented from osgGA::CameraManipulator.

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

inlinevirtual

Get the FusionDistanceValue. Used by SceneView for setting up stereo convergence.

Reimplemented from osgGA::CameraManipulator.

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.

KeyManipMap& osgGA::KeySwitchMatrixManipulator::getKeyManipMap ( )

inline

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

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

inline

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

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

inlinevirtual

get the position of the manipulator as 4x4 Matrix.

Implements osgGA::CameraManipulator.

CameraManipulator* osgGA::KeySwitchMatrixManipulator::getMatrixManipulatorWithIndex

(

unsigned int

key

)

Get manipulator assigned to a specified index.

const CameraManipulator* osgGA::KeySwitchMatrixManipulator::getMatrixManipulatorWithIndex

(

unsigned int

key

)

const

Get const manipulator assigned to a specified index.

CameraManipulator* osgGA::KeySwitchMatrixManipulator::getMatrixManipulatorWithKey

(

unsigned int

key

)

Get manipulator assigned to a specified key.

const CameraManipulator* osgGA::KeySwitchMatrixManipulator::getMatrixManipulatorWithKey

(

unsigned int

key

)

const

Get const manipulator assigned to a specified key.

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

inlinevirtual

Return const node if attached.

Reimplemented from osgGA::CameraManipulator.

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

inlinevirtual

Return node if attached.

Reimplemented from osgGA::CameraManipulator.

unsigned int osgGA::KeySwitchMatrixManipulator::getNumMatrixManipulators ( ) const

inline

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

virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::GUIEventHandler.

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

virtual

Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::CameraManipulator.

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.

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.

void osgGA::KeySwitchMatrixManipulator::selectMatrixManipulator

(

unsigned int

num

)

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

virtual

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

Reimplemented from osgGA::CameraManipulator.

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

inlinevirtual

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

Implements osgGA::CameraManipulator.

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

inlinevirtual

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

Implements osgGA::CameraManipulator.

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.

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.

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:

• KeySwitchMatrixManipulator