OpenSceneGraph 3.6.5
Public Types | Public Member Functions | Protected Attributes | List of all members
osgAnimation::Motion Class Referenceabstract

#include <EaseMotion>

Inheritance diagram for osgAnimation::Motion:
Inheritance graph
[legend]

Public Types

enum  TimeBehaviour { CLAMP , LOOP }
typedef float value_type

Public Member Functions

 Motion (float startValue=0, float duration=1, float changeValue=1, TimeBehaviour tb=CLAMP)
virtual ~Motion ()
void reset ()
float getTime () const
float evaluateTime (float time) const
void update (float dt)
void setTime (float time)
void getValue (value_type &result) const
value_type getValue () const
void getValueAt (float time, value_type &result) const
value_type getValueAt (float time) const
virtual void getValueInNormalizedRange (float t, value_type &result) const =0
float getDuration () const
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 &)
Referenced & operator= (const Referenced &)
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called.
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.
ObserverSet * getObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSet * getOrCreateObserverSet () 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.

Protected Attributes

float _time
float _startValue
float _changeValue
float _duration
TimeBehaviour _behaviour
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

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 DeleteHandler * getDeleteHandler ()
 Get a DeleteHandler.
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Member Typedef Documentation

◆ value_type

typedef float osgAnimation::Motion::value_type

Member Enumeration Documentation

◆ TimeBehaviour

enum osgAnimation::Motion::TimeBehaviour
Enumerator
CLAMP 
LOOP 

Constructor & Destructor Documentation

◆ Motion()

osgAnimation::Motion::Motion ( float startValue = 0,
float duration = 1,
float changeValue = 1,
TimeBehaviour tb = CLAMP )
inline

References _behaviour, _changeValue, _duration, _startValue, _time, and CLAMP.

Referenced by osgAnimation::CompositeMotion::CompositeMotion(), osgAnimation::CompositeMotion::getValueInNormalizedRange(), osgAnimation::MathMotionTemplate< LinearFunction >::MathMotionTemplate(), and osgAnimation::SamplerMotionTemplate< T >::SamplerMotionTemplate().

◆ ~Motion()

virtual osgAnimation::Motion::~Motion ( )
inlinevirtual

Member Function Documentation

◆ evaluateTime()

float osgAnimation::Motion::evaluateTime ( float time) const
inline

References _behaviour, _duration, CLAMP, and LOOP.

Referenced by getValueAt(), getValueAt(), setTime(), and update().

◆ getDuration()

float osgAnimation::Motion::getDuration ( ) const
inline

References _duration.

Referenced by osgAnimation::CompositeMotion::getValueInNormalizedRange().

◆ getTime()

float osgAnimation::Motion::getTime ( ) const
inline

References _time.

◆ getValue() [1/2]

value_type osgAnimation::Motion::getValue ( ) const
inline

References _time, and getValueAt().

◆ getValue() [2/2]

void osgAnimation::Motion::getValue ( value_type & result) const
inline

References _time, and getValueAt().

◆ getValueAt() [1/2]

value_type osgAnimation::Motion::getValueAt ( float time) const
inline

References evaluateTime(), and getValueAt().

◆ getValueAt() [2/2]

void osgAnimation::Motion::getValueAt ( float time,
value_type & result ) const
inline

References _changeValue, _duration, _startValue, evaluateTime(), and getValueInNormalizedRange().

Referenced by getValue(), getValue(), getValueAt(), and osgAnimation::CompositeMotion::getValueInNormalizedRange().

◆ getValueInNormalizedRange()

virtual void osgAnimation::Motion::getValueInNormalizedRange ( float t,
value_type & result ) const
pure virtual

Implemented in osgAnimation::CompositeMotion, osgAnimation::MathMotionTemplate< T >, osgAnimation::MathMotionTemplate< InBackFunction >, osgAnimation::MathMotionTemplate< InBounceFunction >, osgAnimation::MathMotionTemplate< InCircFunction >, osgAnimation::MathMotionTemplate< InCubicFunction >, osgAnimation::MathMotionTemplate< InElasticFunction >, osgAnimation::MathMotionTemplate< InExpoFunction >, osgAnimation::MathMotionTemplate< InOutBackFunction >, osgAnimation::MathMotionTemplate< InOutBounceFunction >, osgAnimation::MathMotionTemplate< InOutCircFunction >, osgAnimation::MathMotionTemplate< InOutCubicFunction >, osgAnimation::MathMotionTemplate< InOutElasticFunction >, osgAnimation::MathMotionTemplate< InOutExpoFunction >, osgAnimation::MathMotionTemplate< InOutQuadFunction >, osgAnimation::MathMotionTemplate< InOutQuartFunction >, osgAnimation::MathMotionTemplate< InOutSineFunction >, osgAnimation::MathMotionTemplate< InQuadFunction >, osgAnimation::MathMotionTemplate< InQuartFunction >, osgAnimation::MathMotionTemplate< InSineFunction >, osgAnimation::MathMotionTemplate< LinearFunction >, osgAnimation::MathMotionTemplate< OutBackFunction >, osgAnimation::MathMotionTemplate< OutBounceFunction >, osgAnimation::MathMotionTemplate< OutCircFunction >, osgAnimation::MathMotionTemplate< OutCubicFunction >, osgAnimation::MathMotionTemplate< OutElasticFunction >, osgAnimation::MathMotionTemplate< OutExpoFunction >, osgAnimation::MathMotionTemplate< OutQuadFunction >, osgAnimation::MathMotionTemplate< OutQuartFunction >, osgAnimation::MathMotionTemplate< OutSineFunction >, and osgAnimation::SamplerMotionTemplate< T >.

Referenced by getValueAt().

◆ reset()

void osgAnimation::Motion::reset ( )
inline

References setTime().

◆ setTime()

void osgAnimation::Motion::setTime ( float time)
inline

References _time, and evaluateTime().

Referenced by reset().

◆ update()

void osgAnimation::Motion::update ( float dt)
inline

References _time, and evaluateTime().

Member Data Documentation

◆ _behaviour

TimeBehaviour osgAnimation::Motion::_behaviour
protected

Referenced by evaluateTime(), and Motion().

◆ _changeValue

float osgAnimation::Motion::_changeValue
protected

Referenced by getValueAt(), and Motion().

◆ _duration

float osgAnimation::Motion::_duration
protected

Referenced by evaluateTime(), getDuration(), getValueAt(), and Motion().

◆ _startValue

float osgAnimation::Motion::_startValue
protected

Referenced by getValueAt(), and Motion().

◆ _time

float osgAnimation::Motion::_time
protected

Referenced by getTime(), getValue(), getValue(), Motion(), setTime(), and update().

The documentation for this class was generated from the following file:
osg logo
Generated at for the OpenSceneGraph by doxygen 1.15.0.