src/viewport_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 viewport_type.h Types related to viewports. */
  11
  12 #ifndef VIEWPORT_TYPE_H
  13 #define VIEWPORT_TYPE_H
  14
  15 #include "zoom_type.h"
  16 #include "strings_type.h"
  17
  18 class LinkGraphOverlay;
  19
  20 /**
  21  * Data structure for viewport, display of a part of the world
  22  */
  23 struct ViewPort {
  24         int left;    ///< Screen coordinate left egde of the viewport
  25         int top;     ///< Screen coordinate top edge of the viewport
  26         int width;   ///< Screen width of the viewport
  27         int height;  ///< Screen height of the viewport
  28
  29         int virtual_left;    ///< Virtual left coordinate
  30         int virtual_top;     ///< Virtual top coordinate
  31         int virtual_width;   ///< width << zoom
  32         int virtual_height;  ///< height << zoom
  33
  34         ZoomLevel zoom; ///< The zoom level of the viewport.
  35         LinkGraphOverlay *overlay;
  36 };
  37
  38 /** Margins for the viewport sign */
  39 enum ViewportSignMargin {
  40         VPSM_LEFT   = 1, ///< Left margin
  41         VPSM_RIGHT  = 1, ///< Right margin
  42         VPSM_TOP    = 1, ///< Top margin
  43         VPSM_BOTTOM = 1, ///< Bottom margin
  44 };
  45
  46 /** Location information about a sign as seen on the viewport */
  47 struct ViewportSign {
  48         int32 center;        ///< The center position of the sign
  49         int32 top;           ///< The top of the sign
  50         uint16 width_normal; ///< The width when not zoomed out (normal font)
  51         uint16 width_small;  ///< The width when zoomed out (small font)
  52
  53         void UpdatePosition(int center, int top, StringID str);
  54         void MarkDirty(ZoomLevel maxzoom = ZOOM_LVL_MAX) const;
  55 };
  56
  57 /**
  58  * Directions of zooming.
  59  * @see DoZoomInOutWindow
  60  */
  61 enum ZoomStateChange {
  62         ZOOM_IN   = 0, ///< Zoom in (get more detailed view).
  63         ZOOM_OUT  = 1, ///< Zoom out (get helicopter view).
  64         ZOOM_NONE = 2, ///< Hack, used to update the button status.
  65 };
  66
  67 /**
  68  * Some values for constructing bounding boxes (BB). The Z positions under bridges are:
  69  * z=0..5  Everything that can be built under low bridges.
  70  * z=6     reserved, currently unused.
  71  * z=7     Z separator between bridge/tunnel and the things under/above it.
  72  */
  73 static const uint BB_HEIGHT_UNDER_BRIDGE = 6; ///< Everything that can be built under low bridges, must not exceed this Z height.
  74 static const uint BB_Z_SEPARATOR         = 7; ///< Separates the bridge/tunnel from the things under/above it.
  75
  76 /** Viewport place method (type of highlighted area and placed objects) */
  77 enum ViewportPlaceMethod {
  78         VPM_X_OR_Y          =    0, ///< drag in X or Y direction
  79         VPM_FIX_X           =    1, ///< drag only in X axis
  80         VPM_FIX_Y           =    2, ///< drag only in Y axis
  81         VPM_X_AND_Y         =    3, ///< area of land in X and Y directions
  82         VPM_X_AND_Y_LIMITED =    4, ///< area of land of limited size
  83         VPM_FIX_HORIZONTAL  =    5, ///< drag only in horizontal direction
  84         VPM_FIX_VERTICAL    =    6, ///< drag only in vertical direction
  85         VPM_X_LIMITED       =    7, ///< Drag only in X axis with limited size
  86         VPM_Y_LIMITED       =    8, ///< Drag only in Y axis with limited size
  87         VPM_RAILDIRS        = 0x40, ///< all rail directions
  88         VPM_SIGNALDIRS      = 0x80, ///< similar to VMP_RAILDIRS, but with different cursor
  89 };
  90 DECLARE_ENUM_AS_BIT_SET(ViewportPlaceMethod)
  91
  92 /**
  93  * Drag and drop selection process, or, what to do with an area of land when
  94  * you've selected it.
  95  */
  96 enum ViewportDragDropSelectionProcess {
  97         DDSP_DEMOLISH_AREA,        ///< Clear area
  98         DDSP_RAISE_AND_LEVEL_AREA, ///< Raise / level area
  99         DDSP_LOWER_AND_LEVEL_AREA, ///< Lower / level area
 100         DDSP_LEVEL_AREA,           ///< Level area
 101         DDSP_CREATE_DESERT,        ///< Fill area with desert
 102         DDSP_CREATE_ROCKS,         ///< Fill area with rocks
 103         DDSP_CREATE_WATER,         ///< Create a canal
 104         DDSP_CREATE_RIVER,         ///< Create rivers
 105         DDSP_PLANT_TREES,          ///< Plant trees
 106         DDSP_BUILD_BRIDGE,         ///< Bridge placement
 107
 108         /* Rail specific actions */
 109         DDSP_PLACE_RAIL,           ///< Rail placement
 110         DDSP_BUILD_SIGNALS,        ///< Signal placement
 111         DDSP_BUILD_STATION,        ///< Station placement
 112         DDSP_REMOVE_STATION,       ///< Station removal
 113         DDSP_CONVERT_RAIL,         ///< Rail conversion
 114
 115         /* Road specific actions */
 116         DDSP_PLACE_ROAD_X_DIR,     ///< Road placement (X axis)
 117         DDSP_PLACE_ROAD_Y_DIR,     ///< Road placement (Y axis)
 118         DDSP_PLACE_AUTOROAD,       ///< Road placement (auto)
 119         DDSP_BUILD_BUSSTOP,        ///< Road stop placement (buses)
 120         DDSP_BUILD_TRUCKSTOP,      ///< Road stop placement (trucks)
 121         DDSP_REMOVE_BUSSTOP,       ///< Road stop removal (buses)
 122         DDSP_REMOVE_TRUCKSTOP,     ///< Road stop removal (trucks)
 123 };
 124
 125 #endif /* VIEWPORT_TYPE_H */