OpenSceneGraph 3.6.5
osg::AnimationPathCallback Class Reference

#include <AnimationPath>

Inheritance diagram for osg::AnimationPathCallback:

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.
 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.
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.
virtual void operator() (Node *node, NodeVisitor *nv)
 Implements the callback.
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 NodeCallbackasNodeCallback ()
virtual const NodeCallbackasNodeCallback () const
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.
Public Member Functions inherited from osg::Callback
 Callback ()
 Callback (const Callback &cb, const CopyOp &copyop)
 META_Object (osg, Callback)
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual StateAttributeCallbackasStateAttributeCallback ()
virtual const StateAttributeCallbackasStateAttributeCallback () const
virtual UniformCallbackasUniformCallback ()
virtual const UniformCallbackasUniformCallback () const
virtual DrawableUpdateCallbackasDrawableUpdateCallback ()
virtual const DrawableUpdateCallbackasDrawableUpdateCallback () const
virtual DrawableEventCallbackasDrawableEventCallback ()
virtual const DrawableEventCallbackasDrawableEventCallback () const
virtual DrawableCullCallbackasDrawableCullCallback ()
virtual const DrawableCullCallbackasDrawableCullCallback () const
virtual osgGA::EventHandlerasEventHandler ()
virtual const osgGA::EventHandlerasEventHandler () const
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.
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.
 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.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
 return the name of the object's library.
virtual const char * className () const =0
 return the name of the object's class type.
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name.
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
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.
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.
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
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
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

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.
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.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.
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

◆ AnimationPathCallback() [1/4]

osg::AnimationPathCallback::AnimationPathCallback ( )
inline

◆ AnimationPathCallback() [2/4]

osg::AnimationPathCallback::AnimationPathCallback ( const AnimationPathCallback & apc,
const CopyOp & copyop )
inline

◆ AnimationPathCallback() [3/4]

osg::AnimationPathCallback::AnimationPathCallback ( AnimationPath * ap,
double timeOffset = 0.0,
double timeMultiplier = 1.0 )
inline

◆ AnimationPathCallback() [4/4]

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.

◆ ~AnimationPathCallback()

osg::AnimationPathCallback::~AnimationPathCallback ( )
inlineprotected

Member Function Documentation

◆ getAnimationPath() [1/2]

AnimationPath * osg::AnimationPathCallback::getAnimationPath ( )
inline

References _animationPath.

◆ getAnimationPath() [2/2]

const AnimationPath * osg::AnimationPathCallback::getAnimationPath ( ) const
inline

References _animationPath.

◆ getAnimationTime()

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.

◆ getPause()

bool osg::AnimationPathCallback::getPause ( ) const
inline

References _pause.

◆ getPivotPoint()

const Vec3d & osg::AnimationPathCallback::getPivotPoint ( ) const
inline

References _pivotPoint.

◆ getTimeMultiplier()

double osg::AnimationPathCallback::getTimeMultiplier ( ) const
inline

References _timeMultiplier.

◆ getTimeOffset()

double osg::AnimationPathCallback::getTimeOffset ( ) const
inline

References _timeOffset.

◆ getUseInverseMatrix()

bool osg::AnimationPathCallback::getUseInverseMatrix ( ) const
inline

References _useInverseMatrix.

◆ META_Object()

osg::AnimationPathCallback::META_Object ( osg ,
AnimationPathCallback  )

◆ operator()()

virtual void osg::AnimationPathCallback::operator() ( Node * node,
NodeVisitor * nv )
virtual

Implements the callback.

Reimplemented from osg::NodeCallback.

◆ reset()

virtual void osg::AnimationPathCallback::reset ( )
virtual

◆ setAnimationPath()

void osg::AnimationPathCallback::setAnimationPath ( AnimationPath * path)
inline

References _animationPath.

◆ setPause()

void osg::AnimationPathCallback::setPause ( bool pause)

◆ setPivotPoint()

void osg::AnimationPathCallback::setPivotPoint ( const Vec3d & pivot)
inline

References _pivotPoint.

◆ setTimeMultiplier()

void osg::AnimationPathCallback::setTimeMultiplier ( double multiplier)
inline

References _timeMultiplier.

◆ setTimeOffset()

void osg::AnimationPathCallback::setTimeOffset ( double offset)
inline

References _timeOffset.

◆ setUseInverseMatrix()

void osg::AnimationPathCallback::setUseInverseMatrix ( bool useInverseMatrix)
inline

References _useInverseMatrix.

◆ update()

void osg::AnimationPathCallback::update ( osg::Node & node)

Member Data Documentation

◆ _animationPath

◆ _firstTime

double osg::AnimationPathCallback::_firstTime

◆ _latestTime

double osg::AnimationPathCallback::_latestTime

◆ _pause

bool osg::AnimationPathCallback::_pause

◆ _pauseTime

double osg::AnimationPathCallback::_pauseTime

◆ _pivotPoint

◆ _timeMultiplier

double osg::AnimationPathCallback::_timeMultiplier

◆ _timeOffset

double osg::AnimationPathCallback::_timeOffset

◆ _useInverseMatrix

bool osg::AnimationPathCallback::_useInverseMatrix

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

osg logo
Generated at Wed Jul 23 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.