src/zoom_type.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file zoom_type.h Types related to zooming in and out. */
  11
  12 #ifndef ZOOM_TYPE_H
  13 #define ZOOM_TYPE_H
  14
  15 #include "core/enum_type.hpp"
  16
  17 static int const ZOOM_LVL_SHIFT = 2;
  18 static int const ZOOM_LVL_BASE  = 1 << ZOOM_LVL_SHIFT;
  19
  20 /** All zoom levels we know. */
  21 enum ZoomLevel {
  22         /* Our possible zoom-levels */
  23         ZOOM_LVL_BEGIN  = 0, ///< Begin for iteration.
  24         ZOOM_LVL_NORMAL = 0, ///< The normal zoom level.
  25         ZOOM_LVL_OUT_2X,     ///< Zoomed 2 times out.
  26         ZOOM_LVL_OUT_4X,     ///< Zoomed 4 times out.
  27         ZOOM_LVL_OUT_8X,     ///< Zoomed 8 times out.
  28         ZOOM_LVL_OUT_16X,    ///< Zoomed 16 times out.
  29         ZOOM_LVL_OUT_32X,    ///< Zoomed 32 times out.
  30         ZOOM_LVL_END,        ///< End for iteration.
  31
  32         ZOOM_LVL_COUNT = ZOOM_LVL_END - ZOOM_LVL_BEGIN, ///< Number of zoom levels.
  33
  34         /* Here we define in which zoom viewports are */
  35         ZOOM_LVL_VIEWPORT = ZOOM_LVL_OUT_4X, ///< Default zoom level for viewports.
  36         ZOOM_LVL_GUI      = ZOOM_LVL_OUT_4X, ///< Default zoom level for GUI sprites.
  37         ZOOM_LVL_NEWS     = ZOOM_LVL_OUT_4X, ///< Default zoom level for the news messages.
  38         ZOOM_LVL_INDUSTRY = ZOOM_LVL_OUT_8X, ///< Default zoom level for the industry view.
  39         ZOOM_LVL_TOWN     = ZOOM_LVL_OUT_8X, ///< Default zoom level for the town view.
  40         ZOOM_LVL_AIRCRAFT = ZOOM_LVL_OUT_4X, ///< Default zoom level for the aircraft view.
  41         ZOOM_LVL_SHIP     = ZOOM_LVL_OUT_4X, ///< Default zoom level for the ship view.
  42         ZOOM_LVL_TRAIN    = ZOOM_LVL_OUT_4X, ///< Default zoom level for the train view.
  43         ZOOM_LVL_ROADVEH  = ZOOM_LVL_OUT_4X, ///< Default zoom level for the road vehicle view.
  44         ZOOM_LVL_WORLD_SCREENSHOT = ZOOM_LVL_OUT_4X, ///< Default zoom level for the world screen shot.
  45
  46         ZOOM_LVL_DETAIL   = ZOOM_LVL_OUT_8X, ///< All zoomlevels below or equal to this, will result in details on the screen, like road-work, ...
  47
  48         ZOOM_LVL_MIN      = ZOOM_LVL_NORMAL, ///< Minimum zoom level.
  49         ZOOM_LVL_MAX      = ZOOM_LVL_OUT_32X, ///< Maximum zoom level.
  50 };
  51 DECLARE_POSTFIX_INCREMENT(ZoomLevel)
  52
  53 /** Type for storing the zoom level in a byte. */
  54 typedef SimpleTinyEnumT<ZoomLevel, byte> ZoomLevelByte;
  55
  56 #endif /* ZOOM_TYPE_H */