src/game/MovementGenerator.h

   1 /*
   2  * Copyright (C) 2005-2010 MaNGOS <http://getmangos.com/>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (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 General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #ifndef MANGOS_MOVEMENTGENERATOR_H
  20 #define MANGOS_MOVEMENTGENERATOR_H
  21
  22 #include "Platform/Define.h"
  23 #include "Policies/Singleton.h"
  24 #include "Dynamic/ObjectRegistry.h"
  25 #include "Dynamic/FactoryHolder.h"
  26 #include "Common.h"
  27 #include "MotionMaster.h"
  28
  29 class Unit;
  30
  31 class MANGOS_DLL_SPEC MovementGenerator
  32 {
  33     public:
  34         virtual ~MovementGenerator();
  35
  36         // called before adding movement generator to motion stack
  37         virtual void Initialize(Unit &) = 0;
  38         // called aftre remove movement generator from motion stack
  39         virtual void Finalize(Unit &) = 0;
  40
  41         // called before lost top position (before push new movement generator above)
  42         virtual void Interrupt(Unit &) = 0;
  43         // called after return movement generator to top position (after remove above movement generator)
  44         virtual void Reset(Unit &) = 0;
  45
  46         virtual bool Update(Unit &, const uint32 &time_diff) = 0;
  47
  48         virtual MovementGeneratorType GetMovementGeneratorType() const = 0;
  49
  50         virtual void unitSpeedChanged() { }
  51
  52         virtual void UpdateFinalDistance(float /*fDistance*/) { }
  53
  54         virtual bool GetDestination(float& /*x*/, float& /*y*/, float& /*z*/) const { return false; }
  55
  56         // used by Evade code for select point to evade with expected restart default movement
  57         virtual bool GetResetPosition(Unit &, float& /*x*/, float& /*y*/, float& /*z*/) { return false; }
  58
  59         // used for check from Update call is movegen still be active (top movement generator)
  60         // after some not safe for this calls
  61         bool IsActive(Unit& u);
  62 };
  63
  64 template<class T, class D>
  65 class MANGOS_DLL_SPEC MovementGeneratorMedium : public MovementGenerator
  66 {
  67     public:
  68         void Initialize(Unit &u)
  69         {
  70             //u->AssertIsType<T>();
  71             (static_cast<D*>(this))->Initialize(*((T*)&u));
  72         }
  73         void Finalize(Unit &u)
  74         {
  75             //u->AssertIsType<T>();
  76             (static_cast<D*>(this))->Finalize(*((T*)&u));
  77         }
  78         void Interrupt(Unit &u)
  79         {
  80             //u->AssertIsType<T>();
  81             (static_cast<D*>(this))->Interrupt(*((T*)&u));
  82         }
  83         void Reset(Unit &u)
  84         {
  85             //u->AssertIsType<T>();
  86             (static_cast<D*>(this))->Reset(*((T*)&u));
  87         }
  88         bool Update(Unit &u, const uint32 &time_diff)
  89         {
  90             //u->AssertIsType<T>();
  91             return (static_cast<D*>(this))->Update(*((T*)&u), time_diff);
  92         }
  93         bool GetResetPosition(Unit& u, float& x, float& y, float& z)
  94         {
  95             //u->AssertIsType<T>();
  96             return (static_cast<D*>(this))->GetResetPosition(*((T*)&u), x, y, z);
  97         }
  98     public:
  99         // will not link if not overridden in the generators
 100         void Initialize(T &u);
 101         void Finalize(T &u);
 102         void Interrupt(T &u);
 103         void Reset(T &u);
 104         bool Update(T &u, const uint32 &time_diff);
 105
 106         // not need always overwrites
 107         bool GetResetPosition(T& /*u*/, float& /*x*/, float& /*y*/, float& /*z*/) { return false; }
 108 };
 109
 110 struct SelectableMovement : public FactoryHolder<MovementGenerator,MovementGeneratorType>
 111 {
 112     SelectableMovement(MovementGeneratorType mgt) : FactoryHolder<MovementGenerator,MovementGeneratorType>(mgt) {}
 113 };
 114
 115 template<class REAL_MOVEMENT>
 116 struct MovementGeneratorFactory : public SelectableMovement
 117 {
 118     MovementGeneratorFactory(MovementGeneratorType mgt) : SelectableMovement(mgt) {}
 119
 120     MovementGenerator* Create(void *) const;
 121 };
 122
 123 typedef FactoryHolder<MovementGenerator,MovementGeneratorType> MovementGeneratorCreator;
 124 typedef FactoryHolder<MovementGenerator,MovementGeneratorType>::FactoryHolderRegistry MovementGeneratorRegistry;
 125 typedef FactoryHolder<MovementGenerator,MovementGeneratorType>::FactoryHolderRepository MovementGeneratorRepository;
 126
 127 #endif
 128