ryzom/client/src/client_sheets/world_sheet.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 RY_WORLD_SHEET_H
  20 #define RY_WORLD_SHEET_H
  21
  22 #include <vector>
  23 #include <string>
  24 #include "entity_sheet.h"
  25
  26 /// Continent location
  27 struct SContLoc
  28 {
  29         std::string SelectionName;                      // name exported that we can use with select
  30         std::string ContinentName;                      // .continent file
  31         float MinX, MinY, MaxX, MaxY;       // Bounding box
  32
  33         SContLoc ();
  34         void build (const NLGEORGES::UFormElm *pItem);
  35         void serial(NLMISC::IStream &f);
  36 };
  37
  38 // Hierarchical map node
  39 struct SMap
  40 {
  41         std::string Name;                               // Map Name
  42         std::string ContinentName;              // Name of the continent where the map is (empty if the map is world)
  43         std::string BitmapName;                 // Name of the bitmap to load
  44         float MinX, MinY, MaxX, MaxY;   // Bounding Box
  45         struct SChild
  46         {
  47                 std::string Name;               // Name to a child map
  48                 std::string ZoneName;   // Click Zone to be found in the region_*.primitive
  49                 // -----------------------
  50                 void build (const NLGEORGES::UFormElm *pItem);
  51                 void serial(NLMISC::IStream &f);
  52         };
  53         std::vector<SChild>     Children;
  54         // ---------------------------------------------------------------------------------
  55         SMap();
  56         void build (const NLGEORGES::UFormElm *pItem);
  57         void serial(NLMISC::IStream &f);
  58 };
  59
  60 /** Class that manage .world sheets
  61   *
  62   * \author Nicolas Vizerie
  63   * \author Nevrax France
  64   * \date 2003
  65   *
  66   */
  67 class CWorldSheet : public CEntitySheet
  68 {
  69 public:
  70         std::string                             Name;
  71         std::vector<SContLoc>   ContLocs;
  72         std::vector<SMap>               Maps;
  73 public:
  74         CWorldSheet();
  75         // from CEntitySheet;
  76         virtual void build(const NLGEORGES::UFormElm &item);
  77         virtual void serial(NLMISC::IStream &f);
  78 };
  79
  80 #endif