openscenegraph
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgGA::CameraManipulator Class Referenceabstract

#include <CameraManipulator>

Inheritance diagram for osgGA::CameraManipulator:
osgGA::GUIEventHandler osgGA::EventHandler osg::NodeCallback osg::DrawableEventCallback osg::Callback osg::Callback osg::Object osg::Object osg::Referenced osg::Referenced osgGA::AnimationPathManipulator osgGA::CameraViewSwitchManipulator osgGA::DriveManipulator osgGA::KeySwitchMatrixManipulator osgGA::SphericalManipulator osgGA::StandardManipulator osgGA::UFOManipulator osgGA::FirstPersonManipulator osgGA::OrbitManipulator osgGA::FlightManipulator osgGA::NodeTrackerManipulator osgGA::TerrainManipulator osgGA::TrackballManipulator osgGA::MultiTouchTrackballManipulator

Classes

class  CoordinateFrameCallback
 

Public Member Functions

virtual const char * className () const
 
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 setByMatrix (const osg::Matrixd &matrix)=0
 
virtual void setByInverseMatrix (const osg::Matrixd &matrix)=0
 
virtual osg::Matrixd getMatrix () const =0
 
virtual osg::Matrixd getInverseMatrix () const =0
 
virtual void updateCamera (osg::Camera &camera)
 
virtual osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode () const
 
virtual float getFusionDistanceValue () const
 
void setIntersectTraversalMask (unsigned int mask)
 
unsigned int getIntersectTraversalMask () const
 
virtual void setNode (osg::Node *)
 
virtual const osg::NodegetNode () const
 
virtual osg::NodegetNode ()
 
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 void home (const GUIEventAdapter &, GUIActionAdapter &)
 
virtual void home (double)
 
virtual void init (const GUIEventAdapter &, GUIActionAdapter &)
 
virtual bool handle (osgGA::Event *event, osg::Object *object, osg::NodeVisitor *nv)
 
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &us)
 
- 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)
 
virtual void getUsage (osg::ApplicationUsage &) const
 
- 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

 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

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

- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

CameraManipulator is an abstract base class defining the interface, and a certain amount of default functionality, for classes which wish to control OSG cameras in response to GUI events.

Constructor & Destructor Documentation

◆ CameraManipulator() [1/2]

osgGA::CameraManipulator::CameraManipulator ( )
protected

◆ CameraManipulator() [2/2]

osgGA::CameraManipulator::CameraManipulator ( const CameraManipulator mm,
const osg::CopyOp copyOp = osg::CopyOp::SHALLOW_COPY 
)
protected

◆ ~CameraManipulator()

virtual osgGA::CameraManipulator::~CameraManipulator ( )
protectedvirtual

Member Function Documentation

◆ className()

virtual const char * osgGA::CameraManipulator::className ( ) const
inlinevirtual

◆ computeHomePosition()

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

Compute the home position.

◆ finishAnimation()

virtual void osgGA::CameraManipulator::finishAnimation ( )
inlinevirtual

finish any active manipulator animations.

Reimplemented in osgGA::KeySwitchMatrixManipulator, and osgGA::StandardManipulator.

◆ getAutoComputeHomePosition()

bool osgGA::CameraManipulator::getAutoComputeHomePosition ( ) const
inline

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

◆ getCoordinateFrame()

osg::CoordinateFrame osgGA::CameraManipulator::getCoordinateFrame ( const osg::Vec3d position) const
inline

get the coordinate frame.

◆ getCoordinateFrameCallback() [1/2]

CoordinateFrameCallback * osgGA::CameraManipulator::getCoordinateFrameCallback ( )
inline

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

◆ getCoordinateFrameCallback() [2/2]

const CoordinateFrameCallback * osgGA::CameraManipulator::getCoordinateFrameCallback ( ) const
inline

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

◆ getFrontVector()

osg::Vec3d osgGA::CameraManipulator::getFrontVector ( const osg::CoordinateFrame cf) const
inline

◆ getFusionDistanceMode()

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

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

Reimplemented in osgGA::KeySwitchMatrixManipulator, osgGA::OrbitManipulator, and osgGA::SphericalManipulator.

◆ getFusionDistanceValue()

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

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

Reimplemented in osgGA::KeySwitchMatrixManipulator, osgGA::OrbitManipulator, and osgGA::SphericalManipulator.

◆ getHomePosition()

virtual void osgGA::CameraManipulator::getHomePosition ( osg::Vec3d eye,
osg::Vec3d center,
osg::Vec3d up 
) const
inlinevirtual

Get the manually set home position.

◆ getIntersectTraversalMask()

unsigned int osgGA::CameraManipulator::getIntersectTraversalMask ( ) const
inline

Get the mask to use when set up intersection traversal such as used in manipulators that follow terrain or have collision detection.

◆ getInverseMatrix()

virtual osg::Matrixd osgGA::CameraManipulator::getInverseMatrix ( ) const
pure virtual

◆ getManipulatorName()

std::string osgGA::CameraManipulator::getManipulatorName ( ) const
protected

◆ getMatrix()

virtual osg::Matrixd osgGA::CameraManipulator::getMatrix ( ) const
pure virtual

◆ getNode() [1/2]

virtual osg::Node * osgGA::CameraManipulator::getNode ( )
inlinevirtual

◆ getNode() [2/2]

virtual const osg::Node * osgGA::CameraManipulator::getNode ( ) const
inlinevirtual

◆ getSideVector()

osg::Vec3d osgGA::CameraManipulator::getSideVector ( const osg::CoordinateFrame cf) const
inline

◆ getUpVector()

osg::Vec3d osgGA::CameraManipulator::getUpVector ( const osg::CoordinateFrame cf) const
inline

◆ handle() [1/2]

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

◆ handle() [2/2]

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

Handle event. Override the handle(..) method in your event handlers to respond to events.

Reimplemented from osgGA::GUIEventHandler.

◆ home() [1/2]

virtual void osgGA::CameraManipulator::home ( const GUIEventAdapter ,
GUIActionAdapter  
)
inlinevirtual

Move the camera to the default position. May be ignored by manipulators if home functionality is not appropriate.

Reimplemented in osgGA::AnimationPathManipulator, osgGA::DriveManipulator, osgGA::KeySwitchMatrixManipulator, osgGA::UFOManipulator, osgGA::FirstPersonManipulator, osgGA::FlightManipulator, osgGA::SphericalManipulator, and osgGA::StandardManipulator.

◆ home() [2/2]

virtual void osgGA::CameraManipulator::home ( double  )
inlinevirtual

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 in osgGA::AnimationPathManipulator, osgGA::FirstPersonManipulator, osgGA::SphericalManipulator, osgGA::StandardManipulator, and osgGA::UFOManipulator.

◆ init()

virtual void osgGA::CameraManipulator::init ( const GUIEventAdapter ,
GUIActionAdapter  
)
inlinevirtual

◆ setAutoComputeHomePosition()

virtual void osgGA::CameraManipulator::setAutoComputeHomePosition ( bool  flag)
inlinevirtual

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

Reimplemented in osgGA::KeySwitchMatrixManipulator.

◆ setByInverseMatrix()

virtual void osgGA::CameraManipulator::setByInverseMatrix ( const osg::Matrixd matrix)
pure virtual

◆ setByMatrix()

virtual void osgGA::CameraManipulator::setByMatrix ( const osg::Matrixd matrix)
pure virtual

◆ setCoordinateFrameCallback()

virtual void osgGA::CameraManipulator::setCoordinateFrameCallback ( CoordinateFrameCallback cb)
inlinevirtual

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

Reimplemented in osgGA::KeySwitchMatrixManipulator.

◆ setHomePosition()

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

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

Reimplemented in osgGA::KeySwitchMatrixManipulator.

◆ setIntersectTraversalMask()

void osgGA::CameraManipulator::setIntersectTraversalMask ( unsigned int  mask)
inline

Set the mask to use when set up intersection traversal such as used in manipulators that follow terrain or have collision detection. The intersection traversal mask is useful for controlling what parts of the scene graph should be used for intersection purposes.

◆ setNode()

virtual void osgGA::CameraManipulator::setNode ( osg::Node )
inlinevirtual

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 in osgGA::CameraViewSwitchManipulator, osgGA::DriveManipulator, osgGA::NodeTrackerManipulator, osgGA::SphericalManipulator, osgGA::StandardManipulator, osgGA::KeySwitchMatrixManipulator, osgGA::TerrainManipulator, and osgGA::UFOManipulator.

◆ updateCamera()

virtual void osgGA::CameraManipulator::updateCamera ( osg::Camera camera)
inlinevirtual

update the camera for the current frame, typically called by the viewer classes. Default implementation simply set the camera view matrix.

Member Data Documentation

◆ _autoComputeHomePosition

bool osgGA::CameraManipulator::_autoComputeHomePosition
protected

◆ _coordinateFrameCallback

osg::ref_ptr<CoordinateFrameCallback> osgGA::CameraManipulator::_coordinateFrameCallback
protected

◆ _homeCenter

osg::Vec3d osgGA::CameraManipulator::_homeCenter
protected

◆ _homeEye

osg::Vec3d osgGA::CameraManipulator::_homeEye
protected

◆ _homeUp

osg::Vec3d osgGA::CameraManipulator::_homeUp
protected

◆ _intersectTraversalMask

unsigned int osgGA::CameraManipulator::_intersectTraversalMask
protected

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