OpenSceneGraph  3.5.1
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
osg::AnimationPathCallback Class Reference
Inheritance diagram for osg::AnimationPathCallback:
Inheritance graph
[legend]

Public Member Functions

 AnimationPathCallback ()
 
 AnimationPathCallback (const AnimationPathCallback &apc, const CopyOp &copyop)
 
 META_Object (osg, AnimationPathCallback)
 
 AnimationPathCallback (AnimationPath *ap, double timeOffset=0.0, double timeMultiplier=1.0)
 Construct an AnimationPathCallback with a specified animation path. More...
 
 AnimationPathCallback (const osg::Vec3d &pivot, const osg::Vec3d &axis, float angularVelocity)
 Construct an AnimationPathCallback and automatically create an animation path to produce a rotation about a point. More...
 
void setAnimationPath (AnimationPath *path)
 
AnimationPathgetAnimationPath ()
 
const AnimationPathgetAnimationPath () const
 
void setPivotPoint (const Vec3d &pivot)
 
const Vec3dgetPivotPoint () const
 
void setUseInverseMatrix (bool useInverseMatrix)
 
bool getUseInverseMatrix () const
 
void setTimeOffset (double offset)
 
double getTimeOffset () const
 
void setTimeMultiplier (double multiplier)
 
double getTimeMultiplier () const
 
virtual void reset ()
 
void setPause (bool pause)
 
bool getPause () const
 
virtual double getAnimationTime () const
 Get the animation time that is used to specify the position along the AnimationPath. More...
 
virtual void operator() (Node *node, NodeVisitor *nv)
 Implements the callback. More...
 
void update (osg::Node &node)
 
- Public Member Functions inherited from osg::NodeCallback
 NodeCallback ()
 
 NodeCallback (const NodeCallback &nc, const CopyOp &copyop)
 
 META_Object (osg, NodeCallback)
 
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...
 
- 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...
 
virtual const char * className () const =0
 return the name of the object's class type. 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 Attributes

ref_ptr< AnimationPath_animationPath
 
osg::Vec3d _pivotPoint
 
bool _useInverseMatrix
 
double _timeOffset
 
double _timeMultiplier
 
double _firstTime
 
double _latestTime
 
bool _pause
 
double _pauseTime
 

Protected Member Functions

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

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

Constructor & Destructor Documentation

osg::AnimationPathCallback::AnimationPathCallback ( )
inline
osg::AnimationPathCallback::AnimationPathCallback ( const AnimationPathCallback apc,
const CopyOp copyop 
)
inline
osg::AnimationPathCallback::AnimationPathCallback ( AnimationPath ap,
double  timeOffset = 0.0,
double  timeMultiplier = 1.0 
)
inline

Construct an AnimationPathCallback with a specified animation path.

osg::AnimationPathCallback::AnimationPathCallback ( const osg::Vec3d pivot,
const osg::Vec3d axis,
float  angularVelocity 
)

Construct an AnimationPathCallback and automatically create an animation path to produce a rotation about a point.

osg::AnimationPathCallback::~AnimationPathCallback ( )
inlineprotected

Member Function Documentation

AnimationPath* osg::AnimationPathCallback::getAnimationPath ( )
inline
const AnimationPath* osg::AnimationPathCallback::getAnimationPath ( ) const
inline
virtual double osg::AnimationPathCallback::getAnimationTime ( ) const
virtual

Get the animation time that is used to specify the position along the AnimationPath.

Animation time is computed from the formula: ((_latestTime-_firstTime)-_timeOffset)*_timeMultiplier.

bool osg::AnimationPathCallback::getPause ( ) const
inline
const Vec3d& osg::AnimationPathCallback::getPivotPoint ( ) const
inline
double osg::AnimationPathCallback::getTimeMultiplier ( ) const
inline
double osg::AnimationPathCallback::getTimeOffset ( ) const
inline
bool osg::AnimationPathCallback::getUseInverseMatrix ( ) const
inline
osg::AnimationPathCallback::META_Object ( osg  ,
AnimationPathCallback   
)
virtual void osg::AnimationPathCallback::operator() ( Node node,
NodeVisitor nv 
)
virtual

Implements the callback.

Reimplemented from osg::NodeCallback.

virtual void osg::AnimationPathCallback::reset ( )
virtual
void osg::AnimationPathCallback::setAnimationPath ( AnimationPath path)
inline
void osg::AnimationPathCallback::setPause ( bool  pause)
void osg::AnimationPathCallback::setPivotPoint ( const Vec3d pivot)
inline
void osg::AnimationPathCallback::setTimeMultiplier ( double  multiplier)
inline
void osg::AnimationPathCallback::setTimeOffset ( double  offset)
inline
void osg::AnimationPathCallback::setUseInverseMatrix ( bool  useInverseMatrix)
inline
void osg::AnimationPathCallback::update ( osg::Node node)

Member Data Documentation

ref_ptr<AnimationPath> osg::AnimationPathCallback::_animationPath
double osg::AnimationPathCallback::_firstTime
double osg::AnimationPathCallback::_latestTime
bool osg::AnimationPathCallback::_pause
double osg::AnimationPathCallback::_pauseTime
osg::Vec3d osg::AnimationPathCallback::_pivotPoint
double osg::AnimationPathCallback::_timeMultiplier
double osg::AnimationPathCallback::_timeOffset
bool osg::AnimationPathCallback::_useInverseMatrix

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

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