GameKit  0.0.1a
C++ gamedev tools
Public Member Functions | Private Attributes | List of all members
gk::SpriteAnimation Class Reference

#include <SpriteAnimation.hpp>

Public Member Functions

 SpriteAnimation (u16 delay, bool isRepeated=true)
 
void reset (u16 frameID=0)
 
void start ()
 
void stop ()
 
void play ()
 
void addFrame (u16 frameID)
 
u16 getFrame (u16 frameID) const
 
u16 currentFrame () const
 
u16 displayedFramesAmount () const
 
bool isPlaying () const
 
bool isFinished () const
 
u32 size () const
 
u16 delay () const
 
void setRepeated (bool isRepeated)
 

Private Attributes

std::vector< u16m_frames
 
Timer m_timer
 
u16 m_delay = 0
 
bool m_isPaused = false
 
bool m_isRepeated = true
 

Detailed Description

Definition at line 23 of file SpriteAnimation.hpp.

Constructor & Destructor Documentation

§ SpriteAnimation()

gk::SpriteAnimation::SpriteAnimation ( u16  delay,
bool  isRepeated = true 
)
inline

Definition at line 25 of file SpriteAnimation.hpp.

Member Function Documentation

§ addFrame()

void gk::SpriteAnimation::addFrame ( u16  frameID)
inline

Definition at line 35 of file SpriteAnimation.hpp.

§ currentFrame()

u16 gk::SpriteAnimation::currentFrame ( ) const

Definition at line 56 of file SpriteAnimation.cpp.

§ delay()

u16 gk::SpriteAnimation::delay ( ) const
inline

Definition at line 45 of file SpriteAnimation.hpp.

§ displayedFramesAmount()

u16 gk::SpriteAnimation::displayedFramesAmount ( ) const

Definition at line 65 of file SpriteAnimation.cpp.

§ getFrame()

u16 gk::SpriteAnimation::getFrame ( u16  frameID) const

Definition at line 52 of file SpriteAnimation.cpp.

§ isFinished()

bool gk::SpriteAnimation::isFinished ( ) const
inline

Definition at line 41 of file SpriteAnimation.hpp.

§ isPlaying()

bool gk::SpriteAnimation::isPlaying ( ) const
inline

Definition at line 40 of file SpriteAnimation.hpp.

§ play()

void gk::SpriteAnimation::play ( )

Definition at line 35 of file SpriteAnimation.cpp.

§ reset()

void gk::SpriteAnimation::reset ( u16  frameID = 0)

Definition at line 18 of file SpriteAnimation.cpp.

§ setRepeated()

void gk::SpriteAnimation::setRepeated ( bool  isRepeated)
inline

Definition at line 47 of file SpriteAnimation.hpp.

§ size()

u32 gk::SpriteAnimation::size ( ) const
inline

Definition at line 43 of file SpriteAnimation.hpp.

§ start()

void gk::SpriteAnimation::start ( )

Definition at line 23 of file SpriteAnimation.cpp.

§ stop()

void gk::SpriteAnimation::stop ( )

Definition at line 29 of file SpriteAnimation.cpp.

Member Data Documentation

§ m_delay

u16 gk::SpriteAnimation::m_delay = 0
private

Definition at line 54 of file SpriteAnimation.hpp.

§ m_frames

std::vector<u16> gk::SpriteAnimation::m_frames
private

Definition at line 50 of file SpriteAnimation.hpp.

§ m_isPaused

bool gk::SpriteAnimation::m_isPaused = false
private

Definition at line 56 of file SpriteAnimation.hpp.

§ m_isRepeated

bool gk::SpriteAnimation::m_isRepeated = true
private

Definition at line 57 of file SpriteAnimation.hpp.

§ m_timer

Timer gk::SpriteAnimation::m_timer
private

Definition at line 52 of file SpriteAnimation.hpp.


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