/* * The ManaPlus Client * Copyright (C) 2006-2009 The Mana World Development Team * Copyright (C) 2009-2010 The Mana Developers * Copyright (C) 2011-2013 The ManaPlus Developers * * 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_H #define PARTICLE_H #include "actor.h" #include "localconsts.h" #include <list> #include <string> class Map; class Particle; class ParticleEmitter; class SDLFont; namespace gcn { class Color; class Font; } typedef std::list<Particle *> Particles; typedef Particles::iterator ParticleIterator; typedef Particles::const_iterator ParticleConstIterator; typedef std::list<ParticleEmitter *> Emitters; typedef Emitters::iterator EmitterIterator; typedef Emitters::const_iterator EmitterConstIterator; /** * A particle spawned by a ParticleEmitter. */ class Particle : public Actor { public: enum AliveStatus { ALIVE = 0, DEAD_TIMEOUT = 1, DEAD_FLOOR = 2, DEAD_SKY = 4, DEAD_IMPACT = 8, DEAD_OTHER = 16, DEAD_LONG_AGO = 128 }; static const float PARTICLE_SKY; /**< Maximum Z position of particles */ static int fastPhysics; /**< Mode of squareroot calculation */ static int particleCount; /**< Current number of particles */ static int maxCount; /**< Maximum number of particles */ static int emitterSkip; /**< Duration of pause between two emitter updates in ticks */ static bool enabled; /**< true when non-crucial particle effects are disabled */ /** * Constructor. * * @param map the map this particle will add itself to, may be nullptr */ explicit Particle(Map *const map); A_DELETE_COPY(Particle) /** * Destructor. */ ~Particle(); /** * Deletes all child particles and emitters. */ void clear(); /** * Gives a particle the properties of an engine root particle and loads * the particle-related config settings. */ void setupEngine(); /** * Updates particle position, returns false when the particle should * be deleted. */ virtual bool update(); /** * Draws the particle image. */ virtual bool draw(Graphics *const graphics, const int offsetX, const int offsetY) const override; /** * Necessary for sorting with the other sprites. */ virtual int getPixelY() const override A_WARN_UNUSED { return static_cast<int>(mPos.y) - 16; } /** * Necessary for sorting with the other sprites for sorting only. */ virtual int getSortPixelY() const override A_WARN_UNUSED { return static_cast<int>(mPos.y) - 16; } /** * Creates a blank particle as a child of the current particle * Useful for creating target particles */ Particle *createChild(); /** * Creates a child particle that hosts some emitters described in the * particleEffectFile. */ Particle *addEffect(const std::string &particleEffectFile, const int pixelX, const int pixelY, const int rotation = 0); /** * Creates a standalone text particle. */ Particle *addTextSplashEffect(const std::string &text, const int x, const int y, const gcn::Color *const color, gcn::Font *const font, const bool outline = false); /** * Creates a standalone text particle. */ Particle *addTextRiseFadeOutEffect(const std::string &text, const int x, const int y, const gcn::Color *const color, gcn::Font *const font, const bool outline = false); /** * Adds an emitter to the particle. */ void addEmitter (ParticleEmitter *const emitter) { mChildEmitters.push_back(emitter); } /** * Sets the position in 3 dimensional space in pixels relative to map. */ void moveTo(const Vector &pos) { moveBy (pos - mPos); } /** * Sets the position in 2 dimensional space in pixels relative to map. */ void moveTo(const float x, const float y); /** * Changes the particle position relative */ void moveBy (const Vector &change); /** * Sets the time in game ticks until the particle is destroyed. */ void setLifetime(const int lifetime) { mLifetimeLeft = lifetime; mLifetimePast = 0; } /** * Sets the age of the pixel in game ticks where the particle has * faded in completely. */ void setFadeOut(const int fadeOut) { mFadeOut = fadeOut; } /** * Sets the remaining particle lifetime where the particle starts to * fade out. */ void setFadeIn(const int fadeIn) { mFadeIn = fadeIn; } /** * Sets the current velocity in 3 dimensional space. */ void setVelocity(const float x, const float y, const float z) { mVelocity.x = x; mVelocity.y = y; mVelocity.z = z; } /** * Sets the downward acceleration. */ void setGravity(const float gravity) { mGravity = gravity; } /** * Sets the ammount of random vector changes */ void setRandomness(const int r) { mRandomness = r; } /** * Sets the ammount of velocity particles retain after * hitting the ground. */ void setBounce(const float bouncieness) { mBounce = bouncieness; } /** * Sets the flag if the particle is supposed to be moved by its parent */ void setFollow(const bool follow) { mFollow = follow; } /** * Gets the flag if the particle is supposed to be moved by its parent */ bool doesFollow() const A_WARN_UNUSED { return mFollow; } /** * Makes the particle move toward another particle with a * given acceleration and momentum */ void setDestination(Particle *const target, const float accel, const float moment) { mTarget = target; mAcceleration = accel; mMomentum = moment; } /** * Sets the distance in pixel the particle can come near the target * particle before it is destroyed. Does only make sense after a target * particle has been set using setDestination. */ void setDieDistance(const float dist) { mInvDieDistance = 1.0f / dist; } /** * Changes the size of the emitters so that the effect fills a * rectangle of this size */ void adjustEmitterSize(const int w, const int h); void setAllowSizeAdjust(const bool adjust) { mAllowSizeAdjust = adjust; } bool isAlive() const A_WARN_UNUSED { return mAlive == ALIVE; } /** * Determines whether the particle and its children are all dead */ bool isExtinct() const A_WARN_UNUSED { return !isAlive() && mChildParticles.empty(); } /** * Manually marks the particle for deletion. */ void kill() { mAlive = DEAD_OTHER; mAutoDelete = true; } /** * After calling this function the particle will only request * deletion when kill() is called */ void disableAutoDelete() { mAutoDelete = false; } /** We consider particles (at least for now) to be one layer-sprites */ virtual int getNumberOfLayers() const { return 1; } virtual float getAlpha() const { return 1.0f; } virtual void setAlpha(const float alpha A_UNUSED) override { } virtual void setDeathEffect(const std::string &effectFile, const signed char conditions) { mDeathEffect = effectFile; mDeathEffectConditions = conditions; } protected: float mAlpha; /**< Opacity of the graphical representation of the particle */ int mLifetimeLeft; /**< Lifetime left in game ticks*/ int mLifetimePast; /**< Age of the particle in game ticks*/ int mFadeOut; /**< Lifetime in game ticks left where fading out begins*/ int mFadeIn; /**< Age in game ticks where fading in is finished*/ Vector mVelocity; /**< Speed in pixels per game-tick. */ AliveStatus mAlive; /**< Is the particle supposed to be drawn and updated?*/ private: // generic properties bool mAutoDelete; /**< May the particle request its deletion by the parent particle? */ Emitters mChildEmitters; /**< List of child emitters. */ Particles mChildParticles; /**< List of particles controlled by this particle */ bool mAllowSizeAdjust; /**< Can the effect size be adjusted by the object props in the map file? */ std::string mDeathEffect; /**< Particle effect file to be spawned when the particle dies */ signed char mDeathEffectConditions; /**< Bitfield of death conditions which trigger spawning of the death particle */ // dynamic particle float mGravity; /**< Downward acceleration in pixels per game-tick. */ int mRandomness; /**< Ammount of random vector change */ float mBounce; /**< How much the particle bounces off when hitting the ground */ bool mFollow; /**< is this particle moved when its parent particle moves? */ // follow-point particles Particle *mTarget; /**< The particle that attracts this particle*/ float mAcceleration; /**< Acceleration towards the target particle in pixels per game-tick*/ float mInvDieDistance; /**< Distance in pixels from the target particle that causes the destruction of the particle*/ float mMomentum; /**< How much speed the particle retains after each game tick*/ }; extern Particle *particleEngine; #endif