NL3D::UAnimationSet Class Reference

#include <u_animation_set.h>

Inheritance diagram for NL3D::UAnimationSet:

---

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.

Public Types
enum	{ NotFound = 0xffffffff }
Public Member Functions
Set build.
virtual uint	addAnimation (const char *fileName, const char *animName)=0
virtual uint	addSkeletonWeight (const char *fileName, const char *skelName)=0
virtual void	build ()=0
Animations mgt.
virtual UAnimation *	getAnimation (uint animationId)=0
virtual uint	getAnimationIdByName (const std::string &name) const=0
virtual const std::string &	getAnimationName (uint animationId) const=0
virtual uint	getNumAnimation () const=0
Channel mgt.
virtual uint	getChannelIdByName (const std::string &name) const=0
SkeletonWeight mgt.
virtual uint	getNumSkeletonWeight () const=0
virtual uint	getSkeletonWeightIdByName (const std::string &name) const=0
virtual const std::string &	getSkeletonWeightName (uint skeletonId) const=0
Protected Member Functions
	UAnimationSet ()
	Constructor.
virtual	~UAnimationSet ()
	Constructor.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: NotFound  Definition at line 56 of file u_animation_set.h. { NotFound=0xffffffff };

---

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. Referenced by NL3D::CSceneUser::setAutomaticAnimationSet().

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:

• u_animation_set.h

---