Syndicate::Data::SpriteAnim Class Reference

#include <Syndicate/Data/SpriteAnim.h>

Inheritance diagram for Syndicate::Data::SpriteAnim:

Syndicate::Data::File List of all members.

Public Member Functions

 SpriteAnim (void)
 ~SpriteAnim (void)
void get (unsigned id, unsigned &index) const
unsigned size (void) const
virtual void info (void)
bool load (char const *filename)
unsigned getLength (void)

Protected Attributes

unsigned _data_length

Private Attributes

Anim_anims

Classes

struct  Anim

Detailed Description

Allow to get the first frame for an animation


Constructor & Destructor Documentation

Syndicate::Data::SpriteAnim::SpriteAnim ( void   )  [inline]

Syndicate::Data::SpriteAnim::~SpriteAnim ( void   )  [inline]


Member Function Documentation

void Syndicate::Data::SpriteAnim::get ( unsigned  id,
unsigned &  index 
) const

Given the index of the animation, returns the index of the first frame.

Parameters:
[in] id the *index* of the animation
[out] index the *index* of the first frame that make this animation

unsigned Syndicate::Data::SpriteAnim::size ( void   )  const [inline]

Return the number of anims

virtual void Syndicate::Data::File::info ( void   )  [virtual, inherited]

In debug mode it display the informations.

bool Syndicate::Data::File::load ( char const *  filename  )  [inherited]

This method load the content (unpacked) of the file at the adress pointed by _data.

Parameters:
[in] filename the name of the file.
Return values:
true if success.
false if fails. If previous file is loaded, the data keep unaffected.

unsigned Syndicate::Data::File::getLength ( void   )  [inline, inherited]


Member Data Documentation

Anim* Syndicate::Data::SpriteAnim::_anims [private]

unsigned Syndicate::Data::File::_data_length [protected, inherited]


The documentation for this class was generated from the following file:
Generated on Sun Sep 30 13:08:36 2007 for libSyndicate by  doxygen 1.5.2