ryzom/client/src/continent_manager.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010-2019  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_CONTINENT_MANAGER_H
  20 #define CL_CONTINENT_MANAGER_H
  21
  22
  23 /////////////
  24 // INCLUDE //
  25 /////////////
  26 // Misc
  27 #include "nel/misc/types_nl.h"
  28 // std.
  29 #include <vector>
  30 #include <map>
  31 #include <string>
  32 // client
  33 #include "continent.h"
  34 // client sheets
  35 #include "client_sheets/world_sheet.h"
  36
  37 ///////////
  38 // CLASS //
  39 ///////////
  40
  41 namespace NLMISC
  42 {
  43         class CVectorD;
  44         class CVector;
  45         class IProgressCallback;
  46 }
  47
  48 namespace NLGEORGES
  49 {
  50         class UFormElm;
  51 }
  52
  53 class CContinent;
  54 struct CFogState;
  55
  56 /**
  57  * Class to manage all continents.
  58  * \author Guillaume PUZIN (GUIGUI)
  59  * \author Nevrax France
  60  * \date 2001
  61  * \warning When you modify this class be sure _Current is always valid.
  62  */
  63 class CContinentManager
  64 {
  65 public:
  66         /// Constructor
  67         CContinentManager();
  68
  69         /// preload continent sheets
  70         void preloadSheets();
  71
  72         /// Load & setup all continent.
  73         void load();
  74
  75         // reset all datas
  76         void reset();
  77
  78         /**
  79          * Select continent from a name.
  80          * \param const string &name : name of the continent to select.
  81          */
  82         void select(const std::string &name, const NLMISC::CVectorD &pos, NLMISC::IProgressCallback &progress);
  83         /// Select closest continent from a vector.
  84         void select(const NLMISC::CVectorD &pos, NLMISC::IProgressCallback &progress);
  85
  86         /** Test whether the next call to updateStreamable will be blocking.
  87           * This happen for example when the player is too near of a village and when asynchronous loading is not sufficient.
  88           * \param pos player position
  89           */
  90         bool isLoadingforced(const NLMISC::CVector &playerPos) const;
  91
  92         /** Given the position of the player, load / unload objects, asynchronously when possible (these are village for now)
  93           */
  94         void updateStreamable(const NLMISC::CVector &playerPos);
  95         /** Given the position of the player, load / unload objects, but always in a synchronous fashion.
  96           */
  97         void forceUpdateStreamable(const NLMISC::CVector &playerPos, NLMISC::IProgressCallback &progress);
  98
  99         void removeVillages();
 100
 101         // get fog
 102         void getFogState(TFogType fogType, float dayNight, float duskRatio, CLightCycleManager::TLightState lightState, const NLMISC::CVectorD &pos, CFogState &result);
 103
 104         // Return a pointer on the current continent.
 105         CContinent      *cur() {return _Current;}
 106
 107         // Return a pointer on the desired continent
 108         CContinent      *get(const std::string &contName);
 109
 110         const std::string &getCurrentContinentSelectName();
 111
 112         // load / save all user landmarks in xml format
 113         void writeTo(xmlNodePtr node) const;
 114         void readFrom(xmlNodePtr node);
 115
 116         // load / saves all user landMarks
 117         // \return number of landmarks loaded or saved
 118         uint32 serialUserLandMarks(NLMISC::IStream &f);
 119
 120         // rebuild visible landmarks on current map
 121         void updateUserLandMarks();
 122
 123         // load / saves all fow maps
 124         void serialFOWMaps();
 125
 126         void reloadWeather();
 127
 128         void reloadSky();
 129
 130         std::string getRegionNameByAlias(uint32 i);
 131
 132 protected:
 133
 134         void loadContinentLandMarks();
 135         void readLMConts(const std::string &dataPath);
 136
 137 protected:
 138
 139         typedef std::map<std::string, CContinent *> TContinents;
 140
 141         /// Map with all continents.
 142         TContinents     _Continents;
 143
 144         /// Current continent selected.
 145         CContinent      *_Current;
 146         CContinent      *_Hibernated;
 147
 148         /// Map to find region name by alias
 149         std::map<uint32, std::string> aliasToRegionMap;
 150
 151 public:
 152         // World Map Info
 153         std::vector<CContLandMark> WorldMap;
 154
 155 };
 156
 157
 158 #endif // CL_CONTINENT_MANAGER_H
 159
 160 /* End of continent_manager.h */