Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

nvsg::Animation< T > Class Template Reference

Class defining the common interface of an animation. More...

#include <Animation.h>

Inheritance diagram for nvsg::Animation< T >:

Inheritance graph
[legend]
Collaboration diagram for nvsg::Animation< T >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual const Animation< T > * clone (void) const =0
 Interface for creating a clone of this animation.
virtual size_t getNumberOfFrames (void) const =0
 Get the number of frames in the animation.
virtual const T & operator[] (size_t i) const =0
 Random access operator for more convenient usage, constant version only.
virtual DataID getDataID (void) const
 Get the DataID of the data of this object.
virtual bool isDataShared (void) const
 Determine whether the data of this object is shared.

Protected Member Functions

 Animation (void)
 Protected constructor.
virtual ~Animation (void)
 Protected destructor to prevent explicit creation on stack.

Detailed Description

template<typename T>
class nvsg::Animation< T >

Class defining the common interface of an animation.

An Animation is a pure virtual template class derived from Object that defines the common interface of an animation.


Constructor & Destructor Documentation

template<typename T>
nvsg::Animation< T >::Animation void   )  [protected]
 

Protected constructor.

template<typename T>
nvsg::Animation< T >::~Animation void   )  [protected, virtual]
 

Protected destructor to prevent explicit creation on stack.


Member Function Documentation

template<typename T>
virtual const Animation<T>* nvsg::Animation< T >::clone void   )  const [pure virtual]
 

Interface for creating a clone of this animation.

Returns:
pointer to the new animation

Implemented in nvsg::FramedAnimation< T >, and nvsg::LinearInterpolatedAnimation< T >.

template<typename T>
virtual size_t nvsg::Animation< T >::getNumberOfFrames void   )  const [pure virtual]
 

Get the number of frames in the animation.

Returns:
number of animation frames

Implemented in nvsg::FramedAnimation< T >, and nvsg::InterpolatedAnimation< T >.

template<typename T>
virtual const T& nvsg::Animation< T >::operator[] size_t  i  )  const [pure virtual]
 

Random access operator for more convenient usage, constant version only.

Returns:
constant reference to value of frame i

Implemented in nvsg::FramedAnimation< T >, and nvsg::LinearInterpolatedAnimation< T >.

template<typename T>
DataID nvsg::Animation< T >::getDataID void   )  const [virtual]
 

Get the DataID of the data of this object.

Note:
Every class deriving from Object should reimplement this function in the same way!
Returns:
DataID of the object's data.

Reimplemented from nvsg::Object.

template<typename T>
bool nvsg::Animation< T >::isDataShared void   )  const [virtual]
 

Determine whether the data of this object is shared.

Note:
Every class deriving from Object should reimplement this function in the same way!
Returns:
true if the object's data is shared, otherwise false.

Reimplemented from nvsg::Object.


The documentation for this class was generated from the following file:
Generated on Tue Mar 1 13:20:42 2005 for NVSGSDK by NVIDIA