OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
osgAnimation::Animation Class Reference
Inheritance diagram for osgAnimation::Animation:
Inheritance graph
[legend]

List of all members.

Public Types

enum  PlayMode { ONCE, STAY, LOOP, PPONG }
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 META_Object (osgAnimation, Animation) Animation()
 Animation (const osgAnimation::Animation &, const osg::CopyOp &)
void addChannel (Channel *pChannel)
ChannelListgetChannels ()
 Those accessors let you add and remove channels if you modify something that can change the duration you are supposed to call computeDuration or setDuration.
const ChannelListgetChannels () const
void setDuration (double duration)
 Change the duration of animation then evaluate the animation in the range 0-duration it stretch the animation in time.
void computeDuration ()
 Compute duration from channel and keyframes if the duration is not specified you should call this method before using it.
double getDuration () const
void setWeight (float weight)
float getWeight () const
bool update (double time, int priority=0)
void resetTargets ()
void setPlayMode (PlayMode mode)
PlayMode getPlayMode () const
void setStartTime (double time)
double getStartTime () const
- 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.
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.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
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
 Convinience 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)
 Convinience 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.
- 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.
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 referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is 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.

Protected Member Functions

double computeDurationFromChannels () const
 ~Animation ()
- 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

Protected Attributes

double _duration
double _originalDuration
float _weight
double _startTime
PlayMode _playmode
ChannelList _channels
- 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

Member Enumeration Documentation

Enumerator:
ONCE 
STAY 
LOOP 
PPONG 

Constructor & Destructor Documentation

osgAnimation::Animation::Animation ( const osgAnimation::Animation ,
const osg::CopyOp  
)
osgAnimation::Animation::~Animation ( )
inlineprotected

Member Function Documentation

void osgAnimation::Animation::addChannel ( Channel pChannel)
void osgAnimation::Animation::computeDuration ( )

Compute duration from channel and keyframes if the duration is not specified you should call this method before using it.

double osgAnimation::Animation::computeDurationFromChannels ( ) const
protected
ChannelList& osgAnimation::Animation::getChannels ( )

Those accessors let you add and remove channels if you modify something that can change the duration you are supposed to call computeDuration or setDuration.

Referenced by osgAnimation::AnimationUpdateCallback< osg::StateAttributeCallback >::link().

const ChannelList& osgAnimation::Animation::getChannels ( ) const
double osgAnimation::Animation::getDuration ( ) const
PlayMode osgAnimation::Animation::getPlayMode ( ) const
inline
double osgAnimation::Animation::getStartTime ( ) const
inline
float osgAnimation::Animation::getWeight ( ) const
osgAnimation::Animation::META_Object ( osgAnimation  ,
Animation   
)
inline
void osgAnimation::Animation::resetTargets ( )
void osgAnimation::Animation::setDuration ( double  duration)

Change the duration of animation then evaluate the animation in the range 0-duration it stretch the animation in time.

see computeDuration too

void osgAnimation::Animation::setPlayMode ( PlayMode  mode)
inline
void osgAnimation::Animation::setStartTime ( double  time)
inline
void osgAnimation::Animation::setWeight ( float  weight)
bool osgAnimation::Animation::update ( double  time,
int  priority = 0 
)

Member Data Documentation

ChannelList osgAnimation::Animation::_channels
protected
double osgAnimation::Animation::_duration
protected
double osgAnimation::Animation::_originalDuration
protected
PlayMode osgAnimation::Animation::_playmode
protected
double osgAnimation::Animation::_startTime
protected
float osgAnimation::Animation::_weight
protected

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

osg logo
Generated at Tue Oct 9 2012 08:34:55 for the OpenSceneGraph by doxygen 1.8.1.1.