TextParticle Class Reference

#include <textparticle.h>

Inheritance diagram for TextParticle:

Public Member Functions
	TextParticle (const std::string &text, const Color *const color, Font *const font, const bool outline)
void	draw (Graphics *const graphics, const int offsetX, const int offsetY) const
int	getPixelY () const
int	getSortPixelY () const
Public Member Functions inherited from Particle
	Particle ()
	~Particle ()
void	clear ()
bool	update ()
Particle *	addEffect (const std::string &particleEffectFile, const int pixelX, const int pixelY, const int rotation)
void	addEmitter (ParticleEmitter *const emitter)
void	moveTo (const Vector &pos)
void	moveTo (const float x, const float y)
void	moveBy (const Vector &change)
void	setLifetime (const int lifetime)
void	setFadeOut (const int fadeOut)
void	setFadeIn (const int fadeIn)
void	setVelocity (const float x, const float y, const float z)
void	setGravity (const float gravity)
void	setRandomness (const int r)
void	setBounce (const float bouncieness)
void	setFollow (const bool follow)
bool	doesFollow () const
void	setDestination (Particle *const target, const float accel, const float moment)
void	setDieDistance (const float dist)
void	adjustEmitterSize (const int w, const int h)
void	setAllowSizeAdjust (const bool adjust)
bool	isAlive () const
void	prepareToDie ()
bool	isExtinct () const
void	kill ()
void	disableAutoDelete ()
int	getNumberOfLayers () const
float	getAlpha () const
void	setAlpha (const float alpha)
virtual void	setDeathEffect (const std::string &effectFile, const signed char conditions)
void	setActor (const BeingId actor)
Public Member Functions inherited from Actor
virtual	~Actor ()
virtual int	getWidth () const
virtual int	getHeight () const
const Vector &	getPixelPositionF () const
virtual void	setPixelPositionF (const Vector &pos)
int	getPixelX () const
virtual int	getTileX () const
virtual int	getTileY () const
virtual void	setMap (Map *const map)
const Map *	getMap () const

Private Attributes
std::string	mText
Font *	mTextFont
const Color *	mColor
int	mTextWidth
bool	mOutline

Additional Inherited Members
Data Fields inherited from Actor
int	mPixelX
int	mPixelY
Protected Member Functions inherited from Particle
void	updateSelf ()
Protected Member Functions inherited from Actor
	Actor ()
Protected Attributes inherited from Particle
float	mAlpha
int	mLifetimeLeft
int	mLifetimePast
int	mFadeOut
int	mFadeIn
Vector	mVelocity
AliveStatusT	mAlive
ParticleTypeT	mType
SimpleAnimation *	mAnimation
Image *	mImage
BeingId	mActor
Protected Attributes inherited from Actor
Map *	mMap
Vector	mPos
int	mYDiff

Detailed Description

Definition at line 29 of file textparticle.h.

Constructor & Destructor Documentation

TextParticle()

TextParticle::TextParticle	(	const std::string &	text,
		const Color *const	color,
		Font *const	font,
		const bool	outline
	)

Constructor.

Definition at line 34 of file textparticle.cpp.

                                               :
    Particle(),
    mText(text),
    mTextFont(font),
    mColor(color),
    mTextWidth(mTextFont != nullptr ? mTextFont->getWidth(mText) / 2 : 1),
    mOutline(outline)
{
    mType = ParticleType::Text;
}

References Particle::mType, and ParticleType::Text.

Member Function Documentation

draw()

void TextParticle::draw ( Graphics *const  graphics, const int  offsetX, const int  offsetY  ) const

virtual

Draws the particle image.

Reimplemented from Particle.

Definition at line 48 of file textparticle.cpp.

{
    BLOCK_START("TextParticle::draw")
    if (!isAlive())
    {
        BLOCK_END("TextParticle::draw")
        return;
    }
 
    const int screenX = CAST_S32(mPos.x) + offsetX;
    const int screenY = CAST_S32(mPos.y) - CAST_S32(mPos.z)
        + offsetY;
 
    float alpha = mAlpha * 255.0F;
 
    if ((mFadeOut != 0) && mLifetimeLeft > -1 && mLifetimeLeft < mFadeOut)
    {
        alpha *= static_cast<float>(mLifetimeLeft)
                / static_cast<float>(mFadeOut);
    }
 
    if ((mFadeIn != 0) && mLifetimePast < mFadeIn)
    {
        alpha *= static_cast<float>(mLifetimePast)
                / static_cast<float>(mFadeIn);
    }
 
    Color color = *mColor;
    color.a = CAST_U32(alpha);
 
    graphics->setColor(color);
    if (mOutline)
    {
        const Color &restrict color2 = theme->getColor(ThemeColorId::OUTLINE,
            CAST_S32(alpha));
        mTextFont->drawString(graphics,
            color, color2,
            mText,
            screenX - mTextWidth, screenY);
    }
    else
    {
        mTextFont->drawString(graphics,
            color, color,
            mText, screenX - mTextWidth, screenY);
    }
    BLOCK_END("TextParticle::draw")
}

References Color::a, BLOCK_END, BLOCK_START, CAST_S32, CAST_U32, Theme::getColor(), anonymous_namespace{mrand.cpp}::mPos, restrict, and theme.

getPixelY()

int TextParticle::getPixelY ( ) const

inlinevirtual

Necessary for sorting with the other sprites.

Reimplemented from Particle.

Definition at line 51 of file textparticle.h.

        { return CAST_S32(mPos.y + mPos.z); }

References CAST_S32, Actor::mPos, Vector::y, and Vector::z.

getSortPixelY()

int TextParticle::getSortPixelY ( ) const

inlinevirtual

Necessary for sorting with the other sprites for sorting only.

Reimplemented from Particle.

Definition at line 55 of file textparticle.h.

        { return CAST_S32(mPos.y + mPos.z); }

References CAST_S32, Actor::mPos, Vector::y, and Vector::z.

Field Documentation

mColor

const Color* TextParticle::mColor

private

Definition at line 64 of file textparticle.h.

mOutline

bool TextParticle::mOutline

private

Definition at line 67 of file textparticle.h.

mText

std::string TextParticle::mText

private

< Text of the particle. Font used for drawing the text.

Definition at line 60 of file textparticle.h.

mTextFont

Font* TextParticle::mTextFont

private

Color used for drawing the text.

Definition at line 62 of file textparticle.h.

mTextWidth

int TextParticle::mTextWidth

private

Make the text better readable

Definition at line 65 of file textparticle.h.

---

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

• src/particle/textparticle.h (986a3bf)
• src/particle/textparticle.cpp (986a3bf)