Animation Class Reference

#include <animation.h>

Inheritance diagram for Animation:

Public Types
typedef std::vector< Frame >	Frames
typedef Frames::iterator	FramesIter
typedef Frames::const_iterator	FramesCIter
typedef Frames::reverse_iterator	FramesRevIter

Public Member Functions
	Animation ()
	Animation (const std::string &name)
void	addFrame (Image *const image, const int delay, const int offsetX, const int offsetY, const int rand)
void	addTerminator (const int rand)
size_t	getLength () const
void	addJump (const std::string &name, const int rand)
void	addLabel (const std::string &name)
void	addGoto (const std::string &name, const int rand)
void	addPause (const int delay, const int rand)
void	setLastFrameDelay (const int delay)
int	calcMemoryLocal () const
std::string	getCounterName () const
Public Member Functions inherited from MemoryCounter
	MemoryCounter ()
virtual	~MemoryCounter ()
int	calcMemory (const int level) const
virtual int	calcMemoryChilds (const int level) const

Protected Attributes
Frames	mFrames
std::string	mName
int	mDuration

Friends
class	AnimatedSprite
class	ParticleEmitter
class	SimpleAnimation

Detailed Description

An animation consists of several frames, each with their own delay and offset.

Definition at line 41 of file animation.h.

Member Typedef Documentation

Frames

typedef std::vector<Frame> Animation::Frames

Definition at line 83 of file animation.h.

FramesCIter

typedef Frames::const_iterator Animation::FramesCIter

Definition at line 85 of file animation.h.

FramesIter

typedef Frames::iterator Animation::FramesIter

Definition at line 84 of file animation.h.

FramesRevIter

typedef Frames::reverse_iterator Animation::FramesRevIter

Definition at line 86 of file animation.h.

Constructor & Destructor Documentation

Animation() [1/2]

Animation::Animation

(

)

Definition at line 30 of file animation.cpp.

                               :
    MemoryCounter(),
    mFrames(),
    mName("animation"),
    mDuration(0)
{
}

Referenced by calcMemoryLocal().

Animation() [2/2]

Animation::Animation ( const std::string &  name )

explicit

Definition at line 38 of file animation.cpp.

                                                    :
    MemoryCounter(),
    mFrames(),
    mName(name),
    mDuration(0)
{
}

Member Function Documentation

addFrame()

void Animation::addFrame	(	Image *const	image,
		const int	delay,
		const int	offsetX,
		const int	offsetY,
		const int	rand
	)

Appends a new animation at the end of the sequence.

Definition at line 46 of file animation.cpp.

{
    Frame frame
        = { image, delay, offsetX, offsetY, rand, FrameType::ANIMATION, "" };
    mFrames.push_back(frame);
    mDuration += delay;
}

References FrameType::ANIMATION.

Referenced by SpriteDef::addSequence(), SimpleAnimation::initializeAnimation(), SpriteDef::loadAnimation(), ParticleEmitter::ParticleEmitter(), ProgressIndicator::ProgressIndicator(), and MapReader::readTileset().

addGoto()

void Animation::addGoto	(	const std::string &	name,
		const int	rand
	)

Definition at line 73 of file animation.cpp.

{
    const Frame frame = { nullptr, 0, 0, 0, rand, FrameType::GOTO, name };
    mFrames.push_back(frame);
}

References FrameType::GOTO.

Referenced by SpriteDef::loadAnimation().

addJump()

void Animation::addJump	(	const std::string &	name,
		const int	rand
	)

Definition at line 61 of file animation.cpp.

{
    const Frame frame = { nullptr, 0, 0, 0, rand, FrameType::JUMP, name };
    mFrames.push_back(frame);
}

References FrameType::JUMP.

Referenced by SpriteDef::loadAnimation().

addLabel()

void Animation::addLabel

(

const std::string &

name

)

Definition at line 67 of file animation.cpp.

{
    const Frame frame = { nullptr, 0, 0, 0, 100, FrameType::LABEL, name };
    mFrames.push_back(frame);
}

References FrameType::LABEL.

Referenced by SpriteDef::loadAnimation().

addPause()

void Animation::addPause	(	const int	delay,
		const int	rand
	)

Definition at line 79 of file animation.cpp.

{
    const Frame frame = { nullptr, delay, 0, 0, rand, FrameType::PAUSE, "" };
    mFrames.push_back(frame);
}

References FrameType::PAUSE.

Referenced by SpriteDef::loadAnimation().

addTerminator()

void Animation::addTerminator

(

const int

rand

)

Appends an animation terminator that states that the animation should not loop.

Definition at line 56 of file animation.cpp.

{
    addFrame(nullptr, 0, 0, 0, rand);
}

Referenced by SimpleAnimation::initializeAnimation(), SpriteDef::loadAnimation(), and ParticleEmitter::ParticleEmitter().

calcMemoryLocal()

int Animation::calcMemoryLocal ( ) const

virtual

Reimplemented from MemoryCounter.

Definition at line 98 of file animation.cpp.

{
    int sz = sizeof(Animation);
    FOR_EACH (FramesCIter, it, mFrames)
    {
        const Frame &frame = *it;
        sz += static_cast<int>(sizeof(Frame) +
            frame.nextAction.capacity());
    }
    return sz;
}

References Animation(), FOR_EACH, mFrames, and Frame::nextAction.

getCounterName()

std::string Animation::getCounterName ( ) const

inlinevirtual

Reimplemented from MemoryCounter.

Definition at line 95 of file animation.h.

        { return mName; }

References mName.

getLength()

size_t Animation::getLength ( ) const

inline

Returns the length of this animation in frames.

Definition at line 70 of file animation.h.

        { return mFrames.size(); }

References mFrames.

Referenced by AnimatedSprite::getFrameCount(), SimpleAnimation::getLength(), AnimatedSprite::play(), MapReader::readTileset(), SimpleAnimation::setFrame(), and SimpleAnimation::update().

setLastFrameDelay()

void Animation::setLastFrameDelay

(

const int

delay

)

Definition at line 85 of file animation.cpp.

{
    for (FramesRevIter it = mFrames.rbegin(), it_end = mFrames.rend();
         it != it_end; ++ it)
    {
        if ((*it).type == FrameType::ANIMATION && ((*it).image != nullptr))
        {
            (*it).delay = delay;
            break;
        }
    }
}

References FrameType::ANIMATION.

Referenced by Action::setLastFrameDelay().

Friends And Related Function Documentation

AnimatedSprite

friend class AnimatedSprite

friend

Definition at line 43 of file animation.h.

ParticleEmitter

friend class ParticleEmitter

friend

Definition at line 44 of file animation.h.

SimpleAnimation

friend class SimpleAnimation

friend

Definition at line 45 of file animation.h.

Field Documentation

mDuration

int Animation::mDuration

protected

Definition at line 101 of file animation.h.

mFrames

Frames Animation::mFrames

protected

Definition at line 99 of file animation.h.

Referenced by calcMemoryLocal(), ParticleEmitter::createParticles(), getLength(), AnimatedSprite::reset(), SimpleAnimation::setFrame(), SimpleAnimation::SimpleAnimation(), and SimpleAnimation::update().

mName

std::string Animation::mName

protected

Definition at line 100 of file animation.h.

Referenced by getCounterName().

---

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

• src/resources/animation/animation.h (986a3bf)
• src/resources/animation/animation.cpp (986a3bf)