ryzom/client/src/entity_fx.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19 #ifndef CL_ENTITY_FX_H
  20 #define CL_ENTITY_FX_H
  21
  22 #include <string>
  23 #include <map>
  24
  25 #include "nel/misc/types_nl.h"
  26 #include "nel/misc/vector.h"
  27 #include "nel/misc/vectord.h"
  28 #include "nel/3d/u_particle_system_instance.h"
  29
  30 /**
  31  * CEntityFX class contained datas for instanciate an FX
  32  * \author Alain Saffray
  33  * \author Nevrax France
  34  * \date 2001
  35  */
  36 class CEntityFx
  37 {
  38 public:
  39
  40         struct SStatusFx
  41         {
  42                 uint32 AlwaysStarted : 1;
  43                 uint32 InfinityLoop : 1;
  44
  45                 uint32 Started : 1;
  46
  47                 SStatusFx( void )
  48                 {
  49                         AlwaysStarted = 0;
  50                         InfinityLoop = 0;
  51                         Started = 0;
  52                 }
  53         };
  54
  55         /**
  56          * Constructor
  57          * \param FxName name of Fx, must be unique
  58          * \param InstanceName name of instance (shape), used for instanciate FX
  59          * \param Position initial position of Fx
  60          * \param Rotation initial rotation matrix of Fx
  61          */
  62          CEntityFx( const std::string& FxName, const std::string& InstanceName, const NLMISC::CVector& Position, const NLMISC::CQuat& Rotation );
  63
  64         /**
  65          * Destructor
  66          */
  67          ~CEntityFx();
  68
  69         /// Get Status of Fx
  70         inline SStatusFx& getStatus( void ) { return _StatusFx; }
  71
  72         /// Set Status of Fx
  73         inline void setStatus( const SStatusFx& Status ) { _StatusFx = Status; }
  74
  75         /// alwaysStarted return true if Fx must be always started or set it
  76         inline bool alwaysStarted( void ) { return _StatusFx.AlwaysStarted; }
  77         inline void alwaysStarted( bool b ) { _StatusFx.AlwaysStarted = b; }
  78
  79         /// infinityLoop return true if Fx is must be in InfinityLoop or set it
  80         inline bool infinityLoop( void ) { return _StatusFx.InfinityLoop; }
  81         inline void infinityLoop( bool b ) { _StatusFx.InfinityLoop = b; }
  82
  83         /// started return true if Fx is Started or set it
  84         inline bool started( void ) { return _StatusFx.Started; }
  85         inline void started( bool b ) { _StatusFx.Started = b; }
  86
  87         /// startFx
  88         void startFx( void );
  89
  90         /// isTerminated return true if fx is finish
  91         bool isTerminated( void );
  92
  93         /// deleteInstance
  94         void deleteInstance( void);
  95
  96 private:
  97         std::string _FxName;
  98         std::string _InstanceName;
  99         NLMISC::CVector _Position;
 100         NLMISC::CQuat _Rotation;
 101         SStatusFx _StatusFx;
 102
 103         NL3D::UParticleSystemInstance _FxInstance;
 104 };
 105
 106
 107 typedef std::map< std::string, CEntityFx *> TMapEntityFx;
 108 extern TMapEntityFx EntityFx;
 109
 110 void newFx( const std::string& FxName, const std::string& InstanceName, const NLMISC::CVector& Position, const NLMISC::CQuat& Rotation );
 111 void deleteFx( const std::string& FxName );
 112 void startFx( const std::string& FxName );
 113 void manageFxEntities( void );
 114
 115 #endif // CL_ENTITY_FX_H
 116
 117 /* End of entity_fx.h */