ImageSprite Class Reference

#include <imagesprite.h>

Inheritance diagram for ImageSprite:

Public Member Functions
	ImageSprite (Image *const image)
	~ImageSprite ()
bool	reset ()
bool	play (const std::string &action)
bool	update (const int time)
void	draw (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
unsigned int	getCurrentFrame () const
unsigned int	getFrameCount () const
bool	updateNumber (const unsigned num)
Public Member Functions inherited from Sprite
virtual	~Sprite ()
virtual void	setAlpha (float alpha)
virtual float	getAlpha () const
virtual const void *	getHash () const
virtual const void *	getHash2 () const

Private Attributes
Image *	mImage

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

Detailed Description

Definition at line 32 of file imagesprite.h.

Constructor & Destructor Documentation

ImageSprite()

ImageSprite::ImageSprite ( Image *const  image )

explicit

Definition at line 29 of file imagesprite.cpp.

                                           :
    mImage(image)
{
    if (mImage != nullptr)
    {
        mAlpha = mImage->mAlpha;
        mImage->incRef();
    }
    else
    {
        mAlpha = 1;
    }
}

References Sprite::mAlpha, and mImage.

~ImageSprite()

ImageSprite::~ImageSprite

(

)

Definition at line 43 of file imagesprite.cpp.

{
    if (mImage != nullptr)
    {
        mImage->decRef();
        mImage = nullptr;
    }
}

References mImage.

Member Function Documentation

draw()

void ImageSprite::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 52 of file imagesprite.cpp.

{
    FUNC_BLOCK("ImageSprite::draw", 1)
    if (mImage == nullptr)
        return;
 
    mImage->setAlpha(mAlpha);
    graphics->drawImage(mImage, posX, posY);
}

References Graphics::drawImage(), FUNC_BLOCK, Sprite::mAlpha, and mImage.

getCurrentFrame()

unsigned int ImageSprite::getCurrentFrame ( ) const

inlinevirtual

Returns the current frame number for the sprite.

Implements Sprite.

Definition at line 70 of file imagesprite.h.

        { return 0; }

getFrameCount()

unsigned int ImageSprite::getFrameCount ( ) const

inlinevirtual

Returns the frame count for the sprite.

Implements Sprite.

Definition at line 73 of file imagesprite.h.

        { return 1; }

getHeight()

int ImageSprite::getHeight ( ) const

inlinevirtual

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

Implements Sprite.

Definition at line 57 of file imagesprite.h.

        { return mImage != nullptr ? mImage->getHeight() : 0; }

References mImage.

getImage()

const Image* ImageSprite::getImage ( ) const

inlinevirtual

Returns a reference to the current image being drawn.

Implements Sprite.

Definition at line 60 of file imagesprite.h.

        { return mImage; }

References mImage.

getNumberOfLayers()

int ImageSprite::getNumberOfLayers ( ) const

inline

Definition at line 67 of file imagesprite.h.

        { return 1; }

getWidth()

int ImageSprite::getWidth ( ) const

inlinevirtual

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

Implements Sprite.

Definition at line 54 of file imagesprite.h.

        { return mImage != nullptr ? mImage->getWidth() : 0; }

References mImage.

play()

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

inlinevirtual

Plays an action using the current direction.

Returns

true if the sprite changed, false otherwise

Implements Sprite.

Definition at line 44 of file imagesprite.h.

        { return false; }

reset()

bool ImageSprite::reset ( )

inlinevirtual

Resets the sprite.

Returns

true if the sprite changed, false otherwise

Implements Sprite.

Definition at line 41 of file imagesprite.h.

        { return false; }

setSpriteDirection()

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

inlinevirtual

Sets the direction.

Returns

true if the sprite changed, false otherwise

Implements Sprite.

Definition at line 63 of file imagesprite.h.

        { return false; }

update()

bool ImageSprite::update ( const int  time )

inlinevirtual

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 47 of file imagesprite.h.

        { return false; }

updateNumber()

bool ImageSprite::updateNumber ( const unsigned  num )

inlinevirtual

Implements Sprite.

Definition at line 76 of file imagesprite.h.

        { return false; }

Field Documentation

mImage

Image* ImageSprite::mImage

private

Definition at line 80 of file imagesprite.h.

Referenced by draw(), getHeight(), getImage(), getWidth(), ImageSprite(), and ~ImageSprite().

---

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

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