ryzom/client/src/door_manager.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_DOOR_MANAGER_H
  20 #define CL_DOOR_MANAGER_H
  21
  22 #include "ig_enum.h"
  23
  24 // ///////////// //
  25 // Doors Manager //
  26 // ///////////// //
  27 class CEntityCL;
  28
  29 class CDoorManager : public NL3D::ITransformName
  30 {
  31         static uint32 s_nextId;
  32
  33         struct SDoor
  34         {
  35                 uint32                                  ID;
  36                 std::string                             Name;                           // Name of the door (type_id ie: ma_asc_3portes_02)
  37                 std::vector<NLPACS::UMovePrimitive *> Prims;// All collisions prims for that door
  38                 NL3D::UInstanceGroup    *InstanceGroup;         // Instance Group where the door is.
  39                 std::vector<uint32>             Instances;                      // Shapes making the door
  40                 std::vector<NLMISC::CMatrix> InstMat;           // Matrix of the shapes making the door
  41                 bool                                    Opened;                         // Is the door is opened or closed ?
  42                 std::vector<CEntityCL*> Entities;                       // Entities in the trigger zone
  43                 std::vector<uint8>              EntitiesMoved;          // Entities in the trigger zone that moved
  44                 float                                   OCState;                        // 0 closed 1 opened
  45
  46                 enum TAnimType {        Normal,
  47                                                         Matis3Part,                     // For Instance Parts: 0==left 1==right 2==down
  48                                                         Matis3PartBourgeon,     // For Instance Parts: 0==left 1==right 2==down
  49                                                         Zorai2Part
  50                                                 };
  51                 TAnimType                               AnimType;
  52
  53
  54                 SDoor()
  55                 {
  56                         ID = ++s_nextId;
  57                         InstanceGroup = NULL;
  58                         Opened = false;
  59                         OCState = 0;
  60                         AnimType = Normal;
  61                 }
  62
  63                 void entityCollide(CEntityCL *pE);
  64
  65                 void checkToClose();
  66
  67                 // Animate the door's instances from current state to open state
  68                 // Return true if the anim is finished
  69                 bool open();
  70
  71                 // Animate the door's instances from current state to open state
  72                 // Return true if the anim is finished
  73                 bool close();
  74
  75                 // Called by open/close
  76                 void anim();
  77         };
  78
  79 public:
  80
  81         /// Singleton method : Get the unique interface loader instance
  82         static CDoorManager* getInstance()
  83         {
  84                 if (_Instance == NULL)
  85                         _Instance = new CDoorManager();
  86                 return _Instance;
  87         }
  88
  89         // release memory
  90         static void releaseInstance();
  91
  92         void loadedCallback (NL3D::UInstanceGroup *ig);
  93
  94         // Check in the group if there are some doors
  95         void addedCallback (NL3D::UInstanceGroup *ig);
  96
  97         // Remove all doors attached to this group
  98         void removedCallback (NL3D::UInstanceGroup *ig);
  99
 100         // Copy triggers to be used in update
 101         void getPACSTriggers();
 102
 103         // Check triggers in pacs to open/close the doors
 104         void update ();
 105
 106 private:
 107
 108         virtual std::string transformName (uint index, const std::string &instanceName, const std::string &shapeName);
 109
 110 private:
 111
 112         static CDoorManager *_Instance;
 113
 114         std::vector<SDoor*> _Doors;
 115 };
 116 // shortcut to access the manager
 117 inline CDoorManager &getDoorManager() { return *CDoorManager::getInstance(); }
 118
 119 // ///////// //
 120 // Callbacks //
 121 // ///////// //
 122
 123 class CIGDoorAddedCallback : public IIGObserver
 124 {
 125 private:
 126         // An IG has been added
 127         virtual void instanceGroupLoaded(NL3D::UInstanceGroup *ig)
 128         {
 129                 getDoorManager().loadedCallback (ig);
 130         }
 131         // An IG has been added
 132         virtual void instanceGroupAdded(NL3D::UInstanceGroup *ig)
 133         {
 134                 getDoorManager().addedCallback (ig);
 135         }
 136         // An IG will be removed
 137         virtual void instanceGroupRemoved(NL3D::UInstanceGroup *ig)
 138         {
 139                 getDoorManager().removedCallback (ig);
 140         }
 141 };
 142
 143 extern CIGDoorAddedCallback             IGDoorCallback;
 144
 145 #endif // CL_DOOR_MANAGER_H