src/client/particles.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include <iostream>
  23 #include "irrlichttypes_extrabloated.h"
  24 #include "client/tile.h"
  25 #include "localplayer.h"
  26 #include "tileanimation.h"
  27
  28 struct ClientEvent;
  29 class ParticleManager;
  30 class ClientEnvironment;
  31 struct MapNode;
  32 struct ContentFeatures;
  33
  34 class Particle : public scene::ISceneNode
  35 {
  36         public:
  37         Particle(
  38                 IGameDef* gamedef,
  39                 LocalPlayer *player,
  40                 ClientEnvironment *env,
  41                 v3f pos,
  42                 v3f velocity,
  43                 v3f acceleration,
  44                 float expirationtime,
  45                 float size,
  46                 bool collisiondetection,
  47                 bool collision_removal,
  48                 bool object_collision,
  49                 bool vertical,
  50                 video::ITexture *texture,
  51                 v2f texpos,
  52                 v2f texsize,
  53                 const struct TileAnimationParams &anim,
  54                 u8 glow,
  55                 video::SColor color = video::SColor(0xFFFFFFFF)
  56         );
  57         ~Particle() = default;
  58
  59         virtual const aabb3f &getBoundingBox() const
  60         {
  61                 return m_box;
  62         }
  63
  64         virtual u32 getMaterialCount() const
  65         {
  66                 return 1;
  67         }
  68
  69         virtual video::SMaterial& getMaterial(u32 i)
  70         {
  71                 return m_material;
  72         }
  73
  74         virtual void OnRegisterSceneNode();
  75         virtual void render();
  76
  77         void step(float dtime);
  78
  79         bool get_expired ()
  80         { return m_expiration < m_time; }
  81
  82 private:
  83         void updateLight();
  84         void updateVertices();
  85
  86         video::S3DVertex m_vertices[4];
  87         float m_time = 0.0f;
  88         float m_expiration;
  89
  90         ClientEnvironment *m_env;
  91         IGameDef *m_gamedef;
  92         aabb3f m_box;
  93         aabb3f m_collisionbox;
  94         video::SMaterial m_material;
  95         v2f m_texpos;
  96         v2f m_texsize;
  97         v3f m_pos;
  98         v3f m_velocity;
  99         v3f m_acceleration;
 100         LocalPlayer *m_player;
 101         float m_size;
 102         //! Color without lighting
 103         video::SColor m_base_color;
 104         //! Final rendered color
 105         video::SColor m_color;
 106         bool m_collisiondetection;
 107         bool m_collision_removal;
 108         bool m_object_collision;
 109         bool m_vertical;
 110         v3s16 m_camera_offset;
 111         struct TileAnimationParams m_animation;
 112         float m_animation_time = 0.0f;
 113         int m_animation_frame = 0;
 114         u8 m_glow;
 115 };
 116
 117 class ParticleSpawner
 118 {
 119 public:
 120         ParticleSpawner(IGameDef* gamedef,
 121                 LocalPlayer *player,
 122                 u16 amount,
 123                 float time,
 124                 v3f minp, v3f maxp,
 125                 v3f minvel, v3f maxvel,
 126                 v3f minacc, v3f maxacc,
 127                 float minexptime, float maxexptime,
 128                 float minsize, float maxsize,
 129                 bool collisiondetection,
 130                 bool collision_removal,
 131                 bool object_collision,
 132                 u16 attached_id,
 133                 bool vertical,
 134                 video::ITexture *texture,
 135                 u32 id,
 136                 const struct TileAnimationParams &anim, u8 glow,
 137                 ParticleManager* p_manager);
 138
 139         ~ParticleSpawner() = default;
 140
 141         void step(float dtime, ClientEnvironment *env);
 142
 143         bool get_expired ()
 144         { return (m_amount <= 0) && m_spawntime != 0; }
 145
 146 private:
 147         void spawnParticle(ClientEnvironment *env, float radius,
 148                         bool is_attached, const v3f &attached_pos,
 149                         float attached_yaw);
 150
 151         ParticleManager *m_particlemanager;
 152         float m_time;
 153         IGameDef *m_gamedef;
 154         LocalPlayer *m_player;
 155         u16 m_amount;
 156         float m_spawntime;
 157         v3f m_minpos;
 158         v3f m_maxpos;
 159         v3f m_minvel;
 160         v3f m_maxvel;
 161         v3f m_minacc;
 162         v3f m_maxacc;
 163         float m_minexptime;
 164         float m_maxexptime;
 165         float m_minsize;
 166         float m_maxsize;
 167         video::ITexture *m_texture;
 168         std::vector<float> m_spawntimes;
 169         bool m_collisiondetection;
 170         bool m_collision_removal;
 171         bool m_object_collision;
 172         bool m_vertical;
 173         u16 m_attached_id;
 174         struct TileAnimationParams m_animation;
 175         u8 m_glow;
 176 };
 177
 178 /**
 179  * Class doing particle as well as their spawners handling
 180  */
 181 class ParticleManager
 182 {
 183 friend class ParticleSpawner;
 184 public:
 185         ParticleManager(ClientEnvironment* env);
 186         ~ParticleManager();
 187
 188         void step (float dtime);
 189
 190         void handleParticleEvent(ClientEvent *event, Client *client,
 191                         LocalPlayer *player);
 192
 193         void addDiggingParticles(IGameDef *gamedef, LocalPlayer *player, v3s16 pos,
 194                 const MapNode &n, const ContentFeatures &f);
 195
 196         void addNodeParticle(IGameDef *gamedef, LocalPlayer *player, v3s16 pos,
 197                 const MapNode &n, const ContentFeatures &f);
 198
 199 protected:
 200         void addParticle(Particle* toadd);
 201
 202 private:
 203
 204         void stepParticles (float dtime);
 205         void stepSpawners (float dtime);
 206
 207         void clearAll ();
 208
 209         std::vector<Particle*> m_particles;
 210         std::map<u32, ParticleSpawner*> m_particle_spawners;
 211
 212         ClientEnvironment* m_env;
 213         std::mutex m_particle_list_lock;
 214         std::mutex m_spawner_list_lock;
 215 };