ryzom/client/src/fx_cl.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 NL_FX_CL_H
  20 #define NL_FX_CL_H
  21
  22 // Misc
  23 #include "nel/misc/types_nl.h"
  24 // Client
  25 #include "entity_cl.h"
  26 // 3D
  27 #include "nel/3d/u_particle_system_instance.h"
  28
  29
  30 class CFXSheet;
  31
  32 /**
  33  * <Class description>
  34  * \author David Fleury, Olivier Cado
  35  * \author Nevrax France
  36  * \date 2001, 2003
  37  */
  38 class CFxCL : public CEntityCL
  39 {
  40 public:
  41         NLMISC_DECLARE_CLASS(CFxCL);
  42
  43         /// Constructor
  44         CFxCL();
  45         /// Destructor
  46         virtual ~CFxCL();
  47
  48         /// Build the entity from a sheet.
  49         virtual bool build( const CEntitySheet *sheet );
  50
  51         /// Load a FX object (.ps file) (delete the previous object)
  52         bool setFx( const std::string &fileName );
  53
  54 protected:
  55
  56         /// Initialize properties of the entity (according to the class).
  57         virtual void initProperties() { properties().selectable( false ); }
  58
  59         /// Update the item position.
  60         virtual void updateVisualPropertyPos(const NLMISC::TGameCycle &gameCycle, const sint64 &prop, const NLMISC::TGameCycle &pI);
  61
  62         // Update the position of the entity after the motion.
  63         //virtual void updatePos(const NLMISC::TTime &time, CEntityCL *target);
  64
  65         // Method called each frame to manage the entity after the clipping test if the primitive is visible.
  66         //virtual void updateVisible(const NLMISC::TTime &time, CEntityCL *target);
  67
  68         /// Draw the selection Box
  69         virtual void drawBox();
  70
  71 private:
  72
  73         /// Init
  74         void init();
  75
  76         const CFXSheet *_FXSheet;
  77         bool                    _BadBuild;
  78 };
  79
  80
  81 #endif // NL_FX_CL_H
  82
  83 /* End of fx_cl.h */