ParticleEngine Class Reference

#include <particleengine.h>

Public Member Functions
	ParticleEngine ()
	~ParticleEngine ()
void	clear ()
bool	update ()
Particle *	createChild ()
Particle *	addEffect (const std::string &particleEffectFile, const int pixelX, const int pixelY, const int rotation)
Particle *	addTextSplashEffect (const std::string &text, const int x, const int y, const Color *const color, Font *const font, const bool outline)
Particle *	addTextRiseFadeOutEffect (const std::string &text, const int x, const int y, const Color *const color, Font *const font, const bool outline)
void	setMap (Map *const map)

Static Public Member Functions
static void	setupEngine ()

Static Public Attributes
static const float	PARTICLE_SKY = 800.0F
static ParticlePhysicsT	fastPhysics = ParticlePhysics::Best
static int	particleCount = 0
static int	maxCount = 0
static int	emitterSkip = 1
static bool	enabled = true

Private Attributes
Particles	mChildParticles
Particles	mChildMoveParticles
Map *	mMap

Detailed Description

Definition at line 47 of file particleengine.h.

Constructor & Destructor Documentation

ParticleEngine()

ParticleEngine::ParticleEngine

(

)

Definition at line 53 of file particleengine.cpp.

                               :
    mChildParticles(),
    mChildMoveParticles(),
    mMap(nullptr)
{
    ParticleEngine::particleCount++;
}

References particleCount.

~ParticleEngine()

ParticleEngine::~ParticleEngine

(

)

Destructor.

Definition at line 61 of file particleengine.cpp.

{
    // Delete child emitters and child particles
    clear();
    ParticleEngine::particleCount--;
}

References clear(), and particleCount.

Member Function Documentation

addEffect()

Particle * ParticleEngine::addEffect	(	const std::string &	particleEffectFile,
		const int	pixelX,
		const int	pixelY,
		const int	rotation
	)

Creates a child particle that hosts some emitters described in the particleEffectFile.

Definition at line 130 of file particleengine.cpp.

{
    Particle *newParticle = nullptr;
 
    const size_t pos = particleEffectFile.find('|');
    const std::string dyePalettes = (pos != std::string::npos)
        ? particleEffectFile.substr(pos + 1) : "";
    XML::Document *doc = Loader::getXml(
        particleEffectFile.substr(0, pos),
        UseVirtFs_true,
        SkipError_false);
    if (doc == nullptr)
        return nullptr;
 
    XmlNodeConstPtrConst rootNode = doc->rootNode();
 
    if ((rootNode == nullptr) || !xmlNameEqual(rootNode, "effect"))
    {
        logger->log("Error loading particle: %s", particleEffectFile.c_str());
        doc->decRef();
        return nullptr;
    }
 
    // Parse particles
    for_each_xml_child_node(effectChildNode, rootNode)
    {
        // We're only interested in particles
        if (!xmlNameEqual(effectChildNode, "particle"))
            continue;
 
        // Determine the exact particle type
        XmlNodePtr node;
 
        // Animation
        if ((node = XML::findFirstChildByName(effectChildNode, "animation")) !=
            nullptr)
        {
            newParticle = new AnimationParticle(node, dyePalettes);
            newParticle->setMap(mMap);
        }
        // Rotational
        else if ((node = XML::findFirstChildByName(
                 effectChildNode, "rotation")) != nullptr)
        {
            newParticle = new RotationalParticle(node, dyePalettes);
            newParticle->setMap(mMap);
        }
        // Image
        else if ((node = XML::findFirstChildByName(effectChildNode,
                 "image")) != nullptr)
        {
            std::string imageSrc;
            if (XmlHaveChildContent(node))
                imageSrc = XmlChildContent(node);
            if (!imageSrc.empty() && !dyePalettes.empty())
                Dye::instantiate(imageSrc, dyePalettes);
            Image *const img = Loader::getImage(imageSrc);
 
            newParticle = new ImageParticle(img);
            newParticle->setMap(mMap);
        }
        // Other
        else
        {
            newParticle = new Particle;
            newParticle->setMap(mMap);
        }
 
        // Read and set the basic properties of the particle
        const float offsetX = XML::getFloatProperty(
            effectChildNode, "position-x", 0);
        const float offsetY = XML::getFloatProperty(
            effectChildNode, "position-y", 0);
        const float offsetZ = XML::getFloatProperty(
            effectChildNode, "position-z", 0);
        const Vector position(static_cast<float>(pixelX) + offsetX,
            static_cast<float>(pixelY) + offsetY,
            offsetZ);
        newParticle->moveTo(position);
 
        const int lifetime = XML::getProperty(effectChildNode, "lifetime", -1);
        newParticle->setLifetime(lifetime);
        const bool resizeable = "false" != XML::getProperty(effectChildNode,
            "size-adjustable", "false");
 
        newParticle->setAllowSizeAdjust(resizeable);
 
        // Look for additional emitters for this particle
        for_each_xml_child_node(emitterNode, effectChildNode)
        {
            if (xmlNameEqual(emitterNode, "emitter"))
            {
                ParticleEmitter *restrict const newEmitter =
                    new ParticleEmitter(
                    emitterNode,
                    newParticle,
                    mMap,
                    rotation,
                    dyePalettes);
                newParticle->addEmitter(newEmitter);
            }
            else if (xmlNameEqual(emitterNode, "deatheffect"))
            {
                std::string deathEffect;
                if ((node != nullptr) && XmlHaveChildContent(node))
                    deathEffect = XmlChildContent(emitterNode);
 
                char deathEffectConditions = 0x00;
                if (XML::getBoolProperty(emitterNode, "on-floor", true))
                {
                    deathEffectConditions += CAST_S8(
                        AliveStatus::DEAD_FLOOR);
                }
                if (XML::getBoolProperty(emitterNode, "on-sky", true))
                {
                    deathEffectConditions += CAST_S8(
                        AliveStatus::DEAD_SKY);
                }
                if (XML::getBoolProperty(emitterNode, "on-other", false))
                {
                    deathEffectConditions += CAST_S8(
                        AliveStatus::DEAD_OTHER);
                }
                if (XML::getBoolProperty(emitterNode, "on-impact", true))
                {
                    deathEffectConditions += CAST_S8(
                        AliveStatus::DEAD_IMPACT);
                }
                if (XML::getBoolProperty(emitterNode, "on-timeout", true))
                {
                    deathEffectConditions += CAST_S8(
                        AliveStatus::DEAD_TIMEOUT);
                }
                newParticle->setDeathEffect(
                    deathEffect, deathEffectConditions);
            }
        }
 
        mChildParticles.push_back(newParticle);
    }
 
    doc->decRef();
    return newParticle;
}

References Particle::addEmitter(), CAST_S8, AliveStatus::DEAD_FLOOR, AliveStatus::DEAD_IMPACT, AliveStatus::DEAD_OTHER, AliveStatus::DEAD_SKY, AliveStatus::DEAD_TIMEOUT, Resource::decRef(), XML::findFirstChildByName(), for_each_xml_child_node, XML::getBoolProperty(), XML::getFloatProperty(), Loader::getImage(), XML::getProperty(), Loader::getXml(), Dye::instantiate(), Logger::log(), logger, Ea::GameRecv::mMap, Particle::moveTo(), restrict, XML::Document::rootNode(), Particle::setAllowSizeAdjust(), Particle::setDeathEffect(), Particle::setLifetime(), Actor::setMap(), SkipError_false, and UseVirtFs_true.

Referenced by Being::addItemParticles(), Being::addItemParticlesCards(), StatusEffect::getParticle(), StatusEffect::getStartParticle(), Map::initializeParticleEffects(), Being::recreateItemParticles(), LocalPlayer::setTestParticle(), ActorSprite::setupSpriteDisplay(), EffectManager::trigger(), EffectManager::triggerReturn(), and Particle::updateSelf().

addTextRiseFadeOutEffect()

Particle * ParticleEngine::addTextRiseFadeOutEffect	(	const std::string &	text,
		const int	x,
		const int	y,
		const Color *const	color,
		Font *const	font,
		const bool	outline
	)

Creates a standalone text particle.

Definition at line 310 of file particleengine.cpp.

{
    Particle *const newParticle = new TextParticle(
        text,
        color,
        font,
        outline);
    newParticle->setMap(mMap);
    newParticle->moveTo(static_cast<float>(x),
        static_cast<float>(y));
    newParticle->setVelocity(0.0F, 0.0F, 0.5F);
    newParticle->setGravity(0.0015F);
    newParticle->setLifetime(300);
    newParticle->setFadeOut(100);
    newParticle->setFadeIn(0);
 
    mChildParticles.push_back(newParticle);
 
    return newParticle;
}

References Ea::GameRecv::mMap, Particle::moveTo(), Particle::setFadeIn(), Particle::setFadeOut(), Particle::setGravity(), Particle::setLifetime(), Actor::setMap(), Particle::setVelocity(), x, and y.

Referenced by LocalPlayer::logic().

addTextSplashEffect()

Particle * ParticleEngine::addTextSplashEffect	(	const std::string &	text,
		const int	x,
		const int	y,
		const Color *const	color,
		Font *const	font,
		const bool	outline
	)

Creates a standalone text particle.

Definition at line 279 of file particleengine.cpp.

{
    Particle *const newParticle = new TextParticle(
        text,
        color,
        font,
        outline);
    newParticle->setMap(mMap);
    newParticle->moveTo(static_cast<float>(x),
        static_cast<float>(y));
    newParticle->setVelocity(
        static_cast<float>((rand() % 100) - 50) / 200.0F,       // X
        static_cast<float>((rand() % 100) - 50) / 200.0F,       // Y
        (static_cast<float>((rand() % 100)) / 200.0F) + 4.0F);  // Z
 
    newParticle->setGravity(0.1F);
    newParticle->setBounce(0.5F);
    newParticle->setLifetime(200);
    newParticle->setFadeOut(100);
 
    mChildParticles.push_back(newParticle);
 
    return newParticle;
}

References Ea::GameRecv::mMap, Particle::moveTo(), Particle::setBounce(), Particle::setFadeOut(), Particle::setGravity(), Particle::setLifetime(), Actor::setMap(), Particle::setVelocity(), x, and y.

Referenced by Being::takeDamage().

clear()

void ParticleEngine::clear

(

)

Deletes all child particles and emitters.

Definition at line 339 of file particleengine.cpp.

{
    delete_all(mChildParticles);
    mChildParticles.clear();
    mChildMoveParticles.clear();
}

References delete_all(), mChildMoveParticles, and mChildParticles.

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

createChild()

Particle * ParticleEngine::createChild

(

)

Creates a blank particle as a child of the current particle Useful for creating target particles

Definition at line 122 of file particleengine.cpp.

{
    Particle *const newParticle = new Particle;
    newParticle->setMap(mMap);
    mChildParticles.push_back(newParticle);
    return newParticle;
}

References mChildParticles, mMap, and Actor::setMap().

Referenced by Being::fireMissile().

setMap()

void ParticleEngine::setMap ( Map *const  map )

inline

Definition at line 122 of file particleengine.h.

        { mMap = map; }

References mMap.

Referenced by Game::changeMap(), and initEngines().

setupEngine()

void ParticleEngine::setupEngine ( )

static

Gives a particle the properties of an engine root particle and loads the particle-related config settings.

Definition at line 68 of file particleengine.cpp.

{
    ParticleEngine::maxCount = config.getIntValue("particleMaxCount");
    ParticleEngine::fastPhysics = fromInt(config.getIntValue(
        "particleFastPhysics"),
        ParticlePhysicsT);
    ParticleEngine::emitterSkip =
        config.getIntValue("particleEmitterSkip") + 1;
    if (ParticleEngine::emitterSkip == 0)
        ParticleEngine::emitterSkip = 1;
    ParticleEngine::enabled = config.getBoolValue("particleeffects");
    logger->log1("Particle engine set up");
}

References config, emitterSkip, enabled, fastPhysics, fromInt, Configuration::getBoolValue(), Configuration::getIntValue(), Logger::log1(), logger, and maxCount.

Referenced by initEngines().

update()

bool ParticleEngine::update

(

)

Updates particle position, returns false when the particle should be deleted.

Definition at line 82 of file particleengine.cpp.

{
    if (mChildParticles.empty() || (mMap == nullptr))
        return true;
 
    // Update child particles
 
    const int cameraX = viewport->getCameraX();
    const int cameraY = viewport->getCameraY();
    const float x1 = static_cast<float>(cameraX - 3000);
    const float y1 = static_cast<float>(cameraY - 2000);
    const float x2 = static_cast<float>(cameraX + 3000);
    const float y2 = static_cast<float>(cameraY + 2000);
 
    for (ParticleIterator p = mChildParticles.begin(),
         fp2 = mChildParticles.end(); p != fp2; )
    {
        Particle *restrict const particle = *p;
        const float posX = particle->mPos.x;
        const float posY = particle->mPos.y;
        if (posX < x1 || posX > x2 || posY < y1 || posY > y2)
        {
            ++p;
            continue;
        }
        // update particle
        if (particle->update())
        {
            ++p;
        }
        else
        {
            mChildMoveParticles.remove(*p);
            delete particle;
            p = mChildParticles.erase(p);
        }
    }
    return true;
}

References Viewport::getCameraX(), Viewport::getCameraY(), mChildMoveParticles, mChildParticles, mMap, restrict, and viewport.

Referenced by Game::logic().

Field Documentation

emitterSkip

int ParticleEngine::emitterSkip = 1

static

Definition at line 54 of file particleengine.h.

Referenced by Game::adjustPerfomance(), Client::optionChanged(), Game::resetAdjustLevel(), setupEngine(), and Particle::updateSelf().

enabled

bool ParticleEngine::enabled = true

static

Definition at line 56 of file particleengine.h.

Referenced by Being::addItemParticles(), Being::addItemParticlesCards(), Being::addSpecialEffect(), EAthena::BeingRecv::processBeingSelfEffect(), TmwAthena::BeingRecv::processBeingSelfEffect(), EAthena::BeingRecv::processBeingSpecialEffect(), Being::setAction(), Being::setSpiritBalls(), setupEngine(), and ActorSprite::setupSpriteDisplay().

fastPhysics

ParticlePhysicsT ParticleEngine::fastPhysics = ParticlePhysics::Best

static

Definition at line 51 of file particleengine.h.

Referenced by setupEngine(), and Particle::updateSelf().

maxCount

int ParticleEngine::maxCount = 0

static

Definition at line 53 of file particleengine.h.

Referenced by ParticleEmitter::createParticles(), and setupEngine().

mChildMoveParticles

Particles ParticleEngine::mChildMoveParticles

private

Definition at line 128 of file particleengine.h.

Referenced by clear(), and update().

mChildParticles

Particles ParticleEngine::mChildParticles

private

Definition at line 127 of file particleengine.h.

Referenced by clear(), createChild(), and update().

mMap

Map* ParticleEngine::mMap

private

Definition at line 129 of file particleengine.h.

Referenced by createChild(), setMap(), and update().

PARTICLE_SKY

const float ParticleEngine::PARTICLE_SKY = 800.0F

static

Definition at line 50 of file particleengine.h.

Referenced by Particle::updateSelf().

particleCount

int ParticleEngine::particleCount = 0

static

Definition at line 52 of file particleengine.h.

Referenced by ParticleEmitter::createParticles(), MapDebugTab::logic(), Particle::Particle(), ParticleEngine(), Particle::~Particle(), and ~ParticleEngine().

---

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

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