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