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

nvsg::FramedAnimation< T > Class Template Reference

An Animation that holds a complete data set for each frame. More...

#include <FramedAnimation.h>

Inheritance diagram for nvsg::FramedAnimation< T >:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual const FramedAnimation<
T > * 
clone (void) const
 Create a new FramedAnimation by copying from this.
virtual void setNumberOfFrames (size_t count)
 Set the number of frames in the animation.
virtual T & operator[] (size_t i)
 Random access operator for more convenient usage.
virtual size_t getNumberOfFrames (void) const
 Get the number of frames in the animation.
virtual const T & operator[] (size_t i) const
 Random access operator for more convenient usage, constant version only.

Static Public Member Functions

static const FramedAnimation<
T > * 
create (void)
 Create a FramedAnimation.
static const FramedAnimation<
T > * 
createFromBase (const Animation< T > &rhs)
 Create a FramedAnimation by copying from an Animation.

Protected Member Functions

NVSG_API FramedAnimation (void)
 Default Constructor.
NVSG_API FramedAnimation (const Animation< T > &rhs)
 Partial Constructor.
NVSG_API FramedAnimation (const FramedAnimation< T > &rhs)
 Copy Constructor.
virtual ~FramedAnimation (void)
 Protected destructor to prevent explicit creation on stack.

Detailed Description

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

An Animation that holds a complete data set for each frame.

Note:
Currently the only supported types for FramedAnimation are Trafo and VNVector.


Constructor & Destructor Documentation

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

Default Constructor.

template<typename T>
NVSG_API nvsg::FramedAnimation< T >::FramedAnimation const Animation< T > &  rhs  )  [protected]
 

Partial Constructor.

template<typename T>
NVSG_API nvsg::FramedAnimation< T >::FramedAnimation const FramedAnimation< T > &  rhs  )  [protected]
 

Copy Constructor.

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

Protected destructor to prevent explicit creation on stack.


Member Function Documentation

template<typename T>
const FramedAnimation< T > * nvsg::FramedAnimation< T >::create void   )  [static]
 

Create a FramedAnimation.

Returns:
a constant pointer to an FramedAnimation.

template<typename T>
const FramedAnimation< T > * nvsg::FramedAnimation< T >::createFromBase const Animation< T > &  rhs  )  [static]
 

Create a FramedAnimation by copying from an Animation.

Returns:
a constant pointer to a FramedAnimation.
Parameters:
rhs  Animation to copy from

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

Create a new FramedAnimation by copying from this.

Returns:
a constant pointer to an identical FramedAnimation.

Implements nvsg::Animation< T >.

template<typename T>
void nvsg::FramedAnimation< T >::setNumberOfFrames size_t  count  )  [virtual]
 

Set the number of frames in the animation.

Resizes the array of animation values. On growing this array, the new elements are not initialized.

template<typename T>
T & nvsg::FramedAnimation< T >::operator[] size_t  i  )  [virtual]
 

Random access operator for more convenient usage.

Returns:
reference to value of frame i

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

Get the number of frames in the animation.

Returns:
number of animation frames

Implements nvsg::Animation< T >.

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

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

Returns:
constant reference to value of frame i

Implements nvsg::Animation< T >.


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