AnimatedSprite Class Reference

#include <animatedsprite.h>

Inheritance diagram for AnimatedSprite:

Public Member Functions
	AnimatedSprite (SpriteDef *const sprite)
	~AnimatedSprite ()
bool	reset ()
bool	play (const std::string &spriteAction)
bool	update (const int time)
void	draw (Graphics *const graphics, const int posX, const int posY) const
void	drawRescaled (Graphics *const graphics, const int posX, const int posY, const int dx, const int dy) const
void	drawRaw (Graphics *const graphics, const int posX, const int posY) const
int	getWidth () const
int	getHeight () const
const Image *	getImage () const
bool	setSpriteDirection (const SpriteDirection::Type direction)
int	getNumberOfLayers () const
std::string	getIdPath () const
unsigned int	getCurrentFrame () const
unsigned int	getFrameCount () const
void	setAlpha (float alpha)
const void *	getHash () const
bool	updateNumber (const unsigned num)
void	clearDelayLoad ()
void	setSprite (SpriteDef *const sprite)
bool	isTerminated () const
void	setLastTime (const int time)
Public Member Functions inherited from Sprite
virtual	~Sprite ()
virtual float	getAlpha () const
virtual const void *	getHash2 () const

Static Public Member Functions
static AnimatedSprite *	load (const std::string &filename, const int variant)
static AnimatedSprite *	delayedLoad (const std::string &filename, const int variant)
static AnimatedSprite *	clone (const AnimatedSprite *const anim)
static void	setEnableCache (const bool b)

Private Member Functions
bool	updateCurrentAnimation (const unsigned int dt)
void	setDelayLoad (const std::string &filename, const int variant)

Private Attributes
SpriteDirection::Type	mDirection
int	mLastTime
unsigned int	mFrameIndex
unsigned int	mFrameTime
SpriteDef *	mSprite
const Action *	mAction
const Animation *	mAnimation
const Frame *	mFrame
unsigned	mNumber
unsigned	mNumber1
AnimationDelayLoad *	mDelayLoad
bool	mTerminated

Static Private Attributes
static bool	mEnableCache = false

Additional Inherited Members
Protected Member Functions inherited from Sprite
	Sprite ()
Protected Attributes inherited from Sprite
float	mAlpha

Detailed Description

Animates a sprite by adding playback state.

Definition at line 36 of file animatedsprite.h.

Constructor & Destructor Documentation

AnimatedSprite()

AnimatedSprite::AnimatedSprite ( SpriteDef *const  sprite )

explicit

Constructor.

Parameters

sprite

the sprite to animate

Definition at line 51 of file animatedsprite.cpp.

                                                               :
    mDirection(SpriteDirection::DOWN),
    mLastTime(0),
    mFrameIndex(0),
    mFrameTime(0),
    mSprite(sprite),
    mAction(nullptr),
    mAnimation(nullptr),
    mFrame(nullptr),
    mNumber(100),
    mNumber1(100),
    mDelayLoad(nullptr),
    mTerminated(false)
{
    mAlpha = 1.0F;
 
    // Take possession of the sprite
    if (mSprite != nullptr)
        mSprite->incRef();
}

References Resource::incRef(), Sprite::mAlpha, and mSprite.

Referenced by clone(), delayedLoad(), and load().

~AnimatedSprite()

AnimatedSprite::~AnimatedSprite

(

)

Definition at line 127 of file animatedsprite.cpp.

{
    if (mSprite != nullptr)
    {
        mSprite->decRef();
        mSprite = nullptr;
    }
    if (mDelayLoad != nullptr)
    {
        mDelayLoad->clearSprite();
        DelayedManager::removeDelayLoad(mDelayLoad);
        delete2(mDelayLoad)
    }
}

References AnimationDelayLoad::clearSprite(), Resource::decRef(), delete2, mDelayLoad, mSprite, and DelayedManager::removeDelayLoad().

Member Function Documentation

clearDelayLoad()

void AnimatedSprite::clearDelayLoad ( )

inline

Definition at line 115 of file animatedsprite.h.

        { mDelayLoad = nullptr; }

References mDelayLoad.

Referenced by AnimationDelayLoad::~AnimationDelayLoad().

clone()

AnimatedSprite * AnimatedSprite::clone ( const AnimatedSprite *const  anim )

static

Definition at line 113 of file animatedsprite.cpp.

{
    if (anim == nullptr)
        return nullptr;
    AnimatedSprite *restrict const sprite = new AnimatedSprite(anim->mSprite);
#ifdef DEBUG_ANIMATIONS
    sprite->setSpriteName(anim->getSpriteName());
#endif  // DEBUG_ANIMATIONS
 
    sprite->play(SpriteAction::STAND);
    return sprite;
}

References AnimatedSprite(), restrict, and SpriteAction::STAND().

Referenced by Being::setEmote().

delayedLoad()

AnimatedSprite * AnimatedSprite::delayedLoad ( const std::string &  filename, const int  variant  )

static

Definition at line 89 of file animatedsprite.cpp.

{
    if (!mEnableCache)
        return load(filename, variant);
    Resource *restrict const res = ResourceManager::getFromCache(
        filename, variant);
    if (res != nullptr)
    {
        res->decRef();
        return load(filename, variant);
    }
 
    AnimatedSprite *restrict const as = new AnimatedSprite(nullptr);
#ifdef DEBUG_ANIMATIONS
    as->setSpriteName(filename);
#endif  // DEBUG_ANIMATIONS
 
    as->play(SpriteAction::STAND);
    as->setDelayLoad(filename, variant);
    return as;
}

References AnimatedSprite(), ResourceManager::getFromCache(), load(), mEnableCache, restrict, and SpriteAction::STAND().

Referenced by Being::setGender(), Being::setHairTempSprite(), Being::setSpriteCards(), Being::setSpriteColor(), Being::setSpriteColorId(), Being::setSpriteId(), Being::setTempSprite(), and ActorSprite::setupSpriteDisplay().

draw()

void AnimatedSprite::draw ( Graphics *const  graphics, const int  posX, const int  posY  ) const

virtual

Draw the current animation frame at the coordinates given in screen pixels.

Implements Sprite.

Definition at line 328 of file animatedsprite.cpp.

{
    FUNC_BLOCK("AnimatedSprite::draw", 1)
    if ((mFrame == nullptr) || (mFrame->image == nullptr))
        return;
 
    Image *restrict const image = mFrame->image;
    image->setAlpha(mAlpha);
    graphics->drawImage(image,
        posX + mFrame->offsetX, posY + mFrame->offsetY);
}

References FUNC_BLOCK, and restrict.

Referenced by Being::drawBeingCursor(), and MiniStatusWindow::drawIcons().

drawRaw()

void AnimatedSprite::drawRaw	(	Graphics *const	graphics,
		const int	posX,
		const int	posY
	)		const

Definition at line 363 of file animatedsprite.cpp.

{
    if ((mFrame == nullptr) || (mFrame->image == nullptr))
        return;
 
    Image *restrict const image = mFrame->image;
    image->setAlpha(mAlpha);
    graphics->drawImage(image,
        posX,
        posY);
}

References restrict.

Referenced by CutInWindow::draw2().

drawRescaled()

void AnimatedSprite::drawRescaled	(	Graphics *const	graphics,
		const int	posX,
		const int	posY,
		const int	dx,
		const int	dy
	)		const

Definition at line 342 of file animatedsprite.cpp.

{
    if (mFrame == nullptr ||
        mFrame->image == nullptr)
    {
        return;
    }
 
    Image *restrict const image = mFrame->image;
    image->setAlpha(mAlpha);
    graphics->drawRescaledImage(image,
        posX + mFrame->offsetX,
        posY + mFrame->offsetY,
        dx,
        dy);
}

References restrict.

Referenced by CastingEffect::draw().

getCurrentFrame()

unsigned int AnimatedSprite::getCurrentFrame ( ) const

inlinevirtual

Returns the current frame number for the sprite.

Implements Sprite.

Definition at line 102 of file animatedsprite.h.

        { return mFrameIndex; }

References mFrameIndex.

getFrameCount()

unsigned int AnimatedSprite::getFrameCount ( ) const

virtual

Returns the frame count for the sprite.

Implements Sprite.

Definition at line 404 of file animatedsprite.cpp.

{
    if (mAnimation != nullptr)
        return CAST_U32(mAnimation->getLength());
    return 0;
}

References CAST_U32, Animation::getLength(), and mAnimation.

getHash()

const void * AnimatedSprite::getHash ( ) const

virtual

Reimplemented from Sprite.

Definition at line 449 of file animatedsprite.cpp.

{
    if (mFrame != nullptr)
        return mFrame;
    return this;
}

References mFrame.

getHeight()

int AnimatedSprite::getHeight ( ) const

virtual

Gets the height in pixels of the image of the current frame

Implements Sprite.

Definition at line 418 of file animatedsprite.cpp.

{
    if ((mFrame != nullptr) && (mFrame->image != nullptr))
        return mFrame->image->mBounds.h;
    return 0;
}

References Frame::image, and mFrame.

Referenced by CutInWindow::show().

getIdPath()

std::string AnimatedSprite::getIdPath

(

)

const

Definition at line 425 of file animatedsprite.cpp.

{
    if (mSprite == nullptr)
        return "";
    return mSprite->mIdPath;
}

References Resource::mIdPath, and mSprite.

Referenced by LocalPlayer::imitateOutfit().

getImage()

const Image * AnimatedSprite::getImage ( ) const

virtual

Returns a reference to the current image being drawn.

Implements Sprite.

Definition at line 432 of file animatedsprite.cpp.

{
    return mFrame != nullptr ? mFrame->image : nullptr;
}

References Frame::image, and mFrame.

getNumberOfLayers()

int AnimatedSprite::getNumberOfLayers ( ) const

inline

Definition at line 97 of file animatedsprite.h.

        { return 1; }

getWidth()

int AnimatedSprite::getWidth ( ) const

virtual

Gets the width in pixels of the image of the current frame

Implements Sprite.

Definition at line 411 of file animatedsprite.cpp.

{
    if ((mFrame != nullptr) && (mFrame->image != nullptr))
        return mFrame->image->mBounds.w;
    return 0;
}

References Frame::image, and mFrame.

Referenced by MiniStatusWindow::drawIcons(), and CutInWindow::show().

isTerminated()

bool AnimatedSprite::isTerminated ( ) const

inline

Definition at line 121 of file animatedsprite.h.

        { return mTerminated; }

References mTerminated.

Referenced by CastingEffect::isTerminated(), and Being::logic().

load()

AnimatedSprite * AnimatedSprite::load ( const std::string &  filename, const int  variant  )

static

An helper function, which will request the sprite to animate from the resource manager.

Parameters

filename	the file of the sprite to animate
variant	the sprite variant

Definition at line 72 of file animatedsprite.cpp.

{
    SpriteDef *restrict const s = Loader::getSprite(
        filename, variant);
    if (s == nullptr)
        return nullptr;
    AnimatedSprite *restrict const as = new AnimatedSprite(s);
#ifdef DEBUG_ANIMATIONS
    as->setSpriteName(filename);
#endif  // DEBUG_ANIMATIONS
 
    as->play(SpriteAction::STAND);
    s->decRef();
    return as;
}

References AnimatedSprite(), Loader::getSprite(), restrict, and SpriteAction::STAND().

Referenced by Being::addEffect(), delayedLoad(), StatusEffect::getIcon(), ActorSprite::initTargetCursor(), EmoteDB::load(), EmoteDB::loadSpecialXmlFile(), EmoteDB::loadXmlFile(), Being::setHorse(), Being::setLanguageId(), CutInWindow::show(), Being::showAwayBadge(), Being::showClanBadge(), Being::showGmBadge(), Being::showGuildBadge(), Being::showInactiveBadge(), Being::showNameBadge(), Being::showPartyBadge(), Being::showShopBadge(), and Being::showTeamBadge().

play()

bool AnimatedSprite::play ( const std::string &  action )

virtual

Plays an action using the current direction.

Returns

true if the sprite changed, false otherwise

Implements Sprite.

Definition at line 159 of file animatedsprite.cpp.

{
    if (mSprite == nullptr)
    {
        if (mDelayLoad == nullptr)
            return false;
        mDelayLoad->setAction(spriteAction);
        return true;
    }
 
    const Action *const action = mSprite->getAction(spriteAction, mNumber);
    if (action == nullptr)
        return false;
 
    mAction = action;
    const Animation *const animation = mAction->getAnimation(mDirection);
 
    if ((animation != nullptr) &&
        animation != mAnimation &&
        animation->getLength() > 0)
    {
        mAnimation = animation;
        reset();
 
        return true;
    }
 
    return false;
}

References Animation::getLength().

Referenced by AnimationDelayLoad::load(), Being::setAction(), and Being::setHorse().

reset()

bool AnimatedSprite::reset ( )

virtual

Resets the sprite.

Returns

true if the sprite changed, false otherwise

Implements Sprite.

Definition at line 142 of file animatedsprite.cpp.

{
    const bool ret = mFrameIndex !=0 ||
        mFrameTime != 0 ||
        mLastTime != 0;
 
    mFrameIndex = 0;
    mFrameTime = 0;
    mLastTime = 0;
 
    if (mAnimation != nullptr)
        mFrame = &mAnimation->mFrames[0];
    else
        mFrame = nullptr;
    return ret;
}

References mAnimation, mFrame, mFrameIndex, Animation::mFrames, mFrameTime, and mLastTime.

setAlpha()

void AnimatedSprite::setAlpha ( float  alpha )

virtual

Sets the alpha value of the animated sprite

Reimplemented from Sprite.

Definition at line 437 of file animatedsprite.cpp.

{
    mAlpha = alpha;
 
    if (mFrame != nullptr)
    {
        Image *restrict const image = mFrame->image;
        if (image != nullptr)
            image->setAlpha(mAlpha);
    }
}

References restrict.

setDelayLoad()

void AnimatedSprite::setDelayLoad ( const std::string &  filename, const int  variant  )

private

Definition at line 475 of file animatedsprite.cpp.

{
    if (mDelayLoad != nullptr)
    {
        mDelayLoad->clearSprite();
        DelayedManager::removeDelayLoad(mDelayLoad);
        delete mDelayLoad;
    }
    mDelayLoad = new AnimationDelayLoad(filename, variant, this);
    DelayedManager::addDelayedAnimation(mDelayLoad);
}

References DelayedManager::addDelayedAnimation(), and DelayedManager::removeDelayLoad().

setEnableCache()

static void AnimatedSprite::setEnableCache ( const bool  b )

inlinestatic

Definition at line 124 of file animatedsprite.h.

        { mEnableCache = b; }

References mEnableCache.

Referenced by Game::Game(), and Game::~Game().

setLastTime()

void AnimatedSprite::setLastTime ( const int  time )

inline

Definition at line 127 of file animatedsprite.h.

        { mLastTime = time; }

References mLastTime.

setSprite()

void AnimatedSprite::setSprite ( SpriteDef *const  sprite )

inline

Definition at line 118 of file animatedsprite.h.

        { mSprite = sprite; }

References mSprite.

Referenced by AnimationDelayLoad::load().

setSpriteDirection()

bool AnimatedSprite::setSpriteDirection ( const SpriteDirection::Type  direction )

virtual

Sets the direction.

Returns

true if the sprite changed, false otherwise

Implements Sprite.

Definition at line 377 of file animatedsprite.cpp.

{
    if (mDirection != direction)
    {
        mDirection = direction;
 
        if (mAction == nullptr)
            return false;
 
        const Animation *restrict const animation =
            mAction->getAnimation(mDirection);
 
        if ((animation != nullptr) &&
            animation != mAnimation &&
            animation->getLength() > 0)
        {
            mAnimation = animation;
            reset();
        }
 
        return true;
    }
 
    return false;
}

References restrict.

Referenced by Being::setDirection(), and Being::setHorse().

update()

bool AnimatedSprite::update ( const int  time )

virtual

Inform the animation of the passed time so that it can output the correct animation frame.

Returns

true if the sprite changed, false otherwise

Implements Sprite.

Definition at line 189 of file animatedsprite.cpp.

{
    // Avoid freaking out at first frame or when tick_time overflows
    if (A_UNLIKELY(time < mLastTime || mLastTime == 0))
        mLastTime = time;
 
    // If not enough time has passed yet, do nothing
    if (time <= mLastTime || (mAnimation == nullptr))
        return false;
 
    const unsigned int dt = time - mLastTime;
    mLastTime = time;
 
    const Animation *restrict const animation = mAnimation;
    const Frame *restrict const frame = mFrame;
 
    if (A_UNLIKELY(!updateCurrentAnimation(dt)))
    {
        // Animation finished, reset to default
        play(SpriteAction::STAND);
        mTerminated = true;
    }
 
    // Make sure something actually changed
    return animation != mAnimation || frame != mFrame;
}

References A_UNLIKELY, restrict, and SpriteAction::STAND().

Referenced by Being::drawBeingCursor(), Being::logic(), CutInWindow::logic(), MiniStatusWindow::logic(), CutInWindow::show(), and CastingEffect::update().

updateCurrentAnimation()

bool AnimatedSprite::updateCurrentAnimation ( const unsigned int  dt )

private

Definition at line 216 of file animatedsprite.cpp.

{
    // move code from Animation::isTerminator(*mFrame)
    if (mFrame == nullptr ||
        mAnimation == nullptr ||
        (mFrame->image == nullptr && mFrame->type == FrameType::ANIMATION))
    {
        return false;
    }
 
    mFrameTime += time;
 
    while ((mFrameTime > CAST_U32(mFrame->delay) &&
           mFrame->delay > 0) ||
           (mFrame->type != FrameType::ANIMATION &&
           mFrame->type != FrameType::PAUSE))
    {
        bool fail(true);
        mFrameTime -= CAST_U32(mFrame->delay);
        mFrameIndex++;
 
        if (mFrameIndex >= CAST_U32(mAnimation->getLength()))
            mFrameIndex = 0;
 
        mFrame = &mAnimation->mFrames[mFrameIndex];
        if (mFrame->type == FrameType::LABEL &&
            !mFrame->nextAction.empty())
        {
            fail = false;
        }
        else if (mFrame->type == FrameType::GOTO &&
                 !mFrame->nextAction.empty())
        {
            const int rand = mFrame->rand;
            if (rand == 100 ||
                ((rand != 0) && rand >= mrand() % 100))
            {
                for (size_t i = 0; i < mAnimation->getLength(); i ++)
                {
                    const Frame *restrict const frame =
                        &mAnimation->mFrames[i];
                    if (frame->type == FrameType::LABEL &&
                        mFrame->nextAction == frame->nextAction)
                    {
                        mFrameIndex = CAST_U32(i);
                        if (mFrameIndex >= CAST_U32(
                            mAnimation->getLength()))
                        {
                            mFrameIndex = 0;
                        }
 
                        mFrame = &mAnimation->mFrames[mFrameIndex];
 
                        fail = false;
                        break;
                    }
                }
            }
            else
            {
                fail = false;
            }
        }
        else if (mFrame->type == FrameType::JUMP &&
                 !mFrame->nextAction.empty())
        {
            const int rand = mFrame->rand;
            if (rand == 100 ||
                ((rand != 0) && rand >= mrand() % 100))
            {
                play(mFrame->nextAction);
                return true;
            }
        }
        // copy code from Animation::isTerminator(*mFrame)
        else if ((mFrame->image == nullptr) &&
                 mFrame->type == FrameType::ANIMATION)
        {
            const int rand = mFrame->rand;
            if (rand == 100 ||
                ((rand != 0) && rand >= mrand() % 100))
            {
                mAnimation = nullptr;
                mFrame = nullptr;
                return false;
            }
        }
        else
        {
            const int rand = mFrame->rand;
            if (rand == 100 ||
                mFrameIndex >= CAST_U32(mAnimation->getLength()))
            {
                fail = false;
            }
            else
            {
                if ((rand != 0) && mrand() % 100 <= rand)
                    fail = false;
            }
        }
        if (fail)
        {
            if (mFrame != nullptr)
                mFrameTime = mFrame->delay + 1;
            else
                mFrameTime ++;
        }
    }
    return true;
}

References FrameType::ANIMATION, CAST_U32, FrameType::GOTO, FrameType::JUMP, FrameType::LABEL, mrand(), FrameType::PAUSE, and restrict.

updateNumber()

bool AnimatedSprite::updateNumber ( const unsigned  num )

virtual

Implements Sprite.

Definition at line 456 of file animatedsprite.cpp.

{
    if (mSprite == nullptr)
        return false;
 
    if (mNumber1 != num)
    {
        mNumber1 = num;
        mNumber = mSprite->findNumber(num);
        if (mNumber == 0U)
        {
            mNumber = 100;
            return false;
        }
        return true;
    }
    return false;
}

Field Documentation

mAction

const Action* AnimatedSprite::mAction

private

The currently active animation.

Definition at line 174 of file animatedsprite.h.

mAnimation

const Animation* AnimatedSprite::mAnimation

private

The currently active frame.

Definition at line 176 of file animatedsprite.h.

Referenced by getFrameCount(), and reset().

mDelayLoad

AnimationDelayLoad* AnimatedSprite::mDelayLoad

private

Definition at line 181 of file animatedsprite.h.

Referenced by clearDelayLoad(), and ~AnimatedSprite().

mDirection

SpriteDirection::Type AnimatedSprite::mDirection

private

The sprite direction.

Definition at line 165 of file animatedsprite.h.

mEnableCache

bool AnimatedSprite::mEnableCache = false

staticprivate

Definition at line 183 of file animatedsprite.h.

Referenced by delayedLoad(), and setEnableCache().

mFrame

const Frame* AnimatedSprite::mFrame

private

Definition at line 178 of file animatedsprite.h.

Referenced by getHash(), getHeight(), getImage(), getWidth(), and reset().

mFrameIndex

unsigned int AnimatedSprite::mFrameIndex

private

The index of the current frame.

Definition at line 168 of file animatedsprite.h.

Referenced by getCurrentFrame(), and reset().

mFrameTime

unsigned int AnimatedSprite::mFrameTime

private

The time since start of frame. The sprite definition.

Definition at line 169 of file animatedsprite.h.

Referenced by reset().

mLastTime

int AnimatedSprite::mLastTime

private

The last time update was called.

Definition at line 166 of file animatedsprite.h.

Referenced by reset(), and setLastTime().

mNumber

unsigned AnimatedSprite::mNumber

private

Definition at line 179 of file animatedsprite.h.

mNumber1

unsigned AnimatedSprite::mNumber1

private

Definition at line 180 of file animatedsprite.h.

mSprite

SpriteDef* AnimatedSprite::mSprite

private

The currently active action.

Definition at line 172 of file animatedsprite.h.

Referenced by AnimatedSprite(), getIdPath(), setSprite(), and ~AnimatedSprite().

mTerminated

bool AnimatedSprite::mTerminated

private

Definition at line 182 of file animatedsprite.h.

Referenced by isTerminated().

---

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

• src/resources/sprite/animatedsprite.h (986a3bf)
• src/resources/sprite/animatedsprite.cpp (986a3bf)