csAnimationTemplate Class Reference
A 2d animation template. This class is used to create animated pixmaps. More...
#include <cstool/csanim2d.h>
Public Member Functions | |
| void | AddFrame (csTicks Delay, iTextureHandle *Tex, int x, int y, int w, int h) |
| 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, csPixmap *s) |
| add a frame. (giving the length of this frame) | |
| csAnimatedPixmap * | CreateInstance () |
| create an instance of this animation | |
| csAnimationTemplate () | |
| build a new animation | |
| csPixmap * | GetFrame (size_t n) const |
| get a frame by number | |
| csPixmap * | GetFrameByTime (csTicks Time) |
| get a frame by time | |
| size_t | GetFrameCount () const |
| get number of frames | |
| csTicks | GetLength () const |
| get total length of animation (all delays added together) | |
| ~csAnimationTemplate () | |
| destructor | |
Detailed Description
A 2d animation template. This class is used to create animated pixmaps.
Definition at line 40 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] |
| void csAnimationTemplate::AddFrame | ( | csTicks | Delay, | |
| iTextureHandle * | Tex | |||
| ) | [inline] |
| csAnimatedPixmap* csAnimationTemplate::CreateInstance | ( | ) |
create an instance of this animation
| csPixmap* csAnimationTemplate::GetFrame | ( | size_t | n | ) | const [inline] |
| size_t csAnimationTemplate::GetFrameCount | ( | ) | const [inline] |
| csTicks csAnimationTemplate::GetLength | ( | ) | const [inline] |
The documentation for this class was generated from the following file:
- cstool/csanim2d.h
Generated for Crystal Space by doxygen 1.4.7