SpriteAnimation Class Reference

#include <spriteanimation.h>

Collaboration diagram for SpriteAnimation:

[legend]List of all members.

Public Types
	show_first_frame
	show_last_frame
	show_blank
enum	SpriteShowOnFinish { show_first_frame, show_last_frame, show_blank }
Public Member Functions
	SpriteAnimation (Sprite &sprite)
	SpriteAnimation (const SpriteAnimation &other, Sprite &sprite)
void	Start ()
void	Update ()
void	Finish ()
bool	IsFinished () const
void	SetSpeedFactor (float nv_speed)
void	SetPlayBackward (bool enable)
void	SetLoopMode (bool enable)
void	SetPingPongMode (bool enable)
void	SetShowOnFinish (SpriteShowOnFinish show)
SpriteShowOnFinish	GetShowOnFinish () const
Private Attributes
Sprite &	sprite
unsigned int	last_update
float	speed_factor
int	frame_delta
bool	finished
SpriteShowOnFinish	show_on_finish
bool	loop
bool	pingpong

---

Detailed Description

Definition at line 32 of file spriteanimation.h.

---

Member Enumeration Documentation

enum SpriteAnimation::SpriteShowOnFinish

Enumerator:

show_first_frame
show_last_frame
show_blank

Definition at line 35 of file spriteanimation.h.

               {
    show_first_frame,
    show_last_frame,
    show_blank
  } SpriteShowOnFinish;

---

Constructor & Destructor Documentation

SpriteAnimation::SpriteAnimation

(

Sprite &

sprite

)

Definition at line 29 of file spriteanimation.cpp.

                                                 :
  sprite(p_sprite)
{
   last_update = Time::GetInstance()->Read();
   speed_factor = 1.0f;
   frame_delta = 1;
   finished = false;
   show_on_finish = show_last_frame;
   loop = true;
   pingpong = false;
}

Here is the call graph for this function:

SpriteAnimation::SpriteAnimation	(	const SpriteAnimation &	other,
		Sprite &	sprite
	)

Definition at line 41 of file spriteanimation.cpp.

                                                                               :
  sprite(p_sprite)
{
   last_update = other.last_update;
   speed_factor = other.speed_factor;
   frame_delta = other.frame_delta;
   finished = other.finished;
   show_on_finish = other.show_on_finish;
   loop = other.loop;
   pingpong = other.pingpong;
}

---

Member Function Documentation

void SpriteAnimation::Finish

(

)

Definition at line 69 of file spriteanimation.cpp.

                             {
  finished = true;
}  

Here is the caller graph for this function:

SpriteAnimation::SpriteShowOnFinish SpriteAnimation::GetShowOnFinish

(

)

const

Definition at line 141 of file spriteanimation.cpp.

                                                                         {
  return show_on_finish;
}

Here is the caller graph for this function:

bool SpriteAnimation::IsFinished

(

)

const

Definition at line 129 of file spriteanimation.cpp.

                                       { 
  return finished; 
}

Here is the caller graph for this function:

void SpriteAnimation::SetLoopMode

(

bool

enable

)

Definition at line 133 of file spriteanimation.cpp.

                                             { 
  loop = enable; 
}

Here is the caller graph for this function:

void SpriteAnimation::SetPingPongMode

(

bool

enable

)

Definition at line 137 of file spriteanimation.cpp.

                                                 {
  pingpong = enable; 
}

Here is the caller graph for this function:

void SpriteAnimation::SetPlayBackward

(

bool

enable

)

Definition at line 62 of file spriteanimation.cpp.

                                                {
  if (enable)
    frame_delta = -1;
  else 
    frame_delta = 1;
}

Here is the caller graph for this function:

void SpriteAnimation::SetShowOnFinish

(

SpriteShowOnFinish

show

)

Definition at line 124 of file spriteanimation.cpp.

                                                             { 
  show_on_finish = show; 
  loop = false;
}

Here is the caller graph for this function:

void SpriteAnimation::SetSpeedFactor

(

float

nv_speed

)

Definition at line 53 of file spriteanimation.cpp.

                                                   {
  speed_factor = nv_speed;
}

void SpriteAnimation::Start

(

)

Definition at line 57 of file spriteanimation.cpp.

                           {
   finished = false;
   last_update = Time::GetInstance()->Read();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpriteAnimation::Update

(

)

Definition at line 73 of file spriteanimation.cpp.

                            {
  if (finished) return;
  
  Time * global_time = Time::GetInstance();
  if (global_time->Read() < (last_update + sprite.GetCurrentFrameObject().delay))
     return;
  const unsigned int current_frame = sprite.GetCurrentFrame();
  const unsigned int frame_count = sprite.GetFrameCount();

  //Delta to next frame used to enable frameskip
  //if delay between 2 frame is < fps
  int delta_to_next_f = (int)((float)((global_time->Read() - last_update) / sprite.GetCurrentFrameObject().delay) * speed_factor);
  last_update += (int)((float)(delta_to_next_f * sprite.GetCurrentFrameObject().delay) / speed_factor);

  //Animation is finished, when last frame have been fully played
  bool finish;
  if (frame_delta < 0)
    finish = ((int)current_frame + frame_delta * delta_to_next_f) <= -1;
  else
    finish = frame_count <= (current_frame + frame_delta * delta_to_next_f);

  if (finish && !loop && (!pingpong || frame_delta < 0))
     Finish();
  else
  {
    unsigned int next_frame = ( current_frame + frame_delta * delta_to_next_f ) % frame_count;

    if(pingpong)
    {
      if( frame_delta>0 && ( current_frame + frame_delta * delta_to_next_f ) >= frame_count)
      {
        next_frame = frame_count - next_frame -2;
        frame_delta = - frame_delta;
      }
      else
      if( frame_delta<0 && ( (int)current_frame + frame_delta * delta_to_next_f ) <= -1)
      {
        next_frame = (-((int)current_frame + frame_delta * delta_to_next_f )) % frame_count;
        frame_delta = - frame_delta;
      }
    }

    if(next_frame != current_frame)
    {
      if(next_frame >= frame_count)
        next_frame = 0;
      sprite.SetCurrentFrame(next_frame);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

bool SpriteAnimation::finished [private]

Definition at line 50 of file spriteanimation.h.

int SpriteAnimation::frame_delta [private]

Definition at line 47 of file spriteanimation.h.

unsigned int SpriteAnimation::last_update [private]

Definition at line 45 of file spriteanimation.h.

bool SpriteAnimation::loop [private]

Definition at line 54 of file spriteanimation.h.

bool SpriteAnimation::pingpong [private]

Definition at line 55 of file spriteanimation.h.

SpriteShowOnFinish SpriteAnimation::show_on_finish [private]

Definition at line 51 of file spriteanimation.h.

float SpriteAnimation::speed_factor [private]

Definition at line 46 of file spriteanimation.h.

Sprite& SpriteAnimation::sprite [private]

Definition at line 42 of file spriteanimation.h.

---

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

• src/graphic/spriteanimation.h
• src/graphic/spriteanimation.cpp

---