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

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

Inheritance diagram for osgGA::CameraManipulator:
Inheritance graph
[legend]

Classes

class  CoordinateFrameCallback
 callback class to use to allow matrix manipulators to query the application for the local coordinate frame. More...
 

Public Member Functions

virtual const char * className () const
 return the name of the object's class type. More...
 
virtual void setCoordinateFrameCallback (CoordinateFrameCallback *cb)
 set the coordinate frame which callback tells the manipulator which way is up, east and north. More...
 
CoordinateFrameCallbackgetCoordinateFrameCallback ()
 get the coordinate frame callback which tells the manipulator which way is up, east and north. More...
 
const CoordinateFrameCallbackgetCoordinateFrameCallback () 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 setByMatrix (const osg::Matrixd &matrix)=0
 set the position of the matrix manipulator using a 4x4 Matrix. More...
 
virtual void setByInverseMatrix (const osg::Matrixd &matrix)=0
 set the position of the matrix manipulator using a 4x4 Matrix. More...
 
virtual osg::Matrixd getMatrix () const =0
 get the position of the manipulator as 4x4 Matrix. More...
 
virtual osg::Matrixd getInverseMatrix () const =0
 get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix. More...
 
virtual void updateCamera (osg::Camera &camera)
 update the camera for the current frame, typically called by the viewer classes. More...
 
virtual osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode () const
 Get the FusionDistanceMode. More...
 
virtual float getFusionDistanceValue () const
 Get the FusionDistanceValue. 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 setNode (osg::Node *)
 Attach a node to the manipulator, automatically detaching any previously attached node. More...
 
virtual const osg::NodegetNode () const
 Return const node if attached. More...
 
virtual osg::NodegetNode ()
 Return node if attached. 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 void home (const GUIEventAdapter &, GUIActionAdapter &)
 Move the camera to the default position. More...
 
virtual void home (double)
 Move the camera to the default position. More...
 
virtual void init (const GUIEventAdapter &, GUIActionAdapter &)
 Start/restart the manipulator. More...
 
virtual bool handle (osgGA::Event *event, osg::Object *object, osg::NodeVisitor *nv)
 Handle event. More...
 
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &us)
 Handle events, return true if handled, false otherwise. 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...
 
virtual void getUsage (osg::ApplicationUsage &) const
 Get the user interface usage of this event handler, i.e. 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::CallbackgetNestedCallback ()
 
const osg::CallbackgetNestedCallback () 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 ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (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 NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () 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::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 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 ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () 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 &)
 
Referencedoperator= (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...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () 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

 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

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::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 DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

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

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

Member Function Documentation

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

Compute the home position.

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

finish any active manipulator animations.

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

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

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

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

get the coordinate frame.

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

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

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

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

osg::Vec3d osgGA::CameraManipulator::getFrontVector ( const osg::CoordinateFrame cf) const
inline
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.

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.

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

Get the manually set home position.

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.

virtual osg::Matrixd osgGA::CameraManipulator::getInverseMatrix ( ) const
pure virtual
std::string osgGA::CameraManipulator::getManipulatorName ( ) const
protected
virtual osg::Matrixd osgGA::CameraManipulator::getMatrix ( ) const
pure virtual
virtual const osg::Node* osgGA::CameraManipulator::getNode ( ) const
inlinevirtual
virtual osg::Node* osgGA::CameraManipulator::getNode ( )
inlinevirtual
osg::Vec3d osgGA::CameraManipulator::getSideVector ( const osg::CoordinateFrame cf) const
inline
osg::Vec3d osgGA::CameraManipulator::getUpVector ( const osg::CoordinateFrame cf) const
inline
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.

virtual bool osgGA::CameraManipulator::handle ( const GUIEventAdapter ea,
GUIActionAdapter us 
)
virtual
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::KeySwitchMatrixManipulator, osgGA::UFOManipulator, osgGA::AnimationPathManipulator, osgGA::StandardManipulator, osgGA::SphericalManipulator, osgGA::FirstPersonManipulator, osgGA::DriveManipulator, and osgGA::FlightManipulator.

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

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

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

Reimplemented in osgGA::KeySwitchMatrixManipulator.

virtual void osgGA::CameraManipulator::setByInverseMatrix ( const osg::Matrixd matrix)
pure virtual
virtual void osgGA::CameraManipulator::setByMatrix ( const osg::Matrixd matrix)
pure virtual
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.

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.

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.

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

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

bool osgGA::CameraManipulator::_autoComputeHomePosition
protected
osg::ref_ptr<CoordinateFrameCallback> osgGA::CameraManipulator::_coordinateFrameCallback
protected
osg::Vec3d osgGA::CameraManipulator::_homeCenter
protected
osg::Vec3d osgGA::CameraManipulator::_homeEye
protected
osg::Vec3d osgGA::CameraManipulator::_homeUp
protected
unsigned int osgGA::CameraManipulator::_intersectTraversalMask
protected

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

osg logo
Generated at Wed Nov 11 2015 22:14:57 for the OpenSceneGraph by doxygen 1.8.10.