particleemitter.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2006-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef PARTICLE_PARTICLEEMITTER_H
#define PARTICLE_PARTICLEEMITTER_H
 
#include "particle/particleemitterprop.h"
 
#include "resources/animation/animation.h"
 
#include "utils/xml.h"
 
#include <list>
 
class Image;
class ImageSet;
class Map;
class Particle;
 
class ParticleEmitter final
{
    public:
        ParticleEmitter(XmlNodeConstPtrConst emitterNode,
                        Particle *const target,
                        Map *const map,
                        const int rotation,
                        const std::string& dyePalettes) A_NONNULL(3);
 
        ParticleEmitter(const ParticleEmitter &o);
 
        A_DEFAULT_COPY(ParticleEmitter)
 
        
        ParticleEmitter & operator=(const ParticleEmitter &o);
 
        ~ParticleEmitter();
 
        void createParticles(const int tick,
                             STD_VECTOR<Particle*> &newParticles);
 
        void setTarget(Particle *const target)
        { mParticleTarget = target; }
 
        void adjustSize(const int w, const int h);
 
    private:
        template <typename T> static ParticleEmitterProp<T>
            readParticleEmitterProp(XmlNodePtrConst propertyNode, T def);
 
        static ImageSet *getImageSet(XmlNodePtrConst node);
 
        ParticleEmitterProp<float> mParticlePosX, mParticlePosY, mParticlePosZ;
 
        ParticleEmitterProp<float> mParticleAngleHorizontal,
                                   mParticleAngleVertical;
 
        ParticleEmitterProp<float> mParticlePower;
 
        /*
         * Vector changing of particles:
         */
        ParticleEmitterProp<float> mParticleGravity;
        ParticleEmitterProp<int> mParticleRandomness;
        ParticleEmitterProp<float> mParticleBounce;
 
        /*
         * Properties of targeting particles:
         */
        Particle *mParticleTarget;
        ParticleEmitterProp<float> mParticleAcceleration;
        ParticleEmitterProp<float> mParticleDieDistance;
        ParticleEmitterProp<float> mParticleMomentum;
 
        /*
         * Behavior over time of the particles:
         */
        ParticleEmitterProp<int> mParticleLifetime;
        ParticleEmitterProp<int> mParticleFadeOut;
        ParticleEmitterProp<int> mParticleFadeIn;
 
        // Map the particles are spawned on
        Map *mMap;
 
        // Number of particles spawned per update
        ParticleEmitterProp<int> mOutput;
 
        // Pause in frames between two spawns
        ParticleEmitterProp<int> mOutputPause;
 
        /*
         * Graphical representation of the particles
         */
        // Particle image, if used
        Image *mParticleImage;
 
        // Filename of particle animation file
        Animation mParticleAnimation;
 
        // Filename of particle rotation file
        Animation mParticleRotation;
 
        // Opacity of the graphical representation of the particles
        ParticleEmitterProp<float> mParticleAlpha;
 
        /*
         * Death effect of the particles
         */
        std::string mDeathEffect;
 
        // List of emitters the spawned particles are equipped with
        std::list<ParticleEmitter> mParticleChildEmitters;
 
        STD_VECTOR<ImageSet*> mTempSets;
 
        int mOutputPauseLeft;
 
        signed char mDeathEffectConditions;
 
        bool mParticleFollow;
};
#endif  // PARTICLE_PARTICLEEMITTER_H