# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NL3D::UAnimationSet Class Reference

An animation Set is a set of animation, loaded from file. More...

#include <u_animation_set.h>

Inheritance diagram for NL3D::UAnimationSet:

NL3D::CAnimationSetUser List of all members.

Public Types

enum  { NotFound = 0xffffffff }

Public Methods

Set build.
virtual uint addAnimation (const char *fileName, const char *animName)=0
 Add an animation in the animation set. More...

virtual void build ()=0
 Build the animation set. More...

virtual uint addSkeletonWeight (const char *fileName, const char *skelName)=0
 Add a skeleton weight in the animation set. More...

Animations mgt.
virtual uint getNumAnimation () const=0
 Get animations count. More...

virtual uint getAnimationIdByName (const std::string &name) const=0
 Get a animation ID by name. More...

virtual const std::string & getAnimationName (uint animationId) const=0
 Get animation name. More...

virtual UAnimationgetAnimation (uint animationId)=0
 Get a writable animation pointer. More...

SkeletonWeight mgt.
virtual uint getNumSkeletonWeight () const=0
 Get skeleton weight count. More...

virtual uint getSkeletonWeightIdByName (const std::string &name) const=0
 Get a SkeletonWeight ID by name. More...

virtual const std::string & getSkeletonWeightName (uint skeletonId) const=0
 Get skeleton template name. More...

Channel mgt.
virtual uint getChannelIdByName (const std::string &name) const=0
 Get a channel ID with its name. More...


Protected Methods

 UAnimationSet ()
 Constructor. More...

virtual ~UAnimationSet ()
 Constructor. More...


Detailed Description

An animation Set is a set of animation, loaded from file.

It contains a set of Skeleton TempalteWeight too.

Author:
Lionel Berenguier , Nevrax France
Date:
2001

Definition at line 45 of file u_animation_set.h.


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
NotFound 

Definition at line 56 of file u_animation_set.h.


Constructor & Destructor Documentation

NL3D::UAnimationSet::UAnimationSet   [inline, protected]
 

Constructor.

Definition at line 50 of file u_animation_set.h.

virtual NL3D::UAnimationSet::~UAnimationSet   [inline, protected, virtual]
 

Constructor.

Definition at line 52 of file u_animation_set.h.


Member Function Documentation

virtual uint NL3D::UAnimationSet::addAnimation const char *    fileName,
const char *    animName
[pure virtual]
 

Add an animation in the animation set.

After adding all your animations, call build(). This method use CPath to search the animation file.

Parameters:
fileName  is the animation filename
animName  is the name of the animation in the animation set.
Returns:
the id of the new animation or NotFound if the file is not found.

Implemented in NL3D::CAnimationSetUser.

virtual uint NL3D::UAnimationSet::addSkeletonWeight const char *    fileName,
const char *    skelName
[pure virtual]
 

Add a skeleton weight in the animation set.

This method use CPath to search the skeleton file.

Parameters:
fileName  is the skeleton weight filename
skelName  is the name of the skeleton weight in the animation set.
Returns:
the id of the new skeleton or NotFound if the file is not found.

Implemented in NL3D::CAnimationSetUser.

virtual void NL3D::UAnimationSet::build   [pure virtual]
 

Build the animation set.

Call build after adding all your animations.

Implemented in NL3D::CAnimationSetUser.

virtual UAnimation* NL3D::UAnimationSet::getAnimation uint    animationId [pure virtual]
 

Get a writable animation pointer.

Returns:
the end time.

Implemented in NL3D::CAnimationSetUser.

virtual uint NL3D::UAnimationSet::getAnimationIdByName const std::string &    name const [pure virtual]
 

Get a animation ID by name.

If no animation is found, method returns NotFound.

Implemented in NL3D::CAnimationSetUser.

virtual const std::string& NL3D::UAnimationSet::getAnimationName uint    animationId const [pure virtual]
 

Get animation name.

Implemented in NL3D::CAnimationSetUser.

virtual uint NL3D::UAnimationSet::getChannelIdByName const std::string &    name const [pure virtual]
 

Get a channel ID with its name.

If no channel is found, method returns NotFound.

Implemented in NL3D::CAnimationSetUser.

virtual uint NL3D::UAnimationSet::getNumAnimation   const [pure virtual]
 

Get animations count.

Implemented in NL3D::CAnimationSetUser.

virtual uint NL3D::UAnimationSet::getNumSkeletonWeight   const [pure virtual]
 

Get skeleton weight count.

Implemented in NL3D::CAnimationSetUser.

virtual uint NL3D::UAnimationSet::getSkeletonWeightIdByName const std::string &    name const [pure virtual]
 

Get a SkeletonWeight ID by name.

If no SkeletonWeight is found, method returns NotFound.

Implemented in NL3D::CAnimationSetUser.

virtual const std::string& NL3D::UAnimationSet::getSkeletonWeightName uint    skeletonId const [pure virtual]
 

Get skeleton template name.

Implemented in NL3D::CAnimationSetUser.


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