Class managing the smallmap window. More...
Public Member Functions | |
SmallMapWindow (const WindowDesc *desc, int window_number) | |
uint | GetMinLegendWidth () const |
Compute minimal required width of the legends. | |
uint | GetNumberColumnsLegend (uint width) const |
Return number of columns that can be displayed in width pixels. | |
uint | GetLegendHeight (uint num_columns) const |
Compute height given a number of columns. | |
virtual void | SetStringParameters (int widget) const |
Initialize string parameters for a widget. | |
virtual void | OnInit () |
Notification that the nested widget tree gets initialized. | |
virtual void | OnPaint () |
The window must be repainted. | |
virtual void | DrawWidget (const Rect &r, int widget) const |
Draw the contents of a nested widget. | |
void | SwitchMapType (SmallMapType map_type) |
Select a new map type. | |
virtual void | OnClick (Point pt, int widget, int click_count) |
A click with the left mouse button has been made on the window. | |
virtual void | OnInvalidateData (int data=0, bool gui_scope=true) |
Some data on this window has become invalid. | |
virtual bool | OnRightClick (Point pt, int widget) |
A click with the right mouse button has been made on the window. | |
virtual void | OnMouseWheel (int wheel) |
The mouse wheel has been turned. | |
virtual void | OnTick () |
Called once per (game) tick. | |
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 smallmap always contains a part of the map. | |
virtual void | OnScroll (Point delta) |
Handle the request for (viewport) scrolling. | |
void | SmallMapCenterOnCurrentPos () |
Data Fields | |
uint | min_number_of_columns |
Minimal number of columns in legends. | |
Private Types | |
enum | SmallMapType { SMT_CONTOUR, SMT_VEHICLES, SMT_INDUSTRY, SMT_ROUTES, SMT_VEGETATION, SMT_OWNER } |
Types of legends in the WID_SM_LEGEND widget. More... | |
enum | ZoomLevelChange { ZLC_INITIALIZE, ZLC_ZOOM_OUT, ZLC_ZOOM_IN } |
Available kinds of zoomlevel changes. More... | |
Private Member Functions | |
Point | SmallmapRemapCoords (int x, int y) const |
Point | RemapTile (int tile_x, int tile_y) const |
Remap tile to location on this smallmap. | |
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 a point in the smallmap. | |
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, y). | |
void | SetZoomLevel (ZoomLevelChange change, const Point *zoom_pt) |
Initialize or change the zoom level. | |
uint32 | GetTileColours (const TileArea &ta) const |
Decide which colours to show to the user for a group of tiles. | |
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, skipping the shifted rows in between. | |
void | DrawVehicles (const DrawPixelInfo *dpi, Blitter *blitter) const |
Adds vehicles to the smallmap. | |
void | DrawTowns (const DrawPixelInfo *dpi) const |
Adds town names to the smallmap. | |
void | DrawMapIndicators () const |
Adds map indicators to the smallmap. | |
void | DrawSmallMap (DrawPixelInfo *dpi) const |
Draws the small map. | |
void | SetupWidgetData () |
Function to set up widgets depending on the information being shown on the smallmap. | |
Static Private Member Functions | |
static void | DrawVertMapIndicator (int x, int y, int y2) |
Draws vertical part of map indicator. | |
static void | DrawHorizMapIndicator (int x, int x2, int y) |
Draws horizontal part of map indicator. | |
Private Attributes | |
uint | min_number_of_fixed_rows |
Minimal number of rows in the legends for the fixed layouts only (all except SMT_INDUSTRY). | |
uint | column_width |
Width of a column in the WID_SM_LEGEND widget. | |
int32 | scroll_x |
Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display. | |
int32 | scroll_y |
Vertical world coordinate of the base tile left of the top-left corner of the smallmap display. | |
int32 | subscroll |
Number of pixels (0..3) between the right end of the base tile and the pixel at the top-left corner of the smallmap display. | |
int | zoom |
Zoom level. Bigger number means more zoom-out (further away). | |
uint8 | refresh |
refresh counter, zeroed every FORCE_REFRESH_PERIOD ticks | |
Static Private Attributes | |
static SmallMapType | map_type = SMT_CONTOUR |
Currently displayed legends. | |
static bool | show_towns = true |
Display town names in the smallmap. | |
static const uint | LEGEND_BLOB_WIDTH = 8 |
Width of the coloured blob in front of a line text in the WID_SM_LEGEND widget. | |
static const uint | INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2 |
Minimal number of columns in the WID_SM_LEGEND widget for the SMT_INDUSTRY legend. | |
static const uint8 | FORCE_REFRESH_PERIOD = 0x1F |
map is redrawn after that many ticks |
Class managing the smallmap window.
Definition at line 567 of file smallmap_gui.cpp.
enum SmallMapWindow::SmallMapType [private] |
Types of legends in the WID_SM_LEGEND widget.
Definition at line 569 of file smallmap_gui.cpp.
enum SmallMapWindow::ZoomLevelChange [private] |
Available kinds of zoomlevel changes.
Definition at line 579 of file smallmap_gui.cpp.
Point SmallMapWindow::ComputeScroll | ( | int | tx, | |
int | ty, | |||
int | x, | |||
int | y, | |||
int * | sub | |||
) | [inline, private] |
Compute base parameters of the smallmap such that tile (tx, ty) starts at pixel (x, y).
tx | Tile x coordinate. | |
ty | Tile y coordinate. | |
x | Non-negative horizontal position in the display where the tile starts. | |
y | Non-negative vertical position in the display where the tile starts. | |
sub | [out] Value of subscroll needed. |
Definition at line 671 of file smallmap_gui.cpp.
References PixelToTile(), TILE_SIZE, and zoom.
static void SmallMapWindow::DrawHorizMapIndicator | ( | int | x, | |
int | x2, | |||
int | y | |||
) | [inline, static, private] |
Draws horizontal part of map indicator.
x | X coord of left border of main viewport | |
x2 | X coord of right border of main viewport | |
y | Y coord of top/bottom border of main viewport |
Definition at line 915 of file smallmap_gui.cpp.
References GfxFillRect(), and PC_VERY_LIGHT_YELLOW.
Referenced by DrawMapIndicators().
void SmallMapWindow::DrawSmallMap | ( | DrawPixelInfo * | dpi | ) | const [inline, private] |
Draws the small map.
Basically, the small map is draw column of pixels by column of pixels. The pixels are drawn directly into the screen buffer. The final map is drawn in multiple passes. The passes are:
dpi | pointer to pixel to write onto |
Definition at line 955 of file smallmap_gui.cpp.
References DrawMapIndicators(), DrawSmallMapColumn(), DrawTowns(), DrawVehicles(), BlitterFactoryBase::GetCurrentBlitter(), GfxFillRect(), map_type, min(), Blitter::MoveTo(), PC_BLACK, PixelToTile(), scroll_x, show_towns, TILE_SIZE, and zoom.
Referenced by DrawWidget().
void SmallMapWindow::DrawSmallMapColumn | ( | void * | dst, | |
uint | xc, | |||
uint | yc, | |||
int | pitch, | |||
int | reps, | |||
int | start_pos, | |||
int | end_pos, | |||
Blitter * | blitter | |||
) | const [inline, private] |
Draws one column of tiles of the small map in a certain mode onto the screen buffer, skipping the shifted rows in between.
dst | Pointer to a part of the screen buffer to write to. | |
xc | The X coordinate of the first tile in the column. | |
yc | The Y coordinate of the first tile in the column | |
pitch | Number of pixels to advance in the screen buffer each time a pixel is written. | |
reps | Number of lines to draw | |
start_pos | Position of first pixel to draw. | |
end_pos | Position of last pixel to draw (exclusive). | |
blitter | current blitter |
0
, skip drawing. Definition at line 797 of file smallmap_gui.cpp.
References _settings_game, TileArea::ClampToMap(), GameSettings::construction, ConstructionSettings::freeform_edges, GetTileColours(), MapMaxX(), MapMaxY(), max(), Blitter::MoveTo(), Blitter::SetPixel(), TileXY(), and zoom.
Referenced by DrawSmallMap().
void SmallMapWindow::DrawTowns | ( | const DrawPixelInfo * | dpi | ) | const [inline, private] |
Adds town names to the smallmap.
dpi | the part of the smallmap to be drawn into |
Definition at line 876 of file smallmap_gui.cpp.
References Town::cache, DrawString(), FONT_HEIGHT_SMALL, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Window::left, RemapTile(), SetDParam(), TownCache::sign, subscroll, TileX(), TileY(), Window::top, ViewportSign::width_small, and Town::xy.
Referenced by DrawSmallMap().
void SmallMapWindow::DrawVehicles | ( | const DrawPixelInfo * | dpi, | |
Blitter * | blitter | |||
) | const [inline, private] |
Adds vehicles to the smallmap.
dpi | the part of the smallmap to be drawn into | |
blitter | current blitter |
Definition at line 837 of file smallmap_gui.cpp.
References FOR_ALL_VEHICLES, IsInsideMM(), map_type, PC_WHITE, RemapTile(), Blitter::SetPixel(), subscroll, TILE_SIZE, BaseVehicle::type, VEH_EFFECT, Vehicle::vehstatus, VS_HIDDEN, VS_UNCLICKABLE, Vehicle::x_pos, and Vehicle::y_pos.
Referenced by DrawSmallMap().
static void SmallMapWindow::DrawVertMapIndicator | ( | int | x, | |
int | y, | |||
int | y2 | |||
) | [inline, static, private] |
Draws vertical part of map indicator.
x | X coord of left/right border of main viewport | |
y | Y coord of top border of main viewport | |
y2 | Y coord of bottom border of main viewport |
Definition at line 903 of file smallmap_gui.cpp.
References GfxFillRect(), and PC_VERY_LIGHT_YELLOW.
Referenced by DrawMapIndicators().
virtual void SmallMapWindow::DrawWidget | ( | const Rect & | r, | |
int | widget | |||
) | const [inline, virtual] |
Draw the contents of a nested widget.
r | Rectangle occupied by the widget. | |
widget | Number of the widget to draw. |
Reimplemented from Window.
Definition at line 1171 of file smallmap_gui.cpp.
References _current_text_dir, _smallmap_company_count, _smallmap_industry_count, CeilDiv(), column_width, DrawSmallMap(), DrawString(), LegendAndColour::end, FillDrawPixelInfo(), Industry::GetIndustryTypeCount(), GetNumberColumnsLegend(), GfxFillRect(), INVALID_COMPANY, LEGEND_BLOB_WIDTH, map_type, max(), min_number_of_fixed_rows, PC_BLACK, SetDParam(), TILE_HEIGHT_STEP, WD_FRAMERECT_RIGHT, WID_SM_LEGEND, and WID_SM_MAP.
uint SmallMapWindow::GetLegendHeight | ( | uint | num_columns | ) | const [inline] |
Compute height given a number of columns.
num_columns | Number of columns. |
Definition at line 1093 of file smallmap_gui.cpp.
References _smallmap_company_count, _smallmap_industry_count, CeilDiv(), max(), min_number_of_fixed_rows, WD_FRAMERECT_BOTTOM, and WD_FRAMERECT_TOP.
Referenced by NWidgetSmallmapDisplay::SetupSmallestSize().
uint SmallMapWindow::GetMinLegendWidth | ( | ) | const [inline] |
Compute minimal required width of the legends.
Definition at line 1074 of file smallmap_gui.cpp.
References column_width, min_number_of_columns, and WD_FRAMERECT_LEFT.
Referenced by NWidgetSmallmapDisplay::SetupSmallestSize().
uint SmallMapWindow::GetNumberColumnsLegend | ( | uint | width | ) | const [inline] |
Return number of columns that can be displayed in width pixels.
Definition at line 1083 of file smallmap_gui.cpp.
References column_width.
Referenced by DrawWidget(), and OnClick().
uint32 SmallMapWindow::GetTileColours | ( | const TileArea & | ta | ) | const [inline, private] |
Decide which colours to show to the user for a group of tiles.
ta | Tile area to investigate. |
Definition at line 745 of file smallmap_gui.cpp.
References GetSmallMapContoursPixels(), GetSmallMapIndustriesPixels(), GetSmallMapOwnerPixels(), GetSmallMapRoutesPixels(), GetSmallMapVegetationPixels(), GetSmallMapVehiclesPixels(), INVALID_TILE, map_type, and TILE_AREA_LOOP.
Referenced by DrawSmallMapColumn().
virtual void SmallMapWindow::OnClick | ( | Point | pt, | |
int | widget, | |||
int | click_count | |||
) | [inline, virtual] |
A click with the left mouse button has been made on the window.
pt | the point inside the window that has been clicked. | |
widget | the clicked widget. | |
click_count | Number of fast consecutive clicks at same position |
Reimplemented from Window.
Definition at line 1258 of file smallmap_gui.cpp.
References _ctrl_pressed, _current_text_dir, _left_button_clicked, _smallmap_company_count, _smallmap_industry_count, _smallmap_show_heightmap, CeilDiv(), column_width, NWidgetBase::current_x, NWidgetBase::current_y, FindWindowById(), FONT_HEIGHT_SMALL, GetNumberColumnsLegend(), Window::HandleButtonClick(), INVALID_VEHICLE, InvalidateWindowClassesData(), map_type, max(), min_number_of_fixed_rows, NUM_INDUSTRYTYPES, NUM_NO_COMPANY_ENTRIES, PixelToTile(), NWidgetBase::pos_x, NWidgetBase::pos_y, RemapCoords(), scroll_x, Window::SetDirty(), Window::SetWidgetLoweredState(), SetZoomLevel(), LegendAndColour::show_on_map, show_towns, SwitchMapType(), TILE_SIZE, WC_INDUSTRY_CARGOES, WC_MAIN_WINDOW, WID_SM_CENTERMAP, WID_SM_CONTOUR, WID_SM_DISABLE_ALL, WID_SM_ENABLE_ALL, WID_SM_INDUSTRIES, WID_SM_LEGEND, WID_SM_MAP, WID_SM_OWNERS, WID_SM_ROUTES, WID_SM_SHOW_HEIGHT, WID_SM_TOGGLETOWNNAME, WID_SM_VEGETATION, WID_SM_VEHICLES, WID_SM_ZOOM_IN, WID_SM_ZOOM_OUT, ZLC_ZOOM_IN, and ZLC_ZOOM_OUT.
virtual void SmallMapWindow::OnInit | ( | ) | [inline, virtual] |
Notification that the nested widget tree gets initialized.
The event can be used to perform general computations.
Reimplemented from Window.
Definition at line 1108 of file smallmap_gui.cpp.
References BuildOwnerLegend(), column_width, LegendAndColour::end, GetStringBoundingBox(), Window::height, INDUSTRY_MIN_NUMBER_OF_COLUMNS, INVALID_COMPANY, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), LEGEND_BLOB_WIDTH, lengthof, max(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::MAX_SIZE, min_number_of_columns, min_number_of_fixed_rows, SetDParam(), WD_FRAMERECT_LEFT, and Window::width.
virtual void SmallMapWindow::OnInvalidateData | ( | int | data = 0 , |
|
bool | gui_scope = true | |||
) | [inline, virtual] |
Some data on this window has become invalid.
data | Information about the changed data.
| |
gui_scope | Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See InvalidateWindowData() for details. |
Reimplemented from Window.
Definition at line 1432 of file smallmap_gui.cpp.
References _displayed_industries, _smallmap_industry_count, HasBit(), map_type, Window::ReInit(), Window::SetDirty(), LegendAndColour::show_on_map, and SwitchMapType().
virtual void SmallMapWindow::OnMouseWheel | ( | int | wheel | ) | [inline, virtual] |
The mouse wheel has been turned.
wheel | the amount of movement of the mouse wheel. |
Reimplemented from Window.
Definition at line 1464 of file smallmap_gui.cpp.
References _settings_client, NWidgetBase::current_x, NWidgetBase::current_y, ClientSettings::gui, IsInsideMM(), Window::left, NWidgetBase::pos_x, NWidgetBase::pos_y, GUISettings::scrollwheel_scrolling, SetZoomLevel(), Window::top, ZLC_ZOOM_IN, and ZLC_ZOOM_OUT.
virtual void SmallMapWindow::OnPaint | ( | ) | [inline, virtual] |
The window must be repainted.
Reimplemented from Window.
Definition at line 1155 of file smallmap_gui.cpp.
References BuildOwnerLegend(), Window::DrawWidgets(), LegendAndColour::end, INVALID_COMPANY, Window::InvalidateData(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), and map_type.
virtual bool SmallMapWindow::OnRightClick | ( | Point | pt, | |
int | widget | |||
) | [inline, virtual] |
A click with the right mouse button has been made on the window.
pt | the point inside the window that has been clicked. | |
widget | the clicked widget. |
Reimplemented from Window.
Definition at line 1456 of file smallmap_gui.cpp.
References _scrolling_viewport, and WID_SM_MAP.
virtual void SmallMapWindow::OnScroll | ( | Point | delta | ) | [inline, virtual] |
Handle the request for (viewport) scrolling.
delta | the amount the viewport must be scrolled. |
Reimplemented from Window.
Definition at line 1522 of file smallmap_gui.cpp.
References CursorVars::fix_at, PixelToTile(), scroll_x, Window::SetDirty(), SetNewScroll(), and TILE_SIZE.
Point SmallMapWindow::PixelToTile | ( | int | px, | |
int | py, | |||
int * | sub, | |||
bool | add_sub = true | |||
) | const [inline, private] |
Determine the tile relative to the base tile of the smallmap, and the pixel position at that tile for a point in the smallmap.
px | Horizontal coordinate of the pixel. | |
py | Vertical coordinate of the pixel. | |
sub[out] | Pixel position at the tile (0..3). | |
add_sub | Add current subscroll to the position. |
Definition at line 639 of file smallmap_gui.cpp.
References subscroll, and zoom.
Referenced by ComputeScroll(), DrawSmallMap(), OnClick(), OnScroll(), and SetZoomLevel().
Point SmallMapWindow::RemapTile | ( | int | tile_x, | |
int | tile_y | |||
) | const [inline, private] |
Remap tile to location on this smallmap.
tile_x | X coordinate of the tile. | |
tile_y | Y coordinate of the tile. |
Definition at line 615 of file smallmap_gui.cpp.
References scroll_x, scroll_y, TILE_SIZE, and zoom.
Referenced by DrawMapIndicators(), DrawTowns(), and DrawVehicles().
void SmallMapWindow::SetNewScroll | ( | int | sx, | |
int | sy, | |||
int | sub | |||
) | [inline] |
Set new scroll_x, scroll_y, and subscroll values after limiting them such that the center of the smallmap always contains a part of the map.
Definition at line 1493 of file smallmap_gui.cpp.
References NWidgetBase::current_x, NWidgetBase::current_y, InverseRemapCoords(), MapMaxX(), MapMaxY(), scroll_x, scroll_y, subscroll, TILE_SIZE, and zoom.
Referenced by OnScroll(), and SetZoomLevel().
virtual void SmallMapWindow::SetStringParameters | ( | int | widget | ) | const [inline, virtual] |
Initialize string parameters for a widget.
Calls to this function are made during initialization to measure the size (that is as part of InitNested()), during drawing, and while re-initializing the window. Only for widgets that render text initializing is requested.
widget | Widget number. |
Reimplemented from Window.
Definition at line 1099 of file smallmap_gui.cpp.
References map_type, SetDParam(), and WID_SM_CAPTION.
void SmallMapWindow::SetZoomLevel | ( | ZoomLevelChange | change, | |
const Point * | zoom_pt | |||
) | [inline, private] |
Initialize or change the zoom level.
change | Way to change the zoom level. | |
zoom_pt | Position to keep fixed while zooming. |
*zoom_pt
should contain a point in the smallmap display when zooming in or out. Definition at line 699 of file smallmap_gui.cpp.
References Clamp(), lengthof, PixelToTile(), scroll_x, Window::SetDirty(), SetNewScroll(), Window::SetWidgetDisabledState(), TILE_SIZE, WID_SM_ZOOM_IN, WID_SM_ZOOM_OUT, ZLC_INITIALIZE, ZLC_ZOOM_IN, ZLC_ZOOM_OUT, and zoom.
Referenced by OnClick(), and OnMouseWheel().
void SmallMapWindow::SwitchMapType | ( | SmallMapType | map_type | ) | [inline] |
Select a new map type.
map_type | New map type. |
Definition at line 1247 of file smallmap_gui.cpp.
References Window::LowerWidget(), Window::RaiseWidget(), Window::SetDirty(), SetupWidgetData(), and WID_SM_CONTOUR.
Referenced by OnClick(), and OnInvalidateData().