NL3D::CAnimation Class Reference

This class describes animations for several tracks. More...

#include <animation.h>

Public Member Functions
	CAnimation ()
	ctor
virtual	~CAnimation ()
	Destructor.
void	addSSSShape (const std::string &shape)
	For SkeletonSpawnScript (SSS) animation.
const std::vector< std::string > &	getSSSShapes () const
From UAnimation

virtual UTrack *	getTrackByName (const char *name)
	Get an animation track with its name.
virtual void	releaseTrack (UTrack *track)
	Relase a track interface.
virtual TAnimationTime	getBeginTime () const
	Get begin time of the animation.
virtual TAnimationTime	getEndTime () const
	Get end time of the animation.
virtual bool	allTrackLoop () const
	Say if all track of this animation loop.
CAnimationSet private

void	applySampleDivisor (uint sampleDivisor)
	For each track that support it (CTrackSampled for instance), divide its number of sampled keys, to lower the memory lod.
void	applyTrackQuatHeaderCompression ()
	For CTrackSampledQuat only, compress header.
void	applyAnimHeaderCompression (CAnimationSet *animationSetOwner, const std::map< std::string, uint32 > &channelMap)
	Used by CAnimationSet to lower the memory Size.
Private Attributes
class CTrackSamplePack *	_TrackSamplePack
	CTrackSampledQuat header compression.
std::vector< uint16 >	_IdByChannelId
class CAnimationSet *	_AnimationSetOwner
std::vector< std::string >	_SSSShapes
Anim time caching

TAnimationTime	_BeginTime
TAnimationTime	_EndTime
bool	_AnimLoop
bool	_BeginTimeTouched
bool	_EndTimeTouched
bool	_AnimLoopTouched
Public interface.

enum	{ NotFound = 0xffffffff }
uint	getIdTrackByName (const std::string &name) const
	Get track with its name.
void	getTrackNames (std::set< std::string > &setString) const
	Fill the set of string with the name of the channels.
uint	getIdTrackByChannelId (uint16 channelId) const
	see applyAnimHeaderCompression()
const ITrack *	getTrack (uint trackId) const
	Get a const track pointer.
ITrack *	getTrack (uint trackId)
	Get a track pointer.
void	addTrack (const std::string &name, ITrack *pChannel)
	Add a track at the end of the track list.
void	serial (NLMISC::IStream &f)
	Serial the template.
void	setMinEndTime (TAnimationTime minEndTime)
	Set animation min end time.
Members

typedef std::map< std::string, uint32 >	TMapStringUInt
typedef std::vector< ITrack * >	TVectAPtrTrack
std::string	_Name
TMapStringUInt	_IdByName
TVectAPtrTrack	_TrackVector
TAnimationTime	_MinEndTime

Detailed Description

This class describes animations for several tracks.

Each track works with a IAnimatedValue for the IAnimatable objects.

Author:: Cyril 'Hulud' Corvazier; Nevrax France

Date:: 2001

Definition at line 57 of file animation.h.

Member Typedef Documentation

typedef std::map<std::string, uint32> NL3D::CAnimation::TMapStringUInt [private]

Definition at line 171 of file animation.h.

typedef std::vector<ITrack* > NL3D::CAnimation::TVectAPtrTrack [private]

Definition at line 172 of file animation.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

NotFound

Definition at line 67 of file animation.h.

Constructor & Destructor Documentation

NL3D::CAnimation::CAnimation ( )

ctor

Definition at line 51 of file animation.cpp.

References _AnimationSetOwner, _MinEndTime, and _TrackSamplePack.

NL3D::CAnimation::~CAnimation ( ) [virtual]

Destructor.

Definition at line 60 of file animation.cpp.

References _TrackSamplePack, and _TrackVector.

Member Function Documentation

void NL3D::CAnimation::addSSSShape ( const std::string & shape )

For SkeletonSpawnScript (SSS) animation.

Add manualy the shapes that can be spawned by the channel "spawn_script" in this animation This add into a vector (avoid duplicates)

Then CAnimationSet::preloadSSSShapes() can be used after CAnimationSet::build() to force loading into the ShapeBank/Texture of thoses shapes, so there is no problem of shape loading during animation

Definition at line 515 of file animation.cpp.

References _SSSShapes.

Referenced by NL3D::CAnimationOptimizer::optimize().