OpenTTD

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