ryzom/client/src/continent.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2020  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21
  22 #ifndef CL_CONTINENT_H
  23 #define CL_CONTINENT_H
  24
  25
  26 /////////////
  27 // INCLUDE //
  28 /////////////
  29 // Misc
  30 #include "nel/misc/types_nl.h"
  31 #include "nel/misc/vector.h"
  32 #include "nel/misc/rgba.h"
  33 // Game share
  34 #include "game_share/season.h"
  35 #include "game_share/dir_light_setup.h"
  36 // Client sheets
  37 #include "client_sheets/continent_sheet.h"
  38 //
  39 #include "streamable_entity_composite.h"
  40 #include "fog_map.h"
  41 #include "game_share/fog_of_war.h"
  42 #include "game_share/fog_type.h"
  43 #include "game_share/time_weather_season/weather_function.h"
  44 #include "sky_material_setup.h"
  45 #include "outpost.h"
  46 //
  47 #include "sky.h" // new style sky
  48 //
  49 #include "water_map.h"
  50
  51 #include "continent_manager_build.h"
  52
  53 struct IIGEnum;
  54 struct IIGAdded;
  55
  56
  57 ///////////
  58 // CLASS //
  59 ///////////
  60 namespace NLMISC
  61 {
  62         class CVectorD;
  63         class IProgressCallback;
  64 }
  65
  66 namespace NL3D
  67 {
  68         class UDriver;
  69 }
  70
  71 struct CFogState;
  72
  73 // Landmark created by the user
  74 class CUserLandMark
  75 {
  76
  77 public:
  78
  79         enum EUserLandMarkType
  80         {
  81                 Misc = 0,
  82                 Tribe,
  83                 Bandit,
  84                 Citizen,
  85                 Fauna,
  86                 FaunaExcel,
  87                 FaunaSup,
  88                 Forage,
  89                 ForageExcel,
  90                 ForageSup,
  91                 Sap,
  92                 Amber,
  93                 Node,
  94                 Fiber,
  95                 Bark,
  96                 Seed,
  97                 Shell,
  98                 Resin,
  99                 Wood,
 100                 Oil,
 101                 Mission,
 102                 Food,
 103                 Construction,
 104                 Goo,
 105                 Insect,
 106                 Kitin,
 107                 Nocive,
 108                 Preservative,
 109                 Passage,
 110                 Teleporter,
 111                 UserLandMarkTypeCount
 112         };
 113
 114         NLMISC::CVector2f       Pos; // Pos in local map
 115         ucstring                        Title; // FIXME: UTF-8 (serial)
 116         uint8                           Type;
 117
 118         //User LandMarks Colors
 119         static NLMISC::CRGBA            _LandMarksColor[UserLandMarkTypeCount];
 120
 121 public:
 122
 123
 124         CUserLandMark()
 125         {
 126                 Type = Misc;
 127         }
 128
 129         /// Get user landmark color
 130         NLMISC::CRGBA   getColor () const;
 131
 132         void serial(NLMISC::IStream &f)
 133         {
 134                 f.serial(Pos, Title, Type);
 135         }
 136
 137 };
 138
 139 /**
 140  * Class to manage the fog of war over a continent
 141  * \author Matthieu 'Trap' Besson
 142  * \author Nevrax France
 143  * \date June 2004
 144  */
 145 class CFogOfWar : public IFogOfWar
 146 {
 147
 148 public:
 149
 150         NL3D::UTextureMem *Tx; // Here store the real size
 151
 152 public:
 153
 154         CFogOfWar()
 155         {
 156                 Tx = NULL;
 157         }
 158
 159         ~CFogOfWar();
 160
 161         void load(const std::string &contName);
 162         void save(const std::string &contName);
 163
 164         // Implementation of IFogOfWar
 165         virtual uint8 *getData();
 166         virtual bool createData(sint16 w, sint16 h);
 167         virtual void explored(sint16 mapPosX, sint16 mapPosY);
 168         virtual sint16 getRealWidth();
 169         virtual sint16 getRealHeight();
 170 };
 171
 172
 173 /**
 174  * Class to manage a continent.
 175  * \author Guillaume PUZIN (GUIGUI)
 176  * \author Nevrax France
 177  * \date 2001
 178  */
 179 class CContinent : public CContinentParameters
 180 {
 181 public:
 182         // name of the sheet used to create the continent
 183         std::string       SheetName;
 184
 185
 186
 187         // backup setup of sky for day
 188         CSkyMaterialSetup DaySkySetup;
 189
 190         // backup setup of sky for day
 191         CSkyMaterialSetup NightSkySetup;
 192
 193         // Fog map
 194         CFogMap                                 FogMap;
 195
 196         // Water map
 197         CWaterMap                               WaterMap;
 198
 199         // Selected season
 200         EGSPD::CSeason::TSeason         Season;
 201
 202         // A group of village
 203         CStreamableEntityComposite      _Villages;
 204
 205         // A group of outposts
 206         std::vector<COutpost>           _Outposts;
 207
 208         // The current sky
 209         CSky                     CurrentSky;
 210
 211         // Weather functions for each season
 212         CWeatherFunction        WeatherFunction[EGSPD::CSeason::Invalid];
 213
 214         // user landmarks (saved)
 215         std::vector<CUserLandMark> UserLandMarks;
 216
 217         // continent landmarks (not saved but static data)
 218         std::vector<CContLandMark> ContLandMarks;
 219
 220         // Continent occupation zone
 221         NLLIGO::CPrimZone       Zone;
 222
 223         // Center of the occupation zone
 224         NLMISC::CVector2f       ZoneCenter;
 225
 226 //      bool Newbie;
 227
 228         CFogOfWar       FoW;
 229
 230 public:
 231         /// Constructor
 232         CContinent();
 233
 234         /// setup the continent from a sheet (use the SheetName that MUST be set)
 235         void setup();
 236
 237         /**
 238          * Update global parameters like the texture for the micro veget.
 239          */
 240         void select(const NLMISC::CVectorD &pos, NLMISC::IProgressCallback &progress, bool complete, bool unhibernate, EGSPD::CSeason::TSeason season);
 241
 242         /// This will remove extra rsc used by the continent (fog maps ..)
 243         void unselect();
 244
 245         /** Test whether the next call to updateStreamable will be blocking.
 246           * This happen for example when the player is too near of a village and when asynchronous loading is not sufficient.
 247           * \param pos player position
 248           */
 249         bool isLoadingforced(const NLMISC::CVector &playerPos) const;
 250
 251         /** Given the position of the player, load / unload objects (asynchronously when possible)
 252           */
 253         void updateStreamable(const NLMISC::CVector &playerPos);
 254
 255         /** Given the position of the player, load / unload objects (always in a synchronous fashion)
 256           */
 257         void forceUpdateStreamable(const NLMISC::CVector &playerPos, NLMISC::IProgressCallback &progress);
 258
 259         /** Remove all villages from the continents
 260           */
 261         void removeVillages();
 262
 263         // Get a outpost
 264         COutpost        *getOutpost (uint i);
 265
 266         // get fog
 267         void getFogState(TFogType fogType, float dayNight, float duskRatio, CLightCycleManager::TLightState lightState, const NLMISC::CVectorD &pos, CFogState &result, bool overideByWeatherFogDist = true);
 268
 269
 270
 271         /** Enum ig of the continent
 272           * (for now, these are currently instanciated villages)
 273           * \return false if the enumeration has been stopped
 274           */
 275         bool            enumIGs(IIGEnum *callback);
 276
 277
 278         ///\name ig added observers.
 279         //@{
 280                 void registerObserver(IIGObserver *obs);
 281                 void removeObserver(IIGObserver *obs);
 282                 bool isObserver(IIGObserver *obs) const;
 283         //@}
 284
 285         // load (or reload) the micro-life primitives
 286         void loadMicroLife();
 287
 288         // init the water map
 289         void initWaterMap();
 290
 291         /** get corners min / zone max
 292           * \return true if success
 293           */
 294         bool getCorners(NLMISC::CVector2f &cornerMin, NLMISC::CVector2f &cornerMax) const;
 295
 296         // dump village loading zones in a bitmap
 297         void dumpVillagesLoadingZones(const std::string &filename);
 298
 299         enum TChannel { ChannelR = 0, ChannelG = 1, ChannelB = 2, ChannelA = 3, ChannelRGBA };
 300         // dump fog map, blended with continent map, and with camera pos
 301         // If a single channel is used, then channelLookup is used pick up the final color
 302         void dumpFogMap(CFogMapBuild::TMapType mapType, const std::string &filename, TChannel channel = ChannelRGBA, const CRGBA channelLookup[256] = NULL);
 303
 304         void reloadFogMap();
 305
 306         // init release the sky
 307         void initSky();
 308         void releaseSky();
 309
 310         /// Return the max number of user landmarks (standard + bonus ones)
 311         static uint getMaxNbUserLandMarks();
 312
 313 private:
 314
 315         // Register outpost (collsions...)
 316         void            initOutpost();
 317
 318         // Remove all outpost (collisions...)
 319         void            removeOutpost();
 320
 321         // load the fog maps
 322         bool loadFogMaps();
 323
 324         // Load the weather functions
 325         void loadWeatherFunctions(const NLGEORGES::UFormElm &item);
 326
 327 };
 328
 329
 330 #endif // CL_CONTINENT_H
 331
 332 /* End of continent.h */