Sprite Class Reference

#include <sprite.hpp>

List of all members.

Public Member Functions
	Sprite (SpriteData &data)
	~Sprite ()
SpritePtr	clone () const
void	draw (DrawingContext &context, const Vector &pos, int layer, DrawingEffect effect=NO_EFFECT)
	Draw sprite, automatically calculates next frame.
void	draw_part (DrawingContext &context, const Vector &source, const Vector &size, const Vector &pos, int layer)
void	set_action (const std::string &name, int loops=-1)
	Set action (or state).
void	set_action_continued (const std::string &name)
	Set action (or state), but keep current frame number, loop counter, etc.
void	set_animation_loops (int loops=-1)
	Set number of animation cycles until animation stops.
void	stop_animation ()
bool	animation_done ()
	Check if animation is stopped or not.
float	get_fps () const
unsigned int	get_frames () const
	Get current action total frames.
const std::string &	get_name () const
	Get sprite's name.
const std::string &	get_action () const
	Get current action name.
int	get_width () const
int	get_height () const
float	get_current_hitbox_x_offset () const
	return x-offset of current action's hitbox, relative to start of image
float	get_current_hitbox_y_offset () const
	return y-offset of current action's hitbox, relative to start of image
float	get_current_hitbox_width () const
	return width of current action's hitbox
float	get_current_hitbox_height () const
	return height of current action's hitbox
Rectf	get_current_hitbox () const
	return current action's hitbox, relative to 0,0
void	set_angle (float angle)
	Set the angle of the sprite rotation in degree.
float	get_angle () const
	Get the angle of the sprite rotation in degree.
void	set_color (const Color &color)
Color	get_color () const
void	set_blend (const Blend &blend)
Blend	get_blend () const
unsigned int	get_frame () const
	Get current frame.
void	set_frame (int frame_)
	Set current frame.
SurfacePtr	get_frame (unsigned int frame_)
bool	has_action (const std::string &name)
Private Member Functions
void	update ()
	Sprite (const Sprite &other)
Sprite &	operator= (const Sprite &)
Private Attributes
SpriteData &	data
float	frame
unsigned int	frameidx
int	animation_loops
float	last_ticks
float	angle
Color	color
Blend	blend
const SpriteData::Action *	action

---

Detailed Description

Definition at line 28 of file sprite.hpp.

---

Constructor & Destructor Documentation

Sprite::Sprite

(

SpriteData &

data

)

Definition at line 24 of file sprite.cpp.

References action, SpriteData::actions, data, game_time, and last_ticks.

Referenced by clone().

                                  :
  data(newdata),
  frame(0),
  frameidx(0),
  animation_loops(-1),
  last_ticks(),
  angle(0.0f),
  color(1.0f, 1.0f, 1.0f, 1.0f),
  blend(),
  action(data.get_action("normal"))
{
  if(!action)
    action = data.actions.begin()->second;
  last_ticks = game_time;
}

Sprite::~Sprite

(

)

Definition at line 53 of file sprite.cpp.

{
}

Sprite::Sprite

(

const Sprite &

other

)

[private]

Definition at line 40 of file sprite.cpp.

                                  :
  data(other.data), 
  frame(other.frame),
  frameidx(other.frameidx),
  animation_loops(other.animation_loops),
  last_ticks(game_time),
  angle(0.0f), // FIXME: this can't be right
  color(1.0f, 1.0f, 1.0f, 1.0f),
  blend(),
  action(other.action)
{
}

---

Member Function Documentation

SpritePtr Sprite::clone

(

)

const

Definition at line 58 of file sprite.cpp.

References Sprite().

{
  return SpritePtr(new Sprite(*this));
}

void Sprite::draw	(	DrawingContext &	context,
		const Vector &	pos,
		int	layer,
		DrawingEffect	effect = NO_EFFECT
	)

Draw sprite, automatically calculates next frame.

Definition at line 133 of file sprite.cpp.

References action, angle, blend, color, DrawingContext::draw_surface(), frameidx, DrawingContext::set_drawing_effect(), SpriteData::Action::surfaces, update(), SpriteData::Action::x_offset, SpriteData::Action::y_offset, and SpriteData::Action::z_order.

{
  assert(action != 0);
  update();

  context.set_drawing_effect(effect);
  context.draw_surface(action->surfaces[frameidx],
                       pos - Vector(action->x_offset, action->y_offset),
                       angle,
                       color,
                       blend,
                       layer + action->z_order);
}

void Sprite::draw_part	(	DrawingContext &	context,
		const Vector &	source,
		const Vector &	size,
		const Vector &	pos,
		int	layer
	)

Definition at line 149 of file sprite.cpp.

References action, DrawingContext::draw_surface_part(), frameidx, SpriteData::Action::surfaces, update(), SpriteData::Action::x_offset, SpriteData::Action::y_offset, and SpriteData::Action::z_order.

{
  assert(action != 0);
  update();

  context.draw_surface_part(action->surfaces[frameidx], source, size,
                            pos - Vector(action->x_offset, action->y_offset),
                            layer + action->z_order);
}

void Sprite::set_action	(	const std::string &	name,
		int	loops = -1
	)

Set action (or state).

Definition at line 64 of file sprite.cpp.

References action, animation_loops, data, frame, frameidx, SpriteData::get_action(), log_debug, and SpriteData::Action::name.

{
  if(action && action->name == name)
    return;

  const SpriteData::Action* newaction = data.get_action(name);
  if(!newaction) {
    log_debug << "Action '" << name << "' not found." << std::endl;
    return;
  }

  action = newaction;
  animation_loops = loops;
  frame = 0;
  frameidx = 0;
}

void Sprite::set_action_continued

(

const std::string &

name

)

Set action (or state), but keep current frame number, loop counter, etc.

Definition at line 82 of file sprite.cpp.

References action, data, SpriteData::get_action(), log_debug, SpriteData::Action::name, and update().

{
  if(action && action->name == name)
    return;

  const SpriteData::Action* newaction = data.get_action(name);
  if(!newaction) {
    log_debug << "Action '" << name << "' not found." << std::endl;
    return;
  }

  action = newaction;
  update();
}

void Sprite::set_animation_loops

(

int

loops = -1

)

[inline]

Set number of animation cycles until animation stops.

Definition at line 50 of file sprite.hpp.

References animation_loops.

  { animation_loops = loops; }

void Sprite::stop_animation

(

)

[inline]

Definition at line 54 of file sprite.hpp.

References animation_loops.

  { animation_loops = 0; }

bool Sprite::animation_done

(

)

Check if animation is stopped or not.

Definition at line 98 of file sprite.cpp.

References animation_loops.

Referenced by update().

{
  return animation_loops == 0;
}

float Sprite::get_fps

(

)

const [inline]

Definition at line 59 of file sprite.hpp.

References action, and SpriteData::Action::fps.

  { return action->fps; }

unsigned int Sprite::get_frames

(

)

const [inline]

Get current action total frames.

Definition at line 62 of file sprite.hpp.

References action, and SpriteData::Action::surfaces.

Referenced by get_height(), get_width(), set_frame(), and update().

  { return action->surfaces.size(); }

const std::string& Sprite::get_name

(

)

const [inline]

Get sprite's name.

Definition at line 65 of file sprite.hpp.

References data, and SpriteData::name.

  { return data.name; }

const std::string& Sprite::get_action

(

)

const [inline]

Get current action name.

Definition at line 68 of file sprite.hpp.

References action, and SpriteData::Action::name.

  { return action->name; }

int Sprite::get_width

(

)

const

Definition at line 161 of file sprite.cpp.

References action, frameidx, get_frame(), get_frames(), and SpriteData::Action::surfaces.

{
  assert(frameidx < get_frames());
  return (int) action->surfaces[get_frame()]->get_width();
}

int Sprite::get_height

(

)

const

Definition at line 168 of file sprite.cpp.

References action, frameidx, get_frame(), get_frames(), and SpriteData::Action::surfaces.

{
  assert(frameidx < get_frames());
  return (int) action->surfaces[get_frame()]->get_height();
}

float Sprite::get_current_hitbox_x_offset

(

)

const

return x-offset of current action's hitbox, relative to start of image

Definition at line 175 of file sprite.cpp.

References action, and SpriteData::Action::x_offset.

{
  return action->x_offset;
}

float Sprite::get_current_hitbox_y_offset

(

)

const

return y-offset of current action's hitbox, relative to start of image

Definition at line 181 of file sprite.cpp.

References action, and SpriteData::Action::y_offset.

{
  return action->y_offset;
}

float Sprite::get_current_hitbox_width

(

)

const

return width of current action's hitbox

Definition at line 187 of file sprite.cpp.

References action, and SpriteData::Action::hitbox_w.

{
  return action->hitbox_w;
}

float Sprite::get_current_hitbox_height

(

)

const

return height of current action's hitbox

Definition at line 193 of file sprite.cpp.

References action, and SpriteData::Action::hitbox_h.

{
  return action->hitbox_h;
}

Rectf Sprite::get_current_hitbox

(

)

const

return current action's hitbox, relative to 0,0

Definition at line 199 of file sprite.cpp.

References action, SpriteData::Action::hitbox_h, SpriteData::Action::hitbox_w, SpriteData::Action::x_offset, and SpriteData::Action::y_offset.

{
  return Rectf(action->x_offset, action->y_offset, action->x_offset + action->hitbox_w, action->y_offset + action->hitbox_h);
}

void Sprite::set_angle

(

float

angle

)

Set the angle of the sprite rotation in degree.

Definition at line 205 of file sprite.cpp.

References angle.

{
  angle = a;
}

float Sprite::get_angle

(

)

const

Get the angle of the sprite rotation in degree.

Definition at line 211 of file sprite.cpp.

References angle.

{
  return angle;
}

void Sprite::set_color

(

const Color &

color

)

Definition at line 217 of file sprite.cpp.

References color.

{
  color = c;
}

Color Sprite::get_color

(

)

const

Definition at line 223 of file sprite.cpp.

References color.

{
  return color;
}

void Sprite::set_blend

(

const Blend &

blend

)

Definition at line 229 of file sprite.cpp.

References blend.

{
  blend = b;
}

Blend Sprite::get_blend

(

)

const

Definition at line 235 of file sprite.cpp.

References blend.

{
  return blend;
}

unsigned int Sprite::get_frame

(

)

const [inline]

Get current frame.

Definition at line 100 of file sprite.hpp.

References frameidx.

Referenced by get_height(), and get_width().

  { return frameidx; }

void Sprite::set_frame

(

int

frame_

)

[inline]

Set current frame.

Definition at line 103 of file sprite.hpp.

References frame, frameidx, and get_frames().

  {
    this->frame = 0;
    this->frameidx = frame_ % get_frames();
  }

SurfacePtr Sprite::get_frame

(

unsigned int

frame_

)

[inline]

Definition at line 108 of file sprite.hpp.

References action, and SpriteData::Action::surfaces.

  {
    assert(frame_ < action->surfaces.size());
    return action->surfaces[frame_];
  }

bool Sprite::has_action

(

const std::string &

name

)

[inline]

Definition at line 114 of file sprite.hpp.

References data, and SpriteData::get_action().

  {
    return (data.get_action(name) != NULL);
  }

void Sprite::update

(

)

[private]

Definition at line 104 of file sprite.cpp.

References action, animation_done(), animation_loops, SpriteData::Action::fps, frame, frameidx, game_time, get_frames(), and last_ticks.

Referenced by draw(), draw_part(), and set_action_continued().

{
  float frame_inc = action->fps * (game_time - last_ticks);
  last_ticks = game_time;

  frame += frame_inc;

  while(frame >= 1.0f) {
    frame -= 1.0f;
    frameidx++;
  }

  while(frameidx >= get_frames()) {
    frameidx -= get_frames();
    animation_loops--;
    if(animation_done()) {
      break;
    }
  }

  if(animation_done()) {
    frame = 0;
    frameidx = get_frames()-1;
  }

  assert(frameidx < get_frames());
}

Sprite& Sprite::operator=

(

const Sprite &

)

[private]

---

Member Data Documentation

SpriteData& Sprite::data [private]

Definition at line 122 of file sprite.hpp.

Referenced by get_name(), has_action(), set_action(), set_action_continued(), and Sprite().

float Sprite::frame [private]

Definition at line 125 of file sprite.hpp.

Referenced by set_action(), set_frame(), and update().

unsigned int Sprite::frameidx [private]

Definition at line 127 of file sprite.hpp.

Referenced by draw(), draw_part(), get_frame(), get_height(), get_width(), set_action(), set_frame(), and update().

int Sprite::animation_loops [private]

Definition at line 128 of file sprite.hpp.

Referenced by animation_done(), set_action(), set_animation_loops(), stop_animation(), and update().

float Sprite::last_ticks [private]

Definition at line 129 of file sprite.hpp.

Referenced by Sprite(), and update().

float Sprite::angle [private]

Definition at line 130 of file sprite.hpp.

Referenced by draw(), get_angle(), and set_angle().

Color Sprite::color [private]

Definition at line 131 of file sprite.hpp.

Referenced by draw(), get_color(), and set_color().

Blend Sprite::blend [private]

Definition at line 132 of file sprite.hpp.

Referenced by draw(), get_blend(), and set_blend().

const SpriteData::Action* Sprite::action [private]

Definition at line 134 of file sprite.hpp.

Referenced by draw(), draw_part(), get_action(), get_current_hitbox(), get_current_hitbox_height(), get_current_hitbox_width(), get_current_hitbox_x_offset(), get_current_hitbox_y_offset(), get_fps(), get_frame(), get_frames(), get_height(), get_width(), set_action(), set_action_continued(), Sprite(), and update().

---

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

• src/sprite/sprite.hpp
• src/sprite/sprite.cpp

---