# 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::UAnimation Class Reference

Give manual access to the animation functions. More...

#include <u_animation.h>

Inheritance diagram for NL3D::UAnimation:

NL3D::CAnimation List of all members.

Public Methods

virtual UTrackgetTrackByName (const char *name)=0
 Get an animation track with its name. More...

virtual void releaseTrack (UTrack *track)=0
 Relase a track interface. More...

virtual TAnimationTime getBeginTime () const=0
 Get begin time of the animation. More...

virtual TAnimationTime getEndTime () const=0
 Get end time of the animation. More...

virtual bool allTrackLoop () const=0
 Say if all track of this animation loop. More...


Static Public Methods

Create / delete animations
UAnimation * createAnimation (const char *sPath)
 Load an animation. More...

void releaseAnimation (UAnimation *animation)
 Release an animation. More...


Detailed Description

Give manual access to the animation functions.

By this interface, you can load animations, get tracks from this animation with there names, and interpolate manually value from those tracks.

This interface is not made to work with UAnimationSet or UPlayList. UAnimation has its own methods to load / release animations.

Author:
Cyril 'Hulud' Corvazier , Nevrax France
Date:
2001

Definition at line 50 of file u_animation.h.


Member Function Documentation

virtual bool NL3D::UAnimation::allTrackLoop   const [pure virtual]
 

Say if all track of this animation loop.

NB: If no tracks in the animation, return true

Implemented in NL3D::CAnimation.

UAnimation * NL3D::UAnimation::createAnimation const char *    sPath [static]
 

Load an animation.

This method will use CPath to find the good animation file. (*.anim). You should call releaseAnimation to delete the animation.

Parameters:
sPath  is the animation file path.
Returns:
NULL if the file is not found. Else return the pointer on the animation interface.

Definition at line 259 of file animation.cpp.

References file, NLMISC::CPath::lookup, NL3D_HAUTO_UI_ANIMATION, NL3D_MEM_ANIMATION, NLMISC::CIFile::open, and NLMISC::IStream::serial.

virtual TAnimationTime NL3D::UAnimation::getBeginTime   const [pure virtual]
 

Get begin time of the animation.

Returns:
the begin time.

Implemented in NL3D::CAnimation.

virtual TAnimationTime NL3D::UAnimation::getEndTime   const [pure virtual]
 

Get end time of the animation.

Returns:
the end time.

Implemented in NL3D::CAnimation.

virtual UTrack* NL3D::UAnimation::getTrackByName const char *    name [pure virtual]
 

Get an animation track with its name.

The track interface should be released with releaseTrack.

Parameters:
name  is the name of the track to get.
Returns:
NULL if the track is not found, else a pointer on the track interface.

Implemented in NL3D::CAnimation.

void NL3D::UAnimation::releaseAnimation UAnimation *    animation [static]
 

Release an animation.

This animation must have been created will createAnimation().

Parameters:
animation  is the animation to release.

Definition at line 286 of file animation.cpp.

References NL3D_HAUTO_UI_ANIMATION, and NL3D_MEM_ANIMATION.

virtual void NL3D::UAnimation::releaseTrack UTrack   track [pure virtual]
 

Relase a track interface.

Parameters:
track  is a pointer on the track interface to release.

Implemented in NL3D::CAnimation.


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