Lua_api.txt: Improve and complete ABM documentation

[minetest.git] / src / particles.h

diff --git a/src/particles.h b/src/particles.h
index 327dcbc9e18dab5825694e2ecddab92401481cdf..72e48911ac27b6d7e29bf4405e9565796bc669e0 100644 (file)
--- a/src/particles.h
+++ b/src/particles.h
@@ -17,38 +17,45 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef PARTICLES_HEADER
-#define PARTICLES_HEADER
-
-#define DIGGING_PARTICLES_AMOUNT 10
+#pragma once
 
 #include <iostream>
 #include "irrlichttypes_extrabloated.h"
-#include "tile.h"
+#include "client/tile.h"
 #include "localplayer.h"
-#include "environment.h"
+#include "tileanimation.h"
+
+struct ClientEvent;
+class ParticleManager;
+class ClientEnvironment;
+struct MapNode;
+struct ContentFeatures;
 
 class Particle : public scene::ISceneNode
 {
        public:
        Particle(
                IGameDef* gamedef,
-               scene::ISceneManager* mgr,
                LocalPlayer *player,
-               ClientEnvironment &env,
+               ClientEnvironment *env,
                v3f pos,
                v3f velocity,
                v3f acceleration,
                float expirationtime,
                float size,
                bool collisiondetection,
+               bool collision_removal,
+               bool vertical,
                video::ITexture *texture,
                v2f texpos,
-               v2f texsize
+               v2f texsize,
+               const struct TileAnimationParams &anim,
+               u8 glow,
+               video::SColor color = video::SColor(0xFFFFFFFF)
        );
-       ~Particle();
+       ~Particle() = default;
 
-       virtual const core::aabbox3d<f32>& getBoundingBox() const
+       virtual const aabb3f &getBoundingBox() const
        {
                return m_box;
        }
@@ -66,22 +73,23 @@ class Particle : public scene::ISceneNode
        virtual void OnRegisterSceneNode();
        virtual void render();
 
-       void step(float dtime, ClientEnvironment &env);
+       void step(float dtime);
 
        bool get_expired ()
        { return m_expiration < m_time; }
 
 private:
-       void updateLight(ClientEnvironment &env);
+       void updateLight();
        void updateVertices();
 
        video::S3DVertex m_vertices[4];
-       float m_time;
+       float m_time = 0.0f;
        float m_expiration;
 
+       ClientEnvironment *m_env;
        IGameDef *m_gamedef;
-       core::aabbox3d<f32> m_box;
-       core::aabbox3d<f32> m_collisionbox;
+       aabb3f m_box;
+       aabb3f m_collisionbox;
        video::SMaterial m_material;
        v2f m_texpos;
        v2f m_texsize;
@@ -90,15 +98,24 @@ class Particle : public scene::ISceneNode
        v3f m_acceleration;
        LocalPlayer *m_player;
        float m_size;
-       u8 m_light;
+       //! Color without lighting
+       video::SColor m_base_color;
+       //! Final rendered color
+       video::SColor m_color;
        bool m_collisiondetection;
+       bool m_collision_removal;
+       bool m_vertical;
+       v3s16 m_camera_offset;
+       struct TileAnimationParams m_animation;
+       float m_animation_time = 0.0f;
+       int m_animation_frame = 0;
+       u8 m_glow;
 };
 
 class ParticleSpawner
 {
-       public:
+public:
        ParticleSpawner(IGameDef* gamedef,
-               scene::ISceneManager *smgr,
                LocalPlayer *player,
                u16 amount,
                float time,
@@ -108,20 +125,29 @@ class ParticleSpawner
                float minexptime, float maxexptime,
                float minsize, float maxsize,
                bool collisiondetection,
+               bool collision_removal,
+               u16 attached_id,
+               bool vertical,
                video::ITexture *texture,
-               u32 id);
+               u32 id,
+               const struct TileAnimationParams &anim, u8 glow,
+               ParticleManager* p_manager);
 
-       ~ParticleSpawner();
+       ~ParticleSpawner() = default;
 
-       void step(float dtime, ClientEnvironment &env);
+       void step(float dtime, ClientEnvironment *env);
 
        bool get_expired ()
        { return (m_amount <= 0) && m_spawntime != 0; }
 
-       private:
+private:
+       void spawnParticle(ClientEnvironment *env, float radius,
+                       bool is_attached, const v3f &attached_pos,
+                       float attached_yaw);
+
+       ParticleManager *m_particlemanager;
        float m_time;
        IGameDef *m_gamedef;
-       scene::ISceneManager *m_smgr;
        LocalPlayer *m_player;
        u16 m_amount;
        float m_spawntime;
@@ -138,24 +164,48 @@ class ParticleSpawner
        video::ITexture *m_texture;
        std::vector<float> m_spawntimes;
        bool m_collisiondetection;
+       bool m_collision_removal;
+       bool m_vertical;
+       u16 m_attached_id;
+       struct TileAnimationParams m_animation;
+       u8 m_glow;
 };
 
-void allparticles_step (float dtime, ClientEnvironment &env);
-void allparticlespawners_step (float dtime, ClientEnvironment &env);
+/**
+ * Class doing particle as well as their spawners handling
+ */
+class ParticleManager
+{
+friend class ParticleSpawner;
+public:
+       ParticleManager(ClientEnvironment* env);
+       ~ParticleManager();
+
+       void step (float dtime);
+
+       void handleParticleEvent(ClientEvent *event, Client *client,
+                       LocalPlayer *player);
 
-void delete_particlespawner (u32 id);
-void clear_particles ();
+       void addDiggingParticles(IGameDef *gamedef, LocalPlayer *player, v3s16 pos,
+               const MapNode &n, const ContentFeatures &f);
 
-void addDiggingParticles(IGameDef* gamedef, scene::ISceneManager* smgr,
-       LocalPlayer *player, ClientEnvironment &env, v3s16 pos,
-       const TileSpec tiles[]);
+       void addNodeParticle(IGameDef *gamedef, LocalPlayer *player, v3s16 pos,
+               const MapNode &n, const ContentFeatures &f);
 
-void addPunchingParticles(IGameDef* gamedef, scene::ISceneManager* smgr,
-       LocalPlayer *player, ClientEnvironment &env, v3s16 pos,
-       const TileSpec tiles[]);
+protected:
+       void addParticle(Particle* toadd);
+
+private:
 
-void addNodeParticle(IGameDef* gamedef, scene::ISceneManager* smgr,
-       LocalPlayer *player, ClientEnvironment &env, v3s16 pos,
-       const TileSpec tiles[]);
+       void stepParticles (float dtime);
+       void stepSpawners (float dtime);
 
-#endif
+       void clearAll ();
+
+       std::vector<Particle*> m_particles;
+       std::map<u32, ParticleSpawner*> m_particle_spawners;
+
+       ClientEnvironment* m_env;
+       std::mutex m_particle_list_lock;
+       std::mutex m_spawner_list_lock;
+};