Action Class Reference

#include <action.h>

Inheritance diagram for Action:

Public Member Functions
	Action (const std::string &name)
	~Action ()
void	setAnimation (const SpriteDirection::Type direction, Animation *const animation)
const Animation *	getAnimation (SpriteDirection::Type direction) const
unsigned	getNumber () const
void	setNumber (const unsigned n)
void	setLastFrameDelay (const int delay)
int	calcMemoryLocal () const
int	calcMemoryChilds (const int level) const
std::string	getCounterName () const
Public Member Functions inherited from MemoryCounter
	MemoryCounter ()
virtual	~MemoryCounter ()
int	calcMemory (const int level) const

Protected Types
typedef std::map< SpriteDirection::Type, Animation * >	Animations
typedef Animations::iterator	AnimationIter
typedef Animations::const_iterator	AnimationCIter

Protected Attributes
Animations	mAnimations
std::string	mCounterName
unsigned	mNumber

Detailed Description

An action consists of several animations, one for each direction.

Definition at line 40 of file action.h.

Member Typedef Documentation

AnimationCIter

typedef Animations::const_iterator Action::AnimationCIter

protected

Definition at line 73 of file action.h.

AnimationIter

typedef Animations::iterator Action::AnimationIter

protected

Definition at line 72 of file action.h.

Animations

typedef std::map<SpriteDirection::Type, Animation*> Action::Animations

protected

Definition at line 71 of file action.h.

Constructor & Destructor Documentation

Action()

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

explicit

Definition at line 33 of file action.cpp.

                                              :
    MemoryCounter(),
    mAnimations(),
    mCounterName(name),
    mNumber(100)
{
}

Referenced by calcMemoryLocal().

~Action()

Action::~Action

(

)

Definition at line 41 of file action.cpp.

{
    delete_all(mAnimations);
}

References delete_all(), and mAnimations.

Member Function Documentation

calcMemoryChilds()

int Action::calcMemoryChilds ( const int  level ) const

virtual

Reimplemented from MemoryCounter.

Definition at line 96 of file action.cpp.

{
    int sz = 0;
    FOR_EACH (AnimationCIter, it, mAnimations)
    {
        sz += sizeof(SpriteDirection::Type);
        const Animation *const animation = (*it).second;
        sz += animation->calcMemory(level + 1);
    }
    return sz;
}

References MemoryCounter::calcMemory(), FOR_EACH, and mAnimations.

calcMemoryLocal()

int Action::calcMemoryLocal ( ) const

virtual

Reimplemented from MemoryCounter.

Definition at line 91 of file action.cpp.

{
    return sizeof(Action);
}

References Action().

getAnimation()

const Animation * Action::getAnimation

(

SpriteDirection::Type

direction

)

const

Definition at line 46 of file action.cpp.

{
    Animations::const_iterator i = mAnimations.find(direction);
 
    if (i == mAnimations.end())
    {
        if (direction == SpriteDirection::UPLEFT
            || direction == SpriteDirection::UPRIGHT)
        {
            direction = SpriteDirection::UP;
        }
        else if (direction == SpriteDirection::DOWNLEFT
                 || direction == SpriteDirection::DOWNRIGHT)
        {
            direction = SpriteDirection::DOWN;
        }
        i = mAnimations.find(direction);
 
        // When the given direction is not available, return the first one.
        // (either DEFAULT, or more usually DOWN).
        if (i == mAnimations.end())
            i = mAnimations.begin();
    }
 
    return (i == mAnimations.end()) ? nullptr : i->second;
}

References SpriteDirection::DOWN, SpriteDirection::DOWNLEFT, SpriteDirection::DOWNRIGHT, nullptr, SpriteDirection::UP, SpriteDirection::UPLEFT, and SpriteDirection::UPRIGHT.

getCounterName()

std::string Action::getCounterName ( ) const

inlinevirtual

Reimplemented from MemoryCounter.

Definition at line 67 of file action.h.

        { return mCounterName; }

References mCounterName.

getNumber()

unsigned Action::getNumber ( ) const

inline

Definition at line 55 of file action.h.

        { return mNumber; }

References mNumber.

setAnimation()

void Action::setAnimation	(	const SpriteDirection::Type	direction,
		Animation *const	animation
	)

Definition at line 74 of file action.cpp.

{
    mAnimations[direction] = animation;
}

Referenced by SpriteDef::loadAnimation().

setLastFrameDelay()

void Action::setLastFrameDelay

(

const int

delay

)

Definition at line 80 of file action.cpp.

{
    FOR_EACH (AnimationIter, it, mAnimations)
    {
        Animation *const animation = (*it).second;
        if (animation == nullptr)
            continue;
        animation->setLastFrameDelay(delay);
    }
}

References FOR_EACH, and Animation::setLastFrameDelay().

setNumber()

void Action::setNumber ( const unsigned  n )

inline

Definition at line 58 of file action.h.

        { mNumber = n; }

References mNumber.

Referenced by SpriteDef::loadAction().

Field Documentation

mAnimations

Animations Action::mAnimations

protected

Definition at line 75 of file action.h.

Referenced by calcMemoryChilds(), and ~Action().

mCounterName

std::string Action::mCounterName

protected

Definition at line 76 of file action.h.

Referenced by getCounterName().

mNumber

unsigned Action::mNumber

protected

Definition at line 77 of file action.h.

Referenced by getNumber(), and setNumber().

---

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

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