OpenTTD Source: src/smallmap_gui.h Source File

OpenTTD Source 1.11.0-RC1

smallmap_gui.h
Go to the documentation of this file.
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
10 #ifndef SMALLMAP_GUI_H
11 #define SMALLMAP_GUI_H
12
13 #include "industry_type.h"
14 #include "company_base.h"
15 #include "window_gui.h"
16 #include "strings_func.h"
17 #include "blitter/factory.hpp"
18 #include "linkgraph/linkgraph_gui.h"
19 #include "widgets/smallmap_widget.h"
20 #include "guitimer_func.h"
21
22 /* set up the cargos to be displayed in the smallmap's route legend */
23 void BuildLinkStatsLegend();
24
25 void BuildIndustriesLegend();
26 void ShowSmallMap();
27 void BuildLandLegend();
28 void BuildOwnerLegend();
29
31 struct LegendAndColour {
32 uint8 colour;
33 StringID legend;
34 IndustryType type;
35 uint8 height;
36 CompanyID company;
37 bool show_on_map;
38 bool end;
39 bool col_break;
40 };
41
43 class SmallMapWindow : public Window {
44 protected:
46 enum SmallMapType {
47 SMT_CONTOUR,
48 SMT_VEHICLES,
49 SMT_INDUSTRY,
50 SMT_LINKSTATS,
51 SMT_ROUTES,
52 SMT_VEGETATION,
53 SMT_OWNER,
54 };
55
57 enum ZoomLevelChange {
58 ZLC_INITIALIZE,
59 ZLC_ZOOM_OUT,
60 ZLC_ZOOM_IN,
61 };
62
63 static SmallMapType map_type;
64 static bool show_towns;
65 static int max_heightlevel;
66
67 static const uint LEGEND_BLOB_WIDTH = 8;
68 static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2;
69 static const uint FORCE_REFRESH_PERIOD = 930;
70 static const uint BLINK_PERIOD = 450;
71
72 uint min_number_of_columns;
73 uint min_number_of_fixed_rows;
74 uint column_width;
75
76 int32 scroll_x;
77 int32 scroll_y;
78 int32 subscroll;
79 int zoom;
80
81 GUITimer refresh;
82 LinkGraphOverlay *overlay;
83
84 static void BreakIndustryChainLink();
85 Point SmallmapRemapCoords(int x, int y) const;
86
93 static inline void DrawVertMapIndicator(int x, int y, int y2)
94 {
95 GfxFillRect(x, y, x, y + 3, PC_VERY_LIGHT_YELLOW);
96 GfxFillRect(x, y2 - 3, x, y2, PC_VERY_LIGHT_YELLOW);
97 }
98
105 static inline void DrawHorizMapIndicator(int x, int x2, int y)
106 {
107 GfxFillRect(x, y, x + 3, y, PC_VERY_LIGHT_YELLOW);
108 GfxFillRect(x2 - 3, y, x2, y, PC_VERY_LIGHT_YELLOW);
109 }
110
115 inline uint GetMinLegendWidth() const
116 {
117 return WD_FRAMERECT_LEFT + this->min_number_of_columns * this->column_width;
118 }
119
124 inline uint GetNumberColumnsLegend(uint width) const
125 {
126 return width / this->column_width;
127 }
128
134 inline uint GetLegendHeight(uint num_columns) const
135 {
136 return WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM +
137 this->GetNumberRowsLegend(num_columns) * FONT_HEIGHT_SMALL;
138 }
139
145 inline uint32 GetOverlayCompanyMask() const
146 {
147 return Company::IsValidID(_local_company) ? 1U << _local_company : 0xffffffff;
148 }
149
150 void RebuildColourIndexIfNecessary();
151 uint GetNumberRowsLegend(uint columns) const;
152 void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item = 0);
153 void SwitchMapType(SmallMapType map_type);
154 void SetNewScroll(int sx, int sy, int sub);
155
156 void DrawMapIndicators() const;
157 void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const;
158 void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const;
159 void DrawTowns(const DrawPixelInfo *dpi) const;
160 void DrawSmallMap(DrawPixelInfo *dpi) const;
161
162 Point RemapTile(int tile_x, int tile_y) const;
163 Point PixelToTile(int px, int py, int *sub, bool add_sub = true) const;
164 Point ComputeScroll(int tx, int ty, int x, int y, int *sub);
165 void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt);
166 void SetOverlayCargoMask();
167 void SetupWidgetData();
168 uint32 GetTileColours(const TileArea &ta) const;
169
170 int GetPositionOnLegend(Point pt);
171
172 public:
173 friend class NWidgetSmallmapDisplay;
174
175 SmallMapWindow(WindowDesc *desc, int window_number);
176 virtual ~SmallMapWindow();
177
178 void SmallMapCenterOnCurrentPos();
179 Point GetStationMiddle(const Station *st) const;
180
181 void SetStringParameters(int widget) const override;
182 void OnInit() override;
183 void OnPaint() override;
184 void DrawWidget(const Rect &r, int widget) const override;
185 void OnClick(Point pt, int widget, int click_count) override;
186 void OnInvalidateData(int data = 0, bool gui_scope = true) override;
187 bool OnRightClick(Point pt, int widget) override;
188 void OnMouseWheel(int wheel) override;
189 void OnRealtimeTick(uint delta_ms) override;
190 void OnScroll(Point delta) override;
191 void OnMouseOver(Point pt, int widget) override;
192 };
193
194 #endif /* SMALLMAP_GUI_H */
LegendAndColour::type
IndustryType type
Type of industry. Only valid for industry entries.
Definition: smallmap_gui.h:34
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:62
factory.hpp
SmallMapWindow::min_number_of_fixed_rows
uint min_number_of_fixed_rows
Minimal number of rows in the legends for the fixed layouts only (all except #SMT_INDUSTRY).
Definition: smallmap_gui.h:73
SmallMapWindow::map_type
static SmallMapType map_type
Currently displayed legends.
Definition: smallmap_gui.h:63
SmallMapWindow::LEGEND_BLOB_WIDTH
static const uint LEGEND_BLOB_WIDTH
Width of the coloured blob in front of a line text in the WID_SM_LEGEND widget.
Definition: smallmap_gui.h:67
guitimer_func.h
company_base.h
SmallMapWindow::ZLC_ZOOM_IN
@ ZLC_ZOOM_IN
Zoom in.
Definition: smallmap_gui.h:60
SmallMapWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: smallmap_gui.cpp:1184
Blitter
How all blitters should look like.
Definition: base.hpp:28
Station
Station data structure.
Definition: station_base.h:450
SmallMapWindow::SmallMapCenterOnCurrentPos
void SmallMapCenterOnCurrentPos()
Center the small map on the current center of the viewport.
Definition: smallmap_gui.cpp:1652
SmallMapWindow::DrawHorizMapIndicator
static void DrawHorizMapIndicator(int x, int x2, int y)
Draws horizontal part of map indicator.
Definition: smallmap_gui.h:105
LegendAndColour::company
CompanyID company
Company to display. Only valid for company entries of the owner legend.
Definition: smallmap_gui.h:36
SmallMapWindow::OnRightClick
bool OnRightClick(Point pt, int widget) override
A click with the right mouse button has been made on the window.
Definition: smallmap_gui.cpp:1560
SmallMapWindow::GetOverlayCompanyMask
uint32 GetOverlayCompanyMask() const
Get a bitmask for company links to be displayed.
Definition: smallmap_gui.h:145
SmallMapWindow::SetupWidgetData
void SetupWidgetData()
Function to set up widgets depending on the information being shown on the smallmap.
Definition: smallmap_gui.cpp:1032
SmallMapWindow::GetTileColours
uint32 GetTileColours(const TileArea &ta) const
Decide which colours to show to the user for a group of tiles.
Definition: smallmap_gui.cpp:746
SmallMapWindow::zoom
int zoom
Zoom level. Bigger number means more zoom-out (further away).
Definition: smallmap_gui.h:79
SmallMapWindow::SwitchMapType
void SwitchMapType(SmallMapType map_type)
Select a new map type.
Definition: smallmap_gui.cpp:1300
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
NWidgetSmallmapDisplay
Custom container class for displaying smallmap with a vertically resizing legend panel.
Definition: smallmap_gui.cpp:1695
SmallMapWindow::OnInit
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: smallmap_gui.cpp:1134
SmallMapWindow::column_width
uint column_width
Width of a column in the WID_SM_LEGEND widget.
Definition: smallmap_gui.h:74
SmallMapWindow::min_number_of_columns
uint min_number_of_columns
Minimal number of columns in legends.
Definition: smallmap_gui.h:72
SmallMapWindow::scroll_x
int32 scroll_x
Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.
Definition: smallmap_gui.h:76
SmallMapWindow
Class managing the smallmap window.
Definition: smallmap_gui.h:43
SmallMapWindow::show_towns
static bool show_towns
Display town names in the smallmap.
Definition: smallmap_gui.h:64
SmallMapWindow::GetNumberColumnsLegend
uint GetNumberColumnsLegend(uint width) const
Return number of columns that can be displayed in width pixels.
Definition: smallmap_gui.h:124
SmallMapWindow::DrawSmallMap
void DrawSmallMap(DrawPixelInfo *dpi) const
Draws the small map.
Definition: smallmap_gui.cpp:968
SmallMapWindow::GetStationMiddle
Point GetStationMiddle(const Station *st) const
Get the center of the given station as point on the screen in the smallmap window.
Definition: smallmap_gui.cpp:1670
SmallMapWindow::SetZoomLevel
void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
Initialize or change the zoom level.
Definition: smallmap_gui.cpp:697
WindowDesc
High level window description.
Definition: window_gui.h:166
SmallMapWindow::ComputeScroll
Point ComputeScroll(int tx, int ty, int x, int y, int *sub)
Compute base parameters of the smallmap such that tile (tx, ty) starts at pixel (x,...
Definition: smallmap_gui.cpp:669
window_gui.h
PC_VERY_LIGHT_YELLOW
static const uint8 PC_VERY_LIGHT_YELLOW
Almost-white yellow palette colour.
Definition: gfx_func.h:221
SmallMapWindow::GetMinLegendWidth
uint GetMinLegendWidth() const
Compute minimal required width of the legends.
Definition: smallmap_gui.h:115
LinkGraphOverlay
Handles drawing of links into some window.
Definition: linkgraph_gui.h:37
GUITimer
Definition: guitimer_func.h:13
SmallMapWindow::ZoomLevelChange
ZoomLevelChange
Available kinds of zoomlevel changes.
Definition: smallmap_gui.h:57
SmallMapWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: smallmap_gui.cpp:1531
SmallMapWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: smallmap_gui.cpp:1415
SmallMapWindow::GetNumberRowsLegend
uint GetNumberRowsLegend(uint columns) const
Get the number of rows in the legend from the number of columns.
Definition: smallmap_gui.cpp:1321
smallmap_widget.h
SmallMapWindow::ZLC_ZOOM_OUT
@ ZLC_ZOOM_OUT
Zoom out.
Definition: smallmap_gui.h:59
SmallMapWindow::DrawVehicles
void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
Adds vehicles to the smallmap.
Definition: smallmap_gui.cpp:875
BuildLinkStatsLegend
void BuildLinkStatsLegend()
Populate legend table for the link stat view.
Definition: smallmap_gui.cpp:198
SmallMapWindow::DrawVertMapIndicator
static void DrawVertMapIndicator(int x, int y, int y2)
Draws vertical part of map indicator.
Definition: smallmap_gui.h:93
ShowSmallMap
void ShowSmallMap()
Show the smallmap window.
Definition: smallmap_gui.cpp:1856
LegendAndColour::col_break
bool col_break
Perform a column break and go further at the next column.
Definition: smallmap_gui.h:39
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
SmallMapWindow::DrawMapIndicators
void DrawMapIndicators() const
Adds map indicators to the smallmap.
Definition: smallmap_gui.cpp:936
WD_FRAMERECT_BOTTOM
@ WD_FRAMERECT_BOTTOM
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:63
SmallMapWindow::max_heightlevel
static int max_heightlevel
Currently used/cached maximum heightlevel.
Definition: smallmap_gui.h:65
BuildLandLegend
void BuildLandLegend()
(Re)build the colour tables for the legends.
Definition: smallmap_gui.cpp:274
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:16
linkgraph_gui.h
SmallMapWindow::GetPositionOnLegend
int GetPositionOnLegend(Point pt)
Determines the mouse position on the legend.
Definition: smallmap_gui.cpp:1382
LegendAndColour::legend
StringID legend
String corresponding to the coloured item.
Definition: smallmap_gui.h:33
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
BuildOwnerLegend
void BuildOwnerLegend()
Completes the array for the owned property legend.
Definition: smallmap_gui.cpp:325
BuildIndustriesLegend
void BuildIndustriesLegend()
Fills an array for the industries legends.
Definition: smallmap_gui.cpp:168
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
SmallMapWindow::SmallMapType
SmallMapType
Types of legends in the WID_SM_LEGEND widget.
Definition: smallmap_gui.h:46
industry_type.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:114
SmallMapWindow::DrawSmallMapColumn
void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const
Draws one column of tiles of the small map in a certain mode onto the screen buffer,...
Definition: smallmap_gui.cpp:835
SmallMapWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: smallmap_gui.cpp:1200
SmallMapWindow::BreakIndustryChainLink
static void BreakIndustryChainLink()
Notify the industry chain window to stop sending newly selected industries.
Definition: smallmap_gui.cpp:594
FONT_HEIGHT_SMALL
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:176
SmallMapWindow::OnRealtimeTick
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition: smallmap_gui.cpp:1581
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
SmallMapWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: smallmap_gui.cpp:1125
SmallMapWindow::subscroll
int32 subscroll
Number of pixels (0..3) between the right end of the base tile and the pixel at the top-left corner o...
Definition: smallmap_gui.h:78
SmallMapWindow::OnScroll
void OnScroll(Point delta) override
Handle the request for (viewport) scrolling.
Definition: smallmap_gui.cpp:1637
strings_func.h
SmallMapWindow::OnMouseOver
void OnMouseOver(Point pt, int widget) override
The mouse is currently moving over the window or has just moved outside of the window.
Definition: smallmap_gui.cpp:1398
SmallMapWindow::SetOverlayCargoMask
void SetOverlayCargoMask()
Set the link graph overlay cargo mask from the legend.
Definition: smallmap_gui.cpp:1368
SmallMapWindow::SetNewScroll
void SetNewScroll(int sx, int sy, int sub)
Set new scroll_x, scroll_y, and subscroll values after limiting them such that the center of the smal...
Definition: smallmap_gui.cpp:1607
SmallMapWindow::INDUSTRY_MIN_NUMBER_OF_COLUMNS
static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS
Minimal number of columns in the WID_SM_LEGEND widget for the #SMT_INDUSTRY legend.
Definition: smallmap_gui.h:68
LegendAndColour::height
uint8 height
Height in tiles. Only valid for height legend entries.
Definition: smallmap_gui.h:35
LegendAndColour::colour
uint8 colour
Colour of the item on the map.
Definition: smallmap_gui.h:32
LegendAndColour::show_on_map
bool show_on_map
For filtering industries, if true, industry is shown on the map in colour.
Definition: smallmap_gui.h:37
SmallMapWindow::DrawTowns
void DrawTowns(const DrawPixelInfo *dpi) const
Adds town names to the smallmap.
Definition: smallmap_gui.cpp:913
SmallMapWindow::RemapTile
Point RemapTile(int tile_x, int tile_y) const
Remap tile to location on this smallmap.
Definition: smallmap_gui.cpp:613
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:319
SmallMapWindow::refresh
GUITimer refresh
Refresh timer.
Definition: smallmap_gui.h:81
SmallMapWindow::scroll_y
int32 scroll_y
Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.
Definition: smallmap_gui.h:77
Window
Data structure for an opened window.
Definition: window_gui.h:276
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:318
SmallMapWindow::SelectLegendItem
void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item=0)
Select and toggle a legend item.
Definition: smallmap_gui.cpp:1340
SmallMapWindow::RebuildColourIndexIfNecessary
void RebuildColourIndexIfNecessary()
Rebuilds the colour indices used for fast access to the smallmap contour colours based on the heightl...
Definition: smallmap_gui.cpp:1103
SmallMapWindow::ZLC_INITIALIZE
@ ZLC_INITIALIZE
Initialize zoom level.
Definition: smallmap_gui.h:58
LegendAndColour
Structure for holding relevant data for legends in small map.
Definition: smallmap_gui.h:31
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
LegendAndColour::end
bool end
This is the end of the list.
Definition: smallmap_gui.h:38
SmallMapWindow::PixelToTile
Point PixelToTile(int px, int py, int *sub, bool add_sub=true) const
Determine the tile relative to the base tile of the smallmap, and the pixel position at that tile for...
Definition: smallmap_gui.cpp:637
SmallMapWindow::FORCE_REFRESH_PERIOD
static const uint FORCE_REFRESH_PERIOD
map is redrawn after that many milliseconds.
Definition: smallmap_gui.h:69
SmallMapWindow::GetLegendHeight
uint GetLegendHeight(uint num_columns) const
Compute height given a number of columns.
Definition: smallmap_gui.h:134
SmallMapWindow::OnMouseWheel
void OnMouseWheel(int wheel) override
The mouse wheel has been turned.
Definition: smallmap_gui.cpp:1568
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155
SmallMapWindow::BLINK_PERIOD
static const uint BLINK_PERIOD
highlight blinking interval in milliseconds.
Definition: smallmap_gui.h:70