openscenegraph
osgGA::AnimationPathManipulator Class Reference

#include <AnimationPathManipulator>

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

Classes

struct  AnimationCompletedCallback

Public Member Functions

 AnimationPathManipulator (osg::AnimationPath *animationPath=0)
 AnimationPathManipulator (const std::string &filename)
virtual const char * className () const
void setTimeScale (double s)
double getTimeScale () const
void setTimeOffset (double o)
double getTimeOffset () const
void setAnimationCompletedCallback (AnimationCompletedCallback *acc)
AnimationCompletedCallbackgetAnimationCompletedCallback ()
const AnimationCompletedCallbackgetAnimationCompletedCallback () const
void setPrintOutTimingInfo (bool printOutTimingInfo)
bool getPrintOutTimingInfo () 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
void setAnimationPath (osg::AnimationPath *animationPath)
osg::AnimationPathgetAnimationPath ()
const osg::AnimationPathgetAnimationPath () const
bool valid () const
void init (const GUIEventAdapter &ea, GUIActionAdapter &us)
void home (const GUIEventAdapter &ea, GUIActionAdapter &us)
void home (double currentTime)
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &us)
virtual void getUsage (osg::ApplicationUsage &usage) const
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)
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 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

void handleFrame (double time)
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

bool _valid
bool _printOutTimingInfo
osg::ref_ptr< osg::AnimationPath_animationPath
double _timeOffset
double _timeScale
osg::ref_ptr< AnimationCompletedCallback_animationCompletedCallback
double _pauseTime
bool _isPaused
double _realStartOfTimedPeriod
double _animStartOfTimedPeriod
int _numOfFramesSinceStartOfTimedPeriod
osg::Matrixd _matrix
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

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

Constructor & Destructor Documentation

◆ AnimationPathManipulator() [1/2]

osgGA::AnimationPathManipulator::AnimationPathManipulator ( osg::AnimationPath * animationPath = 0)

◆ AnimationPathManipulator() [2/2]

osgGA::AnimationPathManipulator::AnimationPathManipulator ( const std::string & filename)

Member Function Documentation

◆ className()

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

return the name of the object's class type. Must be defined by derived classes.

Reimplemented from osgGA::CameraManipulator.

◆ getAnimationCompletedCallback() [1/2]

AnimationCompletedCallback * osgGA::AnimationPathManipulator::getAnimationCompletedCallback ( )
inline

◆ getAnimationCompletedCallback() [2/2]

const AnimationCompletedCallback * osgGA::AnimationPathManipulator::getAnimationCompletedCallback ( ) const
inline

◆ getAnimationPath() [1/2]

osg::AnimationPath * osgGA::AnimationPathManipulator::getAnimationPath ( )
inline

References _animationPath.

◆ getAnimationPath() [2/2]

const osg::AnimationPath * osgGA::AnimationPathManipulator::getAnimationPath ( ) const
inline

References _animationPath.

◆ getInverseMatrix()

virtual osg::Matrixd osgGA::AnimationPathManipulator::getInverseMatrix ( ) const
inlinevirtual

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

Implements osgGA::CameraManipulator.

References _matrix, and osg::Matrixd::inverse().

◆ getMatrix()

virtual osg::Matrixd osgGA::AnimationPathManipulator::getMatrix ( ) const
inlinevirtual

get the position of the manipulator as 4x4 Matrix.

Implements osgGA::CameraManipulator.

References _matrix.

◆ getPrintOutTimingInfo()

bool osgGA::AnimationPathManipulator::getPrintOutTimingInfo ( ) const
inline

References _printOutTimingInfo.

◆ getTimeOffset()

double osgGA::AnimationPathManipulator::getTimeOffset ( ) const
inline

References _timeOffset.

◆ getTimeScale()

double osgGA::AnimationPathManipulator::getTimeScale ( ) const
inline

References _timeScale.

◆ getUsage()

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

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

◆ handle()

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

Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::CameraManipulator.

◆ handleFrame()

void osgGA::AnimationPathManipulator::handleFrame ( double time)
protected

◆ home() [1/2]

void osgGA::AnimationPathManipulator::home ( const GUIEventAdapter & ,
GUIActionAdapter &  )
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]

void osgGA::AnimationPathManipulator::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()

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

Start/restart the manipulator.

Reimplemented from osgGA::CameraManipulator.

◆ setAnimationCompletedCallback()

void osgGA::AnimationPathManipulator::setAnimationCompletedCallback ( AnimationCompletedCallback * acc)
inline

◆ setAnimationPath()

void osgGA::AnimationPathManipulator::setAnimationPath ( osg::AnimationPath * animationPath)
inline

References _animationPath.

◆ setByInverseMatrix()

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

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

Implements osgGA::CameraManipulator.

References _matrix.

◆ setByMatrix()

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

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

Implements osgGA::CameraManipulator.

References _matrix.

◆ setPrintOutTimingInfo()

void osgGA::AnimationPathManipulator::setPrintOutTimingInfo ( bool printOutTimingInfo)
inline

References _printOutTimingInfo.

◆ setTimeOffset()

void osgGA::AnimationPathManipulator::setTimeOffset ( double o)
inline

References _timeOffset.

◆ setTimeScale()

void osgGA::AnimationPathManipulator::setTimeScale ( double s)
inline

References _timeScale.

◆ valid()

bool osgGA::AnimationPathManipulator::valid ( ) const
inline

References _animationPath.

Member Data Documentation

◆ _animationCompletedCallback

osg::ref_ptr<AnimationCompletedCallback> osgGA::AnimationPathManipulator::_animationCompletedCallback
protected

◆ _animationPath

osg::ref_ptr<osg::AnimationPath> osgGA::AnimationPathManipulator::_animationPath
protected

◆ _animStartOfTimedPeriod

double osgGA::AnimationPathManipulator::_animStartOfTimedPeriod
protected

◆ _isPaused

bool osgGA::AnimationPathManipulator::_isPaused
protected

◆ _matrix

osg::Matrixd osgGA::AnimationPathManipulator::_matrix
protected

◆ _numOfFramesSinceStartOfTimedPeriod

int osgGA::AnimationPathManipulator::_numOfFramesSinceStartOfTimedPeriod
protected

◆ _pauseTime

double osgGA::AnimationPathManipulator::_pauseTime
protected

◆ _printOutTimingInfo

bool osgGA::AnimationPathManipulator::_printOutTimingInfo
protected

◆ _realStartOfTimedPeriod

double osgGA::AnimationPathManipulator::_realStartOfTimedPeriod
protected

◆ _timeOffset

double osgGA::AnimationPathManipulator::_timeOffset
protected

Referenced by getTimeOffset(), and setTimeOffset().

◆ _timeScale

double osgGA::AnimationPathManipulator::_timeScale
protected

Referenced by getTimeScale(), and setTimeScale().

◆ _valid

bool osgGA::AnimationPathManipulator::_valid
protected

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