Inheritance diagram for osgGA::SphericalManipulator:

[legend]

Public Types
enum	RotationMode { ELEVATION_HEADING =0, HEADING, ELEVATION, MAP }

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

Public Member Functions
	SphericalManipulator ()

virtual const char *	className () const
	return the name of the object's class type. 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 *)
	Attach a node to the manipulator. More...

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

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

virtual void	home (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
	Move the camera to the default position. More...

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

virtual void	init (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &us)
	Start/restart the manipulator. More...

void	zoomOn (const osg::BoundingSphere &bound)

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

virtual void	computeHomePosition ()
	Compute the home position. More...

void	computeViewPosition (const osg::BoundingSphere &bound, double &scale, double &distance, osg::Vec3d &center)

void	setCenter (const osg::Vec3d &center)

const osg::Vec3d &	getCenter () const

bool	setDistance (double distance)

double	getDistance () const

double	getHomeDistance () const

void	setHeading (double azimuth)

double	getHeading () const

void	setElevation (double elevation)

double	getElevtion () const

double	getMinimumZoomScale () const
	get the minimum distance (as ratio) the eye point can be zoomed in More...

void	setMinimumZoomScale (double minimumZoomScale)
	set the minimum distance (as ratio) the eye point can be zoomed in towards the center before the center is pushed forward. More...

void	setScroolWheelZoomDelta (double zoomDelta)
	set the mouse scroll wheel zoom delta. More...

double	getScroolWheelZoomDelta () const
	get the mouse scroll wheel zoom delta. More...

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

RotationMode	getRotationMode () const

void	setRotationMode (RotationMode mode)

bool	getAllowThrow () const
	Returns true if the camera can be thrown, false otherwise. More...

void	setAllowThrow (bool allowThrow)
	Set the 'allow throw' flag. More...

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

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	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	getHomePosition (osg::Vec3d &eye, osg::Vec3d &center, osg::Vec3d &up) const
	Get the manually set home position. More...

virtual void	setAutoComputeHomePosition (bool flag)
	Set whether the automatic compute of the home position is enabled. 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	finishAnimation ()
	finish any active manipulator animations. More...

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

Public Member Functions inherited from osgGA::GUIEventHandler
	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 ()

	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 ()

	NodeCallback (const NodeCallback &nc, const CopyOp &copyop)

	META_Object (osg, NodeCallback)

Public Member Functions inherited from osg::Callback
	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 More...

Public Member Functions inherited from osg::Referenced
	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...

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

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 ()

	EventCallback (const EventCallback &, const CopyOp &)

	META_Object (osg, EventCallback)

Protected Member Functions
virtual	~SphericalManipulator ()

void	flushMouseEventStack ()
	Reset the internal GUIEvent stack. More...

void	addMouseEvent (const osgGA::GUIEventAdapter &ea)
	Add the current mouse GUIEvent to internal stack. More...

bool	calcMovement ()
	For the give mouse movement calculate the movement of the camera. More...

bool	isMouseMoving ()
	Check the speed at which the mouse is moving. More...

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 Member Functions inherited from osgGA::GUIEventHandler
virtual	~GUIEventHandler ()

Protected Member Functions inherited from osg::NodeCallback
virtual	~NodeCallback ()

Protected Member Functions inherited from osg::Callback
virtual	~Callback ()

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

Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()

void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

Protected Attributes
osg::ref_ptr< const osgGA::GUIEventAdapter >	_ga_t1

osg::ref_ptr< const osgGA::GUIEventAdapter >	_ga_t0

osg::observer_ptr< osg::Node >	_node

double	_modelScale

double	_minimumZoomScale

bool	_thrown

bool	_allowThrow

double	_delta_frame_time
	The approximate amount of time it is currently taking to draw a frame. More...

double	_last_frame_time
	The time the last frame started. More...

RotationMode	_rotationMode

osg::Vec3d	_center

double	_distance

double	_heading

double	_elevation

double	_homeDistance

double	_zoomDelta

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

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

Member Enumeration Documentation

enum osgGA::SphericalManipulator::RotationMode

Enumerator
ELEVATION_HEADING
HEADING
ELEVATION
MAP

Constructor & Destructor Documentation

osgGA::SphericalManipulator::SphericalManipulator ( )

virtual osgGA::SphericalManipulator::~SphericalManipulator ( )

protectedvirtual

Member Function Documentation

void osgGA::SphericalManipulator::addMouseEvent ( const osgGA::GUIEventAdapter & ea )

protected

Add the current mouse GUIEvent to internal stack.

bool osgGA::SphericalManipulator::calcMovement ( )

protected

For the give mouse movement calculate the movement of the camera.

Return true is camera has moved and a redraw is required.

virtual const char* osgGA::SphericalManipulator::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::SphericalManipulator::computeHomePosition ( )

virtual

Compute the home position.

void osgGA::SphericalManipulator::computeViewPosition	(	const osg::BoundingSphere &	bound,
		double &	scale,
		double &	distance,
		osg::Vec3d &	center
	)

void osgGA::SphericalManipulator::flushMouseEventStack ( )

protected

Reset the internal GUIEvent stack.

bool osgGA::SphericalManipulator::getAllowThrow ( ) const

inline

Returns true if the camera can be thrown, false otherwise.

This defaults to true.

const osg::Vec3d& osgGA::SphericalManipulator::getCenter ( ) const

inline

double osgGA::SphericalManipulator::getDistance ( ) const

inline

double osgGA::SphericalManipulator::getElevtion ( ) const

inline

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

inlinevirtual

Get the FusionDistanceMode.

Used by SceneView for setting up stereo convergence.

Reimplemented from osgGA::CameraManipulator.

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

inlinevirtual

Get the FusionDistanceValue.

Used by SceneView for setting up stereo convergence.

Reimplemented from osgGA::CameraManipulator.

double osgGA::SphericalManipulator::getHeading ( ) const

inline

double osgGA::SphericalManipulator::getHomeDistance ( ) const

inline

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

virtual

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

Implements osgGA::CameraManipulator.

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

virtual

get the position of the manipulator as 4x4 Matrix.

Implements osgGA::CameraManipulator.

double osgGA::SphericalManipulator::getMinimumZoomScale ( ) const

inline

get the minimum distance (as ratio) the eye point can be zoomed in

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

virtual

Return node if attached.

Reimplemented from osgGA::CameraManipulator.

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

virtual

Return node if attached.

Reimplemented from osgGA::CameraManipulator.

RotationMode osgGA::SphericalManipulator::getRotationMode ( ) const

inline

double osgGA::SphericalManipulator::getScroolWheelZoomDelta ( ) const

inline

get the mouse scroll wheel zoom delta.

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

virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

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

virtual

handle events, return true if handled, false otherwise.

Reimplemented from osgGA::CameraManipulator.

virtual void osgGA::SphericalManipulator::home	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)

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::SphericalManipulator::home ( double )

virtual

Move the camera to the default position.

This version does not require GUIEventAdapter and GUIActionAdapter so may be called from somewhere other than a handle() method in GUIEventHandler. Application must be aware of implications.

Reimplemented from osgGA::CameraManipulator.

virtual void osgGA::SphericalManipulator::init	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	us
	)

virtual

Start/restart the manipulator.

Reimplemented from osgGA::CameraManipulator.

bool osgGA::SphericalManipulator::isMouseMoving ( )

protected

Check the speed at which the mouse is moving.

If speed is below a threshold then return false, otherwise return true.

void osgGA::SphericalManipulator::setAllowThrow ( bool allowThrow )

inline

Set the 'allow throw' flag.

Releasing the mouse button while moving the camera results in a throw.

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

inlinevirtual

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

Implements osgGA::CameraManipulator.

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

virtual

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

Implements osgGA::CameraManipulator.

void osgGA::SphericalManipulator::setCenter ( const osg::Vec3d & center )

inline

bool osgGA::SphericalManipulator::setDistance ( double distance )

void osgGA::SphericalManipulator::setElevation ( double elevation )

inline

void osgGA::SphericalManipulator::setHeading ( double azimuth )

inline

void osgGA::SphericalManipulator::setMinimumZoomScale ( double minimumZoomScale )

inline

set the minimum distance (as ratio) the eye point can be zoomed in towards the center before the center is pushed forward.

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

virtual

Attach a node to the manipulator.

Automatically detaches previously attached node. setNode(NULL) detaches previously nodes. Is ignored by manipulators which do not require a reference model.

Reimplemented from osgGA::CameraManipulator.

void osgGA::SphericalManipulator::setRotationMode ( RotationMode mode )

void osgGA::SphericalManipulator::setScroolWheelZoomDelta ( double zoomDelta )

inline

set the mouse scroll wheel zoom delta.

Range -1.0 to +1.0, -ve value inverts wheel direction and zero switches off scroll wheel.

void osgGA::SphericalManipulator::zoomOn ( const osg::BoundingSphere & bound )

Member Data Documentation

bool osgGA::SphericalManipulator::_allowThrow

protected

osg::Vec3d osgGA::SphericalManipulator::_center

protected

double osgGA::SphericalManipulator::_delta_frame_time

protected

The approximate amount of time it is currently taking to draw a frame.

This is used to compute the delta in translation/rotation during a thrown display update. It allows us to match an delta in position/rotation independent of the rendering frame rate.

double osgGA::SphericalManipulator::_distance

protected

double osgGA::SphericalManipulator::_elevation

protected

osg::ref_ptr<const osgGA::GUIEventAdapter> osgGA::SphericalManipulator::_ga_t0

protected

osg::ref_ptr<const osgGA::GUIEventAdapter> osgGA::SphericalManipulator::_ga_t1

protected

double osgGA::SphericalManipulator::_heading

protected

double osgGA::SphericalManipulator::_homeDistance

protected

double osgGA::SphericalManipulator::_last_frame_time

protected

The time the last frame started.

Used when _rate_sensitive is true so that we can match display update rate to rotation/translation rate.

double osgGA::SphericalManipulator::_minimumZoomScale

protected

double osgGA::SphericalManipulator::_modelScale

protected

osg::observer_ptr<osg::Node> osgGA::SphericalManipulator::_node

protected

RotationMode osgGA::SphericalManipulator::_rotationMode

protected

bool osgGA::SphericalManipulator::_thrown

protected

double osgGA::SphericalManipulator::_zoomDelta

protected

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

osgGA/SphericalManipulator

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation