ryzom/client/src/client_sheets/fx_stick_mode.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_FX_STICK_MODE_H
  20 #define CL_FX_STICK_MODE_H
  21
  22
  23 #include "nel/misc/string_mapper.h"
  24
  25 namespace NLGEORGES
  26 {
  27         class UFormElm;
  28 }
  29
  30 /**
  31  * \author Matthieu 'Trap' Besson
  32  * \author Nevrax France
  33  * \date November 2003
  34  */
  35 class CFXStickMode
  36 {
  37
  38 public:
  39
  40         enum TStickMode
  41         {
  42                 Spawn = 0,
  43                 UserBone,
  44                 Follow,
  45                 FollowNoRotation,
  46                 OrientedTowardTargeter,
  47                 UserBoneOrientedTowardTargeter,
  48                 StaticMatrix,
  49                 StaticObjectCastRay = StaticMatrix, // cast ray for object such as towers (static once created)
  50                 UserBoneRay,
  51                 SpawnPermanent // spawn and delegate to fx manager when the fx is stopped
  52         };
  53
  54 public:
  55
  56         TStickMode                      Mode;
  57         NLMISC::TStringId       UserBoneName; // bone to which the fx must be sticked when StickBone == UserBone
  58
  59 public:
  60
  61         // Constructor
  62         CFXStickMode() : Mode(Follow), UserBoneName(0) {}
  63
  64         /// Build the stick mode from an external script.
  65         bool build(const NLGEORGES::UFormElm &item, const std::string &prefix = "");
  66
  67         /// Save and Load
  68         void serial(NLMISC::IStream &f);
  69 };
  70
  71 #endif