CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csAnimationTemplate Class Reference

A 2d animation template. This class is used to create animated pixmaps. More...

#include <csanim2d.h>

List of all members.

Public Methods

 csAnimationTemplate ()
 build a new animation

 ~csAnimationTemplate ()
 destructor

int GetFrameCount () const
 get number of frames

csTicks GetLength () const
 get total length of animation (all delays added together)

void AddFrame (csTicks Delay, csPixmap *s)
 add a frame. (giving the length of this frame)

void AddFrame (csTicks Delay, iTextureHandle *Tex)
 add a frame (giving the length of this frame)

void AddFrame (csTicks Delay, iTextureHandle *Tex, int x, int y, int w, int h)
 add a frame (giving the length of this frame)

csPixmapGetFrame (int n) const
 get a frame by number

csPixmapGetFrameByTime (csTicks Time)
 get a frame by time

csAnimatedPixmapCreateInstance ()
 create an instance of this animation


Detailed Description

A 2d animation template. This class is used to create animated pixmaps.

Definition at line 34 of file csanim2d.h.


Constructor & Destructor Documentation

csAnimationTemplate::csAnimationTemplate  
 

build a new animation

csAnimationTemplate::~csAnimationTemplate  
 

destructor


Member Function Documentation

void csAnimationTemplate::AddFrame csTicks    Delay,
iTextureHandle   Tex,
int    x,
int    y,
int    w,
int    h
[inline]
 

add a frame (giving the length of this frame)

Definition at line 64 of file csanim2d.h.

References csTicks.

void csAnimationTemplate::AddFrame csTicks    Delay,
iTextureHandle   Tex
[inline]
 

add a frame (giving the length of this frame)

Definition at line 61 of file csanim2d.h.

References csTicks.

void csAnimationTemplate::AddFrame csTicks    Delay,
csPixmap   s
[inline]
 

add a frame. (giving the length of this frame)

Definition at line 58 of file csanim2d.h.

References csTicks.

csAnimatedPixmap* csAnimationTemplate::CreateInstance  
 

create an instance of this animation

csPixmap* csAnimationTemplate::GetFrame int    n const [inline]
 

get a frame by number

Definition at line 69 of file csanim2d.h.

References csArray< T *, csPDelArrayElementHandler< T * > >::Get().

csPixmap* csAnimationTemplate::GetFrameByTime csTicks    Time
 

get a frame by time

int csAnimationTemplate::GetFrameCount   const [inline]
 

get number of frames

Definition at line 52 of file csanim2d.h.

References csArray< T *, csPDelArrayElementHandler< T * > >::Length().

csTicks csAnimationTemplate::GetLength   const [inline]
 

get total length of animation (all delays added together)

Definition at line 55 of file csanim2d.h.

References csTicks.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18