#include <animation.h>
Public Member Functions | |
Animation () | |
~Animation () | |
void | addFrame (ResourcePtr image, unsigned int duration) |
int | getFrameIndex (unsigned int timestamp) |
Image * | getFrame (int index) |
Image * | getFrameByTimestamp (unsigned int timestamp) |
int | getFrameDuration (int index) const |
unsigned int | getNumFrames () const |
void | setActionFrame (int num) |
int | getActionFrame () const |
void | setDirection (unsigned int direction) |
unsigned int | getDirection () const |
unsigned int | getDuration () const |
A container of Images describing an animation. Animation itself does not take care of animating the images. Instead it contains images having associated timestamps. It is the responsibility of the animation user to query frames based on current timestamp and show returned images on screen.
Definition at line 54 of file animation.h.
FIFE::Animation::Animation | ( | ) | [explicit] |
Constructor.
Definition at line 39 of file animation.cpp.
FIFE::Animation::~Animation | ( | ) |
Destructor. Decreases the reference count of all referred images.
Definition at line 45 of file animation.cpp.
void FIFE::Animation::addFrame | ( | ResourcePtr | image, | |
unsigned int | duration | |||
) |
Adds new frame into animation Frames must be added starting from first frame. Increases the reference count of the given image.
image | Pointer to Image. Does not transfer the ownership | |
duration | Duration for given frame in the animation |
Definition at line 50 of file animation.cpp.
int FIFE::Animation::getActionFrame | ( | ) | const [inline] |
unsigned int FIFE::Animation::getDirection | ( | ) | const [inline] |
Gets the animation direction
Definition at line 123 of file animation.h.
unsigned int FIFE::Animation::getDuration | ( | ) | const [inline] |
Gets the total duration for the whole animation
Definition at line 127 of file animation.h.
Image * FIFE::Animation::getFrame | ( | int | index | ) |
Gets the frame that matches the given index. If no matches found, returns NULL
Definition at line 85 of file animation.cpp.
Image * FIFE::Animation::getFrameByTimestamp | ( | unsigned int | timestamp | ) |
Gets the frame that matches the given timestamp.
Definition at line 93 of file animation.cpp.
int FIFE::Animation::getFrameDuration | ( | int | index | ) | const |
Gets the frame duration for given (indexed) frame. Returns negative value in case of incorrect index
Definition at line 97 of file animation.cpp.
int FIFE::Animation::getFrameIndex | ( | unsigned int | timestamp | ) |
Get the frame index that matches given timestamp. In case there is no exact match, correct frame is calculated. E.g. if there are frames for timestamps 50 and 100 and frame for 75 is asked, frame associated with value 50 is given back. In case the timestamp is past the sequence, negative value is returned
Definition at line 70 of file animation.cpp.
unsigned int FIFE::Animation::getNumFrames | ( | ) | const |
Get the number of frames
Definition at line 105 of file animation.cpp.
void FIFE::Animation::setActionFrame | ( | int | num | ) | [inline] |
Sets the action frame. Action frame is the frame when the related action actually happens. E.g. in case of punch animation, action frame is the frame when punch hits the target. In case there is no associated action frame, value is negative
num | index of the action frame. |
Definition at line 103 of file animation.h.
void FIFE::Animation::setDirection | ( | unsigned int | direction | ) |
Animation direction tells how this animation is associated with movement when played starting from frame 0 E.g. in walking animation there should be direction assigned so that engine can choose the correct animation when characters are moved around the map area
direction | direction to set |
Definition at line 109 of file animation.cpp.