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 tilehighlight_type.h Types related to highlighting tiles. */ 9 10 #ifndef TILEHIGHLIGHT_TYPE_H 11 #define TILEHIGHLIGHT_TYPE_H 12 13 #include "core/geometry_type.hpp" 14 #include "window_type.h" 15 #include "tile_type.h" 16 #include "viewport_type.h" 17 18 /** Highlighting draw styles */ 19 enum HighLightStyle { 20 HT_NONE = 0x000, ///< default 21 HT_RECT = 0x010, ///< rectangle (stations, depots, ...) 22 HT_POINT = 0x020, ///< point (lower land, raise land, level land, ...) 23 HT_SPECIAL = 0x030, ///< special mode used for highlighting while dragging (and for tunnels/docks) 24 HT_DRAG = 0x040, ///< dragging items in the depot windows 25 HT_LINE = 0x008, ///< used for autorail highlighting (longer stretches), lower bits: direction 26 HT_RAIL = 0x080, ///< autorail (one piece), lower bits: direction 27 HT_VEHICLE = 0x100, ///< vehicle is accepted as target as well (bitmask) 28 HT_DIAGONAL = 0x200, ///< Also allow 'diagonal rectangles'. Only usable in combination with #HT_RECT or #HT_POINT. 29 HT_DRAG_MASK = 0x0F8, ///< Mask for the tile drag-type modes. 30 31 /* lower bits (used with HT_LINE and HT_RAIL): 32 * (see ASCII art in table/autorail.h for a visual interpretation) */ 33 HT_DIR_X = 0, ///< X direction 34 HT_DIR_Y = 1, ///< Y direction 35 HT_DIR_HU = 2, ///< horizontal upper 36 HT_DIR_HL = 3, ///< horizontal lower 37 HT_DIR_VL = 4, ///< vertical left 38 HT_DIR_VR = 5, ///< vertical right 39 HT_DIR_END, ///< end marker 40 HT_DIR_MASK = 0x7, ///< masks the drag-direction 41 }; 42 DECLARE_ENUM_AS_BIT_SET(HighLightStyle) 43 44 45 /** Metadata about the current highlighting. */ 46 struct TileHighlightData { 47 Point pos; ///< Location, in tile "units", of the northern tile of the selected area. 48 Point size; ///< Size, in tile "units", of the white/red selection area. 49 Point offs; ///< Offset, in tile "units", for the blue coverage area from the selected area's northern tile. 50 Point outersize; ///< Size, in tile "units", of the blue coverage area excluding the side of the selected area. 51 bool diagonal; ///< Whether the dragged area is a 45 degrees rotated rectangle. 52 53 bool freeze; ///< Freeze highlight in place. 54 55 Point new_pos; ///< New value for \a pos; used to determine whether to redraw the selection. 56 Point new_size; ///< New value for \a size; used to determine whether to redraw the selection. 57 Point new_outersize; ///< New value for \a outersize; used to determine whether to redraw the selection. 58 byte dirty; ///< Whether the build station window needs to redraw due to the changed selection. 59 60 Point selstart; ///< The location where the dragging started. 61 Point selend; ///< The location where the drag currently ends. 62 byte sizelimit; ///< Whether the selection is limited in length, and what the maximum length is. 63 64 HighLightStyle drawstyle; ///< Lower bits 0-3 are reserved for detailed highlight information. 65 HighLightStyle next_drawstyle; ///< Queued, but not yet drawn style. 66 67 HighLightStyle place_mode; ///< Method which is used to place the selection. 68 WindowClass window_class; ///< The \c WindowClass of the window that is responsible for the selection mode. 69 WindowNumber window_number; ///< The \c WindowNumber of the window that is responsible for the selection mode. 70 71 bool make_square_red; ///< Whether to give a tile a red selection. 72 TileIndex redsq; ///< The tile that has to get a red selection. 73 74 ViewportPlaceMethod select_method; ///< The method which governs how tiles are selected. 75 ViewportDragDropSelectionProcess select_proc; ///< The procedure that has to be called when the selection is done. 76 77 void Reset(); 78 79 bool IsDraggingDiagonal(); 80 Window *GetCallbackWnd(); 81 }; 82 83 #endif /* TILEHIGHLIGHT_TYPE_H */ 84