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

nvsg::AnimatedTransform Class Reference

Class representing an animated transformation. More...

#include <AnimatedTransform.h>

Inheritance diagram for nvsg::AnimatedTransform:

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

Collaboration graph
[legend]
List of all members.

Public Methods

virtual NVSG_API AnimatedTransform * clone (void) const
 Create a new AnimatedTransforms by copying from this. More...

NVSG_API const Animation<
nvmath::Trafo > * 
getAnimation (void) const
 Get a constant pointer to the animation. More...

NVSG_API void setAnimation (const Animation< nvmath::Trafo > *pAnimation)
 Set the Animation. More...

NVSG_API void setAnimationFrame (size_t frame)
 Set the animation frame. More...

virtual NVSG_API void setCenter (const nvmath::Vec3f &center)
 Set the center of rotation of this transformation. More...

virtual NVSG_API void setIdentity (void)
 Set the Transform to be the identity. More...

virtual NVSG_API void setOrientation (const nvmath::Quatf &orientation)
 Set the rotational part of this transformation, using a quaternion. More...

virtual NVSG_API void setScaling (const nvmath::Vec3f &scaling)
 Set the scaling part of this transformation. More...

virtual NVSG_API void setTranslation (const nvmath::Vec3f &translation)
 Set the translational part of this transformation. More...

virtual NVSG_API size_t getNumberOfFrames (void) const
 Get the number of animation frames that are part of this Node. More...

virtual NVSG_API DataID getDataID (void) const
 Get the DataID of the data of this object. More...

virtual NVSG_API bool isDataShared (void) const
 Determine whether the data of this object is shared. More...


Static Public Methods

NVSG_API const AnimatedTransform * create (const Animation< nvmath::Trafo > *pAnimation=NULL)
 Create an AnimatedTransform. More...

NVSG_API const AnimatedTransform * createFromBase (const Transform &rhs, const Animation< nvmath::Trafo > *pAnimation=NULL)
 Create an AnimatedTransform by copying from a Transform. More...


Protected Methods

NVSG_API AnimatedTransform (const Animation< nvmath::Trafo > *pAnimation)
 Constructor with an Animation. More...

NVSG_API AnimatedTransform (const Transform &rhs, const Animation< nvmath::Trafo > *pAnimation)
 Constructur with a Transform and an Animation. More...

NVSG_API AnimatedTransform (const AnimatedTransform &rhs)
 Copy Constructor. More...

virtual NVSG_API ~AnimatedTransform (void)
 Protected destructor to prevent explicit creation on stack. More...


Detailed Description

Class representing an animated transformation.

An AnimatedTransform is a Transform that also holds an Animation. The transformation is determined from the Animation with every frame.


Constructor & Destructor Documentation

NVSG_API nvsg::AnimatedTransform::AnimatedTransform const Animation< nvmath::Trafo > *    pAnimation [protected]
 

Constructor with an Animation.

NVSG_API nvsg::AnimatedTransform::AnimatedTransform const Transform   rhs,
const Animation< nvmath::Trafo > *    pAnimation
[protected]
 

Constructur with a Transform and an Animation.

NVSG_API nvsg::AnimatedTransform::AnimatedTransform const AnimatedTransform &    rhs [protected]
 

Copy Constructor.

virtual NVSG_API nvsg::AnimatedTransform::~AnimatedTransform void    [protected, virtual]
 

Protected destructor to prevent explicit creation on stack.


Member Function Documentation

NVSG_API const AnimatedTransform* nvsg::AnimatedTransform::create const Animation< nvmath::Trafo > *    pAnimation = NULL [static]
 

Create an AnimatedTransform.

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

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

NVSG_API const AnimatedTransform* nvsg::AnimatedTransform::createFromBase const Transform   rhs,
const Animation< nvmath::Trafo > *    pAnimation = NULL
[static]
 

Create an AnimatedTransform by copying from a Transform.

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

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

virtual NVSG_API AnimatedTransform* nvsg::AnimatedTransform::clone void    const [virtual]
 

Create a new AnimatedTransforms by copying from this.

Returns:
a constant pointer to an identical AnimatedTransform.

Reimplemented from nvsg::Transform.

const Animation< nvmath::Trafo > * nvsg::AnimatedTransform::getAnimation void    const [inline]
 

Get a constant pointer to the animation.

Returns:
constant pointer to the animation

NVSG_API void nvsg::AnimatedTransform::setAnimation const Animation< nvmath::Trafo > *    pAnimation
 

Set the Animation.

A 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::AnimatedTransform::setAnimationFrame size_t    frame
 

Set the animation frame.

The transformation for animation step frame is calculated and used as the current.

Parameters:
frame  current animation step

virtual NVSG_API void nvsg::AnimatedTransform::setCenter const nvmath::Vec3f   center [virtual]
 

Set the center of rotation of this transformation.

Reimplemented from nvsg::Transform.

virtual NVSG_API void nvsg::AnimatedTransform::setIdentity void    [virtual]
 

Set the Transform to be the identity.

Reimplemented from nvsg::Transform.

virtual NVSG_API void nvsg::AnimatedTransform::setOrientation const nvmath::Quatf   orientation [virtual]
 

Set the rotational part of this transformation, using a quaternion.

Reimplemented from nvsg::Transform.

virtual NVSG_API void nvsg::AnimatedTransform::setScaling const nvmath::Vec3f   scaling [virtual]
 

Set the scaling part of this transformation.

Reimplemented from nvsg::Transform.

virtual NVSG_API void nvsg::AnimatedTransform::setTranslation const nvmath::Vec3f   translation [virtual]
 

Set the translational part of this transformation.

Reimplemented from nvsg::Transform.

virtual NVSG_API size_t nvsg::AnimatedTransform::getNumberOfFrames void    const [virtual]
 

Get the number of animation frames that are part of this Node.

Returns:
The number of animation frames of at least one child.

Reimplemented from nvsg::Group.

virtual NVSG_API DataID nvsg::AnimatedTransform::getDataID void    const [virtual]
 

Get the DataID of the data of this object.

Returns:
DataID of the object's data.

Reimplemented from nvsg::Transform.

virtual NVSG_API bool nvsg::AnimatedTransform::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::Transform.


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