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

nvsg::AnimatedQuads Class Reference

GeoSet for animated Quads. More...

#include <AnimatedQuads.h>

Inheritance diagram for nvsg::AnimatedQuads:

Inheritance graph
[legend]
Collaboration diagram for nvsg::AnimatedQuads:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual NVSG_API const AnimatedQuadsclone (void) const
 Create a new AnimatedQuads by copying from this.
NVSG_API const Animation<
VNVector > * 
getAnimation (void) const
 Get a constant pointer to the Animation.
NVSG_API void setAnimation (const Animation< VNVector > *pAnimation)
 Set the Animation.
NVSG_API void setAnimationFrame (size_t frame)
 Set the animation frame.
virtual NVSG_API size_t getNumberOfFrames (void) const
 Get the number of animation frames.
virtual NVSG_API DataID getDataID (void) const
 Get the DataID of the data of this object.
virtual NVSG_API bool isDataShared (void) const
 Determine whether the data of this object is shared.

Static Public Member Functions

static NVSG_API const AnimatedQuadscreate (const Animation< VNVector > *pAnimation=NULL)
 Create an AnimatedQuads.
static NVSG_API const AnimatedQuadscreateFromBase (const Quads &rhs, const Animation< VNVector > *pAnimation=NULL)
 Create an AnimatedQuads by copying from a Quads.

Protected Member Functions

NVSG_API AnimatedQuads (const Animation< VNVector > *pAnimation)
 Constructor with an Animation.
NVSG_API AnimatedQuads (const Quads &rhs, const Animation< VNVector > *pAnimation)
 Constructor with a Quads and an Animation.
NVSG_API AnimatedQuads (const AnimatedQuads &rhs)
 Copy Constructor.
virtual NVSG_API ~AnimatedQuads (void)
 Protected destructor to prevent explicit creation on stack.
virtual NVSG_API void onSetVertexAttributeData (void)
 Vertex attribute data have been changed.

Detailed Description

GeoSet for animated Quads.

This class is a Quads with an Animation<VNVector>. The Animation defines the vertices and normals for each animation step.


Constructor & Destructor Documentation

NVSG_API nvsg::AnimatedQuads::AnimatedQuads const Animation< VNVector > *  pAnimation  )  [protected]
 

Constructor with an Animation.

NVSG_API nvsg::AnimatedQuads::AnimatedQuads const Quads rhs,
const Animation< VNVector > *  pAnimation
[protected]
 

Constructor with a Quads and an Animation.

NVSG_API nvsg::AnimatedQuads::AnimatedQuads const AnimatedQuads rhs  )  [protected]
 

Copy Constructor.

virtual NVSG_API nvsg::AnimatedQuads::~AnimatedQuads void   )  [protected, virtual]
 

Protected destructor to prevent explicit creation on stack.


Member Function Documentation

static NVSG_API const AnimatedQuads* nvsg::AnimatedQuads::create const Animation< VNVector > *  pAnimation = NULL  )  [static]
 

Create an AnimatedQuads.

There is an optional argument pAnimation to use a given Animation<VNVector>.

Returns:
a constant pointer to an AnimatedQuads.
Parameters:
pAnimation  optional animation to use

static NVSG_API const AnimatedQuads* nvsg::AnimatedQuads::createFromBase const Quads rhs,
const Animation< VNVector > *  pAnimation = NULL
[static]
 

Create an AnimatedQuads by copying from a Quads.

There is an optional argument pAnimation to use a given Animation<VNVector>.

Returns:
a constant pointer to an AnimatedQuads.
Parameters:
rhs  Quads to copy from
pAnimation  optional animation to use

virtual NVSG_API const AnimatedQuads* nvsg::AnimatedQuads::clone void   )  const [virtual]
 

Create a new AnimatedQuads by copying from this.

Returns:
a constant pointer to an identical AnimatedQuads.

Reimplemented from nvsg::Quads.

const Animation< VNVector > * nvsg::AnimatedQuads::getAnimation void   )  const [inline]
 

Get a constant pointer to the Animation.

Returns:
constant pointer to the animation

NVSG_API void nvsg::AnimatedQuads::setAnimation const Animation< VNVector > *  pAnimation  ) 
 

Set the Animation.

Any previous Animation is dereferenced, the new one is referenced, and the animation frame is reset to zero.

Parameters:
pAnimation  new animation to use

NVSG_API void nvsg::AnimatedQuads::setAnimationFrame size_t  frame  ) 
 

Set the animation frame.

The vertices/normals for animation step frame are used as the current.

Parameters:
frame  current animation step

virtual NVSG_API size_t nvsg::AnimatedQuads::getNumberOfFrames void   )  const [virtual]
 

Get the number of animation frames.

Returns:
0

Reimplemented from nvsg::Drawable.

virtual NVSG_API DataID nvsg::AnimatedQuads::getDataID void   )  const [virtual]
 

Get the DataID of the data of this object.

Returns:
DataID of the object's data.

Reimplemented from nvsg::Quads.

virtual NVSG_API bool nvsg::AnimatedQuads::isDataShared void   )  const [virtual]
 

Determine whether the data of this object is shared.

Returns:
true if the object's data is shared, otherwise false.

Reimplemented from nvsg::Quads.

virtual NVSG_API void nvsg::AnimatedQuads::onSetVertexAttributeData void   )  [protected, virtual]
 

Vertex attribute data have been changed.

This function gets called from the framework, whenever certain vertex attribute data has been changed. Classes that derive from GeoSet may overload this function to add some necessary work after the vertex attribute data has been changed.

Reimplemented from nvsg::GeoSet.


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