spk::Animation2D Class Reference

Stores a sequence of meshes and a duration to sample frames from. More...

#include <spk_animation_2d.hpp>

Collaboration diagram for spk::Animation2D:

Public Member Functions
	Animation2D ()
	Builds an empty animation with a zero duration.
void	setDuration (const spk::Duration &p_duration)
	Sets the animation duration.
const spk::Duration &	duration () const
	Returns the animation duration.
void	setSpriteSequence (const std::vector< spk::Mesh2D > &p_meshes)
	Replaces the sprite sequence.
void	addSprite (const spk::Mesh2D &p_mesh)
	Appends a mesh to the sprite sequence.
const std::vector< spk::Mesh2D > &	spriteSequence () const
	Returns the sprite sequence.
bool	isEmpty () const
	Checks whether the sprite sequence is empty.
const spk::Mesh2D &	currentMesh (float p_ratio) const
	Returns the mesh for a normalized animation ratio.

Detailed Description

Stores a sequence of meshes and a duration to sample frames from.

Member Function Documentation

addSprite()

void spk::Animation2D::addSprite

(

const spk::Mesh2D &

p_mesh

)

Appends a mesh to the sprite sequence.

Parameters

p_mesh

Mesh to append.

currentMesh()

const spk::Mesh2D & spk::Animation2D::currentMesh

(

float

p_ratio

)

const

Returns the mesh for a normalized animation ratio.

Parameters

p_ratio

Normalized time in [0, 1].

Returns

Reference to the sampled mesh.

duration()

const spk::Duration & spk::Animation2D::duration

(

)

const

Returns the animation duration.

Returns

Reference to the duration.

isEmpty()

bool spk::Animation2D::isEmpty

(

)

const

Checks whether the sprite sequence is empty.

Returns

true when no meshes are present.

setDuration()

void spk::Animation2D::setDuration

(

const spk::Duration &

p_duration

)

Sets the animation duration.

Parameters

p_duration

Total animation duration.

setSpriteSequence()

void spk::Animation2D::setSpriteSequence

(

const std::vector< spk::Mesh2D > &

p_meshes

)

Replaces the sprite sequence.

Parameters

p_meshes

Sequence of meshes to use as frames.

spriteSequence()

const std::vector< spk::Mesh2D > & spk::Animation2D::spriteSequence

(

)

const

Returns the sprite sequence.

Returns

Reference to the mesh sequence.

---

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

• includes/structure/engine/2d/spk_animation_2d.hpp
• srcs/structure/engine/2d/spk_animation_2d.cpp