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