#include <SphericalManipulator.h>

Inheritance diagram for osgGA::SphericalManipulator:

Collaboration diagram for osgGA::SphericalManipulator:

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

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

virtual const osg::Node *	getNode () const

virtual osg::Node *	getNode ()

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

virtual void	home (double)

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

void	zoomOn (const osg::BoundingSphere &bound)

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

virtual void	computeHomePosition ()

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

void	setMinimumZoomScale (double minimumZoomScale)

void	setScroolWheelZoomDelta (double zoomDelta)

double	getScroolWheelZoomDelta () const

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

RotationMode	getRotationMode () const

void	setRotationMode (RotationMode mode)

bool	getAllowThrow () const

void	setAllowThrow (bool allowThrow)

Public Member Functions inherited from osgGA::CameraManipulator
virtual void	setCoordinateFrameCallback (CoordinateFrameCallback *cb)

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

virtual void	updateCamera (osg::Camera &camera)

void	setIntersectTraversalMask (unsigned int mask)

unsigned int	getIntersectTraversalMask () const

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

virtual void	getHomePosition (osg::Vec3d &eye, osg::Vec3d &center, osg::Vec3d &up) const

virtual void	setAutoComputeHomePosition (bool flag)

bool	getAutoComputeHomePosition () const

virtual void	computeHomePosition (const osg::Camera *camera=NULL, bool useBoundingBox=false)

virtual void	finishAnimation ()

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

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 )

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)

virtual void	operator() (osg::Node node, osg::NodeVisitor nv)

virtual void	event (osg::NodeVisitor nv, osg::Drawable drawable)

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)

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

	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

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

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

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) 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)

Protected Member Functions
virtual	~SphericalManipulator ()

void	flushMouseEventStack ()

void	addMouseEvent (const osgGA::GUIEventAdapter &ea)

bool	calcMovement ()

bool	isMouseMoving ()

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

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

double	_last_frame_time

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

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

Detailed Description

Definition at line 24 of file SphericalManipulator.h.

Member Enumeration Documentation

enum osgGA::SphericalManipulator::RotationMode

Enumerator
ELEVATION_HEADING
HEADING
ELEVATION
MAP

Definition at line 113 of file SphericalManipulator.h.

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.

Definition at line 29 of file SphericalManipulator.h.

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.

Definition at line 125 of file SphericalManipulator.h.

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

inline

Definition at line 80 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::getDistance ( ) const

inline

Definition at line 83 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::getElevtion ( ) const

inline

Definition at line 91 of file SphericalManipulator.h.

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

inlinevirtual

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

Reimplemented from osgGA::CameraManipulator.

Definition at line 44 of file SphericalManipulator.h.

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

inlinevirtual

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

Reimplemented from osgGA::CameraManipulator.

Definition at line 47 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::getHeading ( ) const

inline

Definition at line 88 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::getHomeDistance ( ) const

inline

Definition at line 85 of file SphericalManipulator.h.

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

Definition at line 95 of file SphericalManipulator.h.

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

Definition at line 121 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::getScroolWheelZoomDelta ( ) const

inline

get the mouse scroll wheel zoom delta.

Definition at line 107 of file SphericalManipulator.h.

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.

Definition at line 127 of file SphericalManipulator.h.

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

inlinevirtual

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

Implements osgGA::CameraManipulator.

Definition at line 35 of file SphericalManipulator.h.

Here is the call graph for this function:

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

Definition at line 79 of file SphericalManipulator.h.

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

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

inline

Definition at line 90 of file SphericalManipulator.h.

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

inline

Definition at line 87 of file SphericalManipulator.h.

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.

Definition at line 99 of file SphericalManipulator.h.

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.

Definition at line 104 of file SphericalManipulator.h.

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

Member Data Documentation

bool osgGA::SphericalManipulator::_allowThrow

protected

Definition at line 156 of file SphericalManipulator.h.

osg::Vec3d osgGA::SphericalManipulator::_center

protected

Definition at line 170 of file SphericalManipulator.h.

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.

Definition at line 162 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::_distance

protected

Definition at line 171 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::_elevation

protected

Definition at line 173 of file SphericalManipulator.h.

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

protected

Definition at line 148 of file SphericalManipulator.h.

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

protected

Definition at line 147 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::_heading

protected

Definition at line 172 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::_homeDistance

protected

Definition at line 174 of file SphericalManipulator.h.

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.

Definition at line 167 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::_minimumZoomScale

protected

Definition at line 153 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::_modelScale

protected

Definition at line 152 of file SphericalManipulator.h.

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

protected

Definition at line 150 of file SphericalManipulator.h.

RotationMode osgGA::SphericalManipulator::_rotationMode

protected

Definition at line 169 of file SphericalManipulator.h.

bool osgGA::SphericalManipulator::_thrown

protected

Definition at line 155 of file SphericalManipulator.h.

double osgGA::SphericalManipulator::_zoomDelta

protected

Definition at line 175 of file SphericalManipulator.h.

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

osg_head/include/osgGA/SphericalManipulator.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation