openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgGA::SphericalManipulator Class Reference

#include <SphericalManipulator>

Inheritance diagram for osgGA::SphericalManipulator:
osgGA::CameraManipulator osgGA::GUIEventHandler osgGA::EventHandler osg::NodeCallback osg::DrawableEventCallback osg::Callback osg::Callback osg::Object osg::Object osg::Referenced osg::Referenced

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::NodegetNode () const
 
virtual osg::NodegetNode ()
 
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::Vec3dgetCenter () 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)
 
CoordinateFrameCallbackgetCoordinateFrameCallback ()
 
const CoordinateFrameCallbackgetCoordinateFrameCallback () 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 NodeCallbackasNodeCallback ()
 
virtual const NodeCallbackasNodeCallback () const
 
virtual DrawableEventCallbackasDrawableEventCallback ()
 
virtual const DrawableEventCallbackasDrawableEventCallback () const
 
virtual EventHandlerasEventHandler ()
 
virtual const EventHandlerasEventHandler () const
 
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)
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual StateAttributeCallbackasStateAttributeCallback ()
 
virtual const StateAttributeCallbackasStateAttributeCallback () const
 
virtual UniformCallbackasUniformCallback ()
 
virtual const UniformCallbackasUniformCallback () const
 
virtual DrawableUpdateCallbackasDrawableUpdateCallback ()
 
virtual const DrawableUpdateCallbackasDrawableUpdateCallback () const
 
virtual DrawableCullCallbackasDrawableCullCallback ()
 
virtual const DrawableCullCallbackasDrawableCullCallback () const
 
bool traverse (osg::Object *object, osg::Object *data)
 
void setNestedCallback (osg::Callback *cb)
 
osg::CallbackgetNestedCallback ()
 
const osg::CallbackgetNestedCallback () 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 ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () 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)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () 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 &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 
- Public Member Functions inherited from osg::DrawableEventCallback
 DrawableEventCallback ()
 
 DrawableEventCallback (const DrawableEventCallback &org, const CopyOp &copyop)
 
 META_Object (osg, DrawableEventCallback)
 

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::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Member Enumeration Documentation

◆ RotationMode

Enumerator
ELEVATION_HEADING 
HEADING 
ELEVATION 
MAP 

Constructor & Destructor Documentation

◆ SphericalManipulator()

osgGA::SphericalManipulator::SphericalManipulator ( )

◆ ~SphericalManipulator()

virtual osgGA::SphericalManipulator::~SphericalManipulator ( )
protectedvirtual

Member Function Documentation

◆ addMouseEvent()

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

Add the current mouse GUIEvent to internal stack.

◆ calcMovement()

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.

◆ className()

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.

◆ computeHomePosition()

virtual void osgGA::SphericalManipulator::computeHomePosition ( )
virtual

Compute the home position.

◆ computeViewPosition()

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

◆ flushMouseEventStack()

void osgGA::SphericalManipulator::flushMouseEventStack ( )
protected

Reset the internal GUIEvent stack.

◆ getAllowThrow()

bool osgGA::SphericalManipulator::getAllowThrow ( ) const
inline

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

◆ getCenter()

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

◆ getDistance()

double osgGA::SphericalManipulator::getDistance ( ) const
inline

◆ getElevtion()

double osgGA::SphericalManipulator::getElevtion ( ) const
inline

◆ getFusionDistanceMode()

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

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

Reimplemented from osgGA::CameraManipulator.

◆ getFusionDistanceValue()

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

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

Reimplemented from osgGA::CameraManipulator.

◆ getHeading()

double osgGA::SphericalManipulator::getHeading ( ) const
inline

◆ getHomeDistance()

double osgGA::SphericalManipulator::getHomeDistance ( ) const
inline

◆ getInverseMatrix()

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.

◆ getMatrix()

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

get the position of the manipulator as 4x4 Matrix.

Implements osgGA::CameraManipulator.

◆ getMinimumZoomScale()

double osgGA::SphericalManipulator::getMinimumZoomScale ( ) const
inline

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

◆ getNode() [1/2]

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

Return node if attached.

Reimplemented from osgGA::CameraManipulator.

◆ getNode() [2/2]

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

Return node if attached.

Reimplemented from osgGA::CameraManipulator.

◆ getRotationMode()

RotationMode osgGA::SphericalManipulator::getRotationMode ( ) const
inline

◆ getScroolWheelZoomDelta()

double osgGA::SphericalManipulator::getScroolWheelZoomDelta ( ) const
inline

get the mouse scroll wheel zoom delta.

◆ getUsage()

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

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

◆ handle()

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.

◆ home() [1/2]

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.

◆ home() [2/2]

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.

◆ init()

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

Start/restart the manipulator.

Reimplemented from osgGA::CameraManipulator.

◆ isMouseMoving()

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.

◆ setAllowThrow()

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

Set the 'allow throw' flag. Releasing the mouse button while moving the camera results in a throw.

◆ setByInverseMatrix()

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

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

Implements osgGA::CameraManipulator.

◆ setByMatrix()

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

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

Implements osgGA::CameraManipulator.

◆ setCenter()

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

◆ setDistance()

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

◆ setElevation()

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

◆ setHeading()

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

◆ setMinimumZoomScale()

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.

◆ setNode()

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.

◆ setRotationMode()

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

◆ setScroolWheelZoomDelta()

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.

◆ zoomOn()

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

Member Data Documentation

◆ _allowThrow

bool osgGA::SphericalManipulator::_allowThrow
protected

◆ _center

osg::Vec3d osgGA::SphericalManipulator::_center
protected

◆ _delta_frame_time

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.

◆ _distance

double osgGA::SphericalManipulator::_distance
protected

◆ _elevation

double osgGA::SphericalManipulator::_elevation
protected

◆ _ga_t0

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

◆ _ga_t1

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

◆ _heading

double osgGA::SphericalManipulator::_heading
protected

◆ _homeDistance

double osgGA::SphericalManipulator::_homeDistance
protected

◆ _last_frame_time

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.

◆ _minimumZoomScale

double osgGA::SphericalManipulator::_minimumZoomScale
protected

◆ _modelScale

double osgGA::SphericalManipulator::_modelScale
protected

◆ _node

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

◆ _rotationMode

RotationMode osgGA::SphericalManipulator::_rotationMode
protected

◆ _thrown

bool osgGA::SphericalManipulator::_thrown
protected

◆ _zoomDelta

double osgGA::SphericalManipulator::_zoomDelta
protected

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