Class managing the smallmap window. More...

Inheritance diagram for SmallMapWindow:

Public Member Functions
	SmallMapWindow (WindowDesc &desc, int window_number)

void	SmallMapCenterOnCurrentPos ()
	Center the small map on the current center of the viewport.

Point	GetStationMiddle (const Station *st) const
	Get the center of the given station as point on the screen in the smallmap window. More...

void	Close ([[maybe_unused]] int data) override

void	SetStringParameters (WidgetID widget) const override

void	OnInit () override
	Notification that the nested widget tree gets initialized. More...

void	OnPaint () override
	The window must be repainted. More...

void	DrawWidget (const Rect &r, WidgetID widget) const override

void	OnClick ([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override

void	OnInvalidateData (int data=0, bool gui_scope=true) override
	Some data on this window has become invalid. More...

bool	OnRightClick (Point, WidgetID widget) override

void	OnMouseWheel (int wheel) override

void	OnScroll (Point delta) override

void	OnMouseOver ([[maybe_unused]] Point pt, WidgetID widget) override

Public Member Functions inherited from Window
	Window (WindowDesc &desc)
	Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class. More...

void *	operator new[] (size_t size)=delete
	Helper allocation function to disallow something. More...

template<class NWID >
const NWID *	GetWidget (WidgetID widnum) const
	Get the nested widget with number widnum from the nested widget tree. More...

template<class NWID >
NWID *	GetWidget (WidgetID widnum)
	Get the nested widget with number widnum from the nested widget tree. More...

const Scrollbar *	GetScrollbar (WidgetID widnum) const
	Return the Scrollbar to a widget index. More...

Scrollbar *	GetScrollbar (WidgetID widnum)
	Return the Scrollbar to a widget index. More...

const QueryString *	GetQueryString (WidgetID widnum) const
	Return the querystring associated to a editbox. More...

QueryString *	GetQueryString (WidgetID widnum)
	Return the querystring associated to a editbox. More...

void	UpdateQueryStringSize ()
	Update size of all QueryStrings of this window.

virtual const struct Textbuf *	GetFocusedTextbuf () const
	Get the current input text buffer. More...

virtual Point	GetCaretPosition () const
	Get the current caret position if an edit box has the focus. More...

virtual Rect	GetTextBoundingRect (const char from, const char to) const
	Get the bounding rectangle for a text range if an edit box has the focus. More...

virtual ptrdiff_t	GetTextCharacterAtPosition (const Point &pt) const
	Get the character that is rendered at a position by the focused edit box. More...

void	InitNested (WindowNumber number=0)
	Perform complete initialization of the Window with nested widgets, to allow use. More...

void	CreateNestedTree ()
	Perform the first part of the initialization of a nested widget tree. More...

void	FinishInitNested (WindowNumber window_number=0)
	Perform the second part of the initialization of a nested widget tree. More...

template<typename T , std::enable_if_t< std::is_base_of< StrongTypedefBase, T >::value, int > = 0>
void	FinishInitNested (T number)

void	SetTimeout ()
	Set the timeout flag of the window and initiate the timer.

void	SetWhiteBorder ()
	Set the timeout flag of the window and initiate the timer.

void	DisableAllWidgetHighlight ()
	Disable the highlighted status of all widgets.

void	SetWidgetHighlight (WidgetID widget_index, TextColour highlighted_colour)
	Sets the highlighted status of a widget. More...

bool	IsWidgetHighlighted (WidgetID widget_index) const
	Gets the highlighted status of a widget. More...

void	SetWidgetDisabledState (WidgetID widget_index, bool disab_stat)
	Sets the enabled/disabled status of a widget. More...

void	DisableWidget (WidgetID widget_index)
	Sets a widget to disabled. More...

void	EnableWidget (WidgetID widget_index)
	Sets a widget to Enabled. More...

bool	IsWidgetDisabled (WidgetID widget_index) const
	Gets the enabled/disabled status of a widget. More...

bool	IsWidgetFocused (WidgetID widget_index) const
	Check if given widget is focused within this window. More...

bool	IsWidgetGloballyFocused (WidgetID widget_index) const
	Check if given widget has user input focus. More...

void	SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat)
	Sets the lowered/raised status of a widget. More...

void	ToggleWidgetLoweredState (WidgetID widget_index)
	Invert the lowered/raised status of a widget. More...

void	LowerWidget (WidgetID widget_index)
	Marks a widget as lowered. More...

void	RaiseWidget (WidgetID widget_index)
	Marks a widget as raised. More...

void	RaiseWidgetWhenLowered (WidgetID widget_index)
	Marks a widget as raised and dirty (redraw), when it is marked as lowered. More...

bool	IsWidgetLowered (WidgetID widget_index) const
	Gets the lowered state of a widget. More...

void	UnfocusFocusedWidget ()
	Makes no widget on this window have focus. More...

bool	SetFocusedWidget (WidgetID widget_index)
	Set focus within this window to the given widget. More...

EventState	HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode)
	Process keypress for editbox widget. More...

virtual void	InsertTextString (WidgetID wid, const char str, bool marked, const char caret, const char insert_location, const char replacement_end)
	Insert a text string at the cursor position into the edit box widget. More...

void	HandleButtonClick (WidgetID widget)
	Do all things to make a button look clicked and mark it to be unclicked in a few ticks. More...

int	GetRowFromWidget (int clickpos, WidgetID widget, int padding, int line_height=-1) const
	Compute the row of a widget that a user clicked in. More...

void	RaiseButtons (bool autoraise=false)
	Raise the buttons of the window. More...

template<typename... Args>
void	SetWidgetsDisabledState (bool disab_stat, Args... widgets)
	Sets the enabled/disabled status of a list of widgets. More...

template<typename... Args>
void	SetWidgetsLoweredState (bool lowered_stat, Args... widgets)
	Sets the lowered/raised status of a list of widgets. More...

template<typename... Args>
void	RaiseWidgetsWhenLowered (Args... widgets)
	Raises the widgets and sets widgets dirty that are lowered. More...

void	SetWidgetDirty (WidgetID widget_index) const
	Invalidate a widget, i.e. More...

void	DrawWidgets () const
	Paint all widgets of a window.

void	DrawViewport () const
	Draw the viewport of this window.

void	DrawSortButtonState (WidgetID widget, SortButtonState state) const
	Draw a sort button's up or down arrow symbol. More...

Window *	FindChildWindow (WindowClass wc=WC_INVALID) const
	Find the Window whose parent pointer points to this window. More...

void	CloseChildWindows (WindowClass wc=WC_INVALID) const
	Close all children a window might have in a head-recursive manner. More...

virtual void	Close (int data=0)
	Hide the window and all its child windows, and mark them for a later deletion.

void	SetDirty () const
	Mark entire window as dirty (in need of re-paint)

void	ReInit (int rx=0, int ry=0, bool reposition=false)
	Re-initialize a window, and optionally change its size. More...

bool	IsShaded () const
	Is window shaded currently?

void	SetShaded (bool make_shaded)
	Set the shaded state of the window to make_shaded. More...

void	ScheduleResize ()
	Mark this window as resized and in need of OnResize() event.

void	ProcessScheduledResize ()
	Process scheduled OnResize() event.

void	InvalidateData (int data=0, bool gui_scope=true)
	Mark this window's data as invalid (in need of re-computing) More...

void	ProcessScheduledInvalidations ()
	Process all scheduled invalidations.

void	ProcessHighlightedInvalidations ()
	Process all invalidation of highlighted widgets.

virtual void	ApplyDefaults ()
	Read default values from WindowDesc configuration an apply them to the window.

virtual Point	OnInitialPosition (int16_t sm_width, int16_t sm_height, int window_number)
	Compute the initial position of the window. More...

virtual void	DrawWidget ([[maybe_unused]] const Rect &r, [[maybe_unused]] WidgetID widget) const
	Draw the contents of a nested widget. More...

virtual void	UpdateWidgetSize ([[maybe_unused]] WidgetID widget, [[maybe_unused]] Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize)
	Update size and resize step of a widget in the window. More...

virtual void	SetStringParameters ([[maybe_unused]] WidgetID widget) const
	Initialize string parameters for a widget. More...

virtual void	OnFocus ()
	The window has gained focus. More...

virtual void	OnFocusLost (bool closing)
	The window has lost focus. More...

virtual EventState	OnKeyPress ([[maybe_unused]] char32_t key, [[maybe_unused]] uint16_t keycode)
	A key has been pressed. More...

virtual EventState	OnHotkey (int hotkey)
	A hotkey has been pressed. More...

virtual EventState	OnCTRLStateChange ()
	The state of the control key has changed. More...

virtual void	OnClick ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] int click_count)
	A click with the left mouse button has been made on the window. More...

virtual bool	OnRightClick ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
	A click with the right mouse button has been made on the window. More...

virtual void	OnHover ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
	The mouse is hovering over a widget in the window, perform an action for it. More...

virtual bool	OnTooltip ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] TooltipCloseCondition close_cond)
	Event to display a custom tooltip. More...

virtual void	OnMouseDrag ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
	An 'object' is being dragged at the provided position, highlight the target if possible. More...

virtual void	OnDragDrop ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
	A dragged 'object' has been released. More...

virtual void	OnScroll ([[maybe_unused]] Point delta)
	Handle the request for (viewport) scrolling. More...

virtual void	OnMouseOver ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
	The mouse is currently moving over the window or has just moved outside of the window. More...

virtual void	OnMouseWheel ([[maybe_unused]] int wheel)
	The mouse wheel has been turned. More...

virtual void	OnMouseLoop ()
	Called for every mouse loop run, which is at least once per (game) tick.

virtual void	OnGameTick ()
	Called once per (game) tick.

virtual void	OnRealtimeTick ([[maybe_unused]] uint delta_ms)
	Called periodically.

virtual void	OnTimeout ()
	Called when this window's timeout has been reached.

virtual void	OnResize ()
	Called after the window got resized. More...

virtual void	OnDropdownSelect ([[maybe_unused]] WidgetID widget, [[maybe_unused]] int index)
	A dropdown option associated to this window has been selected. More...

virtual void	OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close)
	A dropdown window associated to this window has been closed. More...

virtual void	OnEditboxChanged ([[maybe_unused]] WidgetID widget)
	The text in an editbox has been edited. More...

virtual void	OnQueryTextFinished ([[maybe_unused]] std::optional< std::string > str)
	The query window opened from this window has closed. More...

virtual void	OnInvalidateData ([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true)
	Some data on this window has become invalid. More...

virtual void	OnPlaceObject ([[maybe_unused]] Point pt, [[maybe_unused]] TileIndex tile)
	The user clicked some place on the map when a tile highlight mode has been set. More...

virtual bool	OnVehicleSelect ([[maybe_unused]] const struct Vehicle *v)
	The user clicked on a vehicle while HT_VEHICLE has been set. More...

virtual bool	OnVehicleSelect ([[maybe_unused]] VehicleList::const_iterator begin, [[maybe_unused]] VehicleList::const_iterator end)
	The user clicked on a vehicle while HT_VEHICLE has been set. More...

virtual void	OnPlaceObjectAbort ()
	The user cancelled a tile highlight mode that has been set.

virtual void	OnPlaceDrag ([[maybe_unused]] ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt)
	The user is dragging over the map when the tile highlight mode has been set. More...

virtual void	OnPlaceMouseUp ([[maybe_unused]] ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt, [[maybe_unused]] TileIndex start_tile, [[maybe_unused]] TileIndex end_tile)
	The user has dragged over the map when the tile highlight mode has been set. More...

virtual void	OnPlacePresize ([[maybe_unused]] Point pt, [[maybe_unused]] TileIndex tile)
	The user moves over the map when a tile highlight mode has been set when the special mouse mode has been set to 'PRESIZE' mode. More...

virtual bool	IsNewGRFInspectable () const
	Is the data related to this window NewGRF inspectable? More...

virtual void	ShowNewGRFInspectWindow () const
	Show the NewGRF inspection window. More...

template<>
const NWidgetBase *	GetWidget (WidgetID widnum) const
	Specialized case of Window::GetWidget for the nested widget base class.

Public Member Functions inherited from ZeroedMemoryAllocator
void *	operator new (size_t size)
	Memory allocator for a single class instance. More...

void *	operator new[] (size_t size)
	Memory allocator for an array of class instances. More...

void	operator delete (void *ptr)
	Memory release for a single class instance. More...

void	operator delete[] (void *ptr)
	Memory release for an array of class instances. More...

Protected Types
enum	ZoomLevelChange { ZLC_INITIALIZE , ZLC_ZOOM_OUT , ZLC_ZOOM_IN }
	Available kinds of zoomlevel changes. More...

Protected Member Functions
uint	GetMinLegendWidth () const
	Compute minimal required width of the legends. More...

uint	GetNumberColumnsLegend (uint width) const
	Return number of columns that can be displayed in width pixels. More...

uint	GetLegendHeight (uint num_columns) const
	Compute height given a number of columns. More...

CompanyMask	GetOverlayCompanyMask () const
	Get a bitmask for company links to be displayed. More...

void	RebuildColourIndexIfNecessary ()
	Rebuilds the colour indices used for fast access to the smallmap contour colours based on the heightlevel.

uint	GetNumberRowsLegend (uint columns) const
	Get the number of rows in the legend from the number of columns. More...

void	SelectLegendItem (int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item=0)
	Select and toggle a legend item. More...

void	SwitchMapType (SmallMapType map_type)
	Select a new map type. More...

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. More...

void	DrawMapIndicators () const
	Adds map indicators to the smallmap.

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. More...

void	DrawVehicles (const DrawPixelInfo dpi, Blitter blitter) const
	Adds vehicles to the smallmap. More...

void	DrawTowns (const DrawPixelInfo *dpi, const int vertical_padding) const
	Adds town names to the smallmap. More...

void	DrawIndustryNames (const DrawPixelInfo *dpi, const int vertical_padding) const
	Adds industry names to the smallmap. More...

void	DrawSmallMap (DrawPixelInfo *dpi) const
	Draws the small map. More...

Point	RemapTile (int tile_x, int tile_y) const
	Remap tile to location on this smallmap. More...

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. More...

Point	ComputeScroll (int tx, int ty, int x, int y, int *sub) const
	Compute base parameters of the smallmap such that tile (tx, ty) starts at pixel (x, y). More...

void	SetZoomLevel (ZoomLevelChange change, const Point *zoom_pt)
	Initialize or change the zoom level. More...

void	SetOverlayCargoMask ()
	Set the link graph overlay cargo mask from the legend.

void	SetupWidgetData ()
	Function to set up widgets depending on the information being shown on the smallmap.

uint32_t	GetTileColours (const TileArea &ta) const
	Decide which colours to show to the user for a group of tiles. More...

int	GetPositionOnLegend (Point pt)
	Determines the mouse position on the legend. More...

void	UpdateLinks ()
	Update all the links on the map.

void	Blink ()
	Blink the industries (if hover over an industry).

void	ForceRefresh ()
	Force a full refresh of the map.

Protected Member Functions inherited from Window
void	InitializeData (WindowNumber window_number)
	Initializes the data (except the position and initial size) of a new Window. More...

void	InitializePositionSize (int x, int y, int min_width, int min_height)
	Set the position and smallest size of the window. More...

virtual void	FindWindowPlacementAndResize (int def_width, int def_height)
	Resize window towards the default size. More...

virtual	~Window ()
	Remove window and all its child windows from the window stack.

Static Protected Member Functions
static void	BreakIndustryChainLink ()
	Notify the industry chain window to stop sending newly selected industries.

static Point	SmallmapRemapCoords (int x, int y)

static void	DrawVertMapIndicator (int x, int y, int y2)
	Draws vertical part of map indicator. More...

static void	DrawHorizMapIndicator (int x, int x2, int y)
	Draws horizontal part of map indicator. More...

Protected Attributes
uint	min_number_of_columns
	Minimal number of columns in legends.

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.

uint	legend_width
	Width of legend 'blob'.

int32_t	scroll_x
	Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.

int32_t	scroll_y
	Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.

int32_t	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).

std::unique_ptr< LinkGraphOverlay >	overlay

IntervalTimer< TimerWindow >	blink_interval
	Blink the industries (if selected) on a regular interval. More...

IntervalTimer< TimerWindow >	refresh_interval
	Update the whole map on a regular interval. More...

Protected Attributes inherited from Window
std::vector< int >	scheduled_invalidation_data
	Data of scheduled OnInvalidateData() calls.

bool	scheduled_resize
	Set if window has been resized.

Static Protected Attributes
static SmallMapType	map_type = SMT_CONTOUR
	Currently displayed legends.

static bool	show_towns = true
	Display town names in the smallmap.

static bool	show_ind_names = false
	Display industry names in the smallmap.

static int	map_height_limit = -1
	Currently used/cached map height limit.

static const uint	INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2
	Minimal number of columns in the WID_SM_LEGEND widget for the #SMT_INDUSTRY legend.

Friends
class	NWidgetSmallmapDisplay

Additional Inherited Members
Public Types inherited from Window
using	IteratorToFront = WindowIterator< false >
	Iterate in Z order towards front.

using	IteratorToBack = WindowIterator< true >
	Iterate in Z order towards back.

using	Iterate = AllWindows< false >
	Iterate all windows in whatever order is easiest.

using	IterateFromBack = AllWindows< false >
	Iterate all windows in Z order from back to front.

using	IterateFromFront = AllWindows< true >
	Iterate all windows in Z order from front to back.

Static Public Member Functions inherited from Window
static int	SortButtonWidth ()
	Get width of up/down arrow of sort button state. More...

static void	DeleteClosedWindows ()
	Delete all closed windows.

Data Fields inherited from Window
WindowDesc &	window_desc
	Window description.

WindowFlags	flags
	Window flags.

WindowClass	window_class
	Window class.

WindowNumber	window_number
	Window number within the window class.

int	scale
	Scale of this window – used to determine how to resize.

uint8_t	timeout_timer
	Timer value of the WF_TIMEOUT for flags.

uint8_t	white_border_timer
	Timer value of the WF_WHITE_BORDER for flags.

int	left
	x position of left edge of the window

int	top
	y position of top edge of the window

int	width
	width of the window (number of pixels to the right in x direction)

int	height
	Height of the window (number of pixels down in y direction)

ResizeInfo	resize
	Resize information.

Owner	owner
	The owner of the content shown in this window. Company colour is acquired from this variable.

ViewportData *	viewport
	Pointer to viewport data, if present.

const NWidgetCore *	nested_focus
	Currently focused nested widget, or `nullptr` if no nested widget has focus.

std::map< WidgetID, QueryString * >	querystrings
	QueryString associated to WWT_EDITBOX widgets.

std::unique_ptr< NWidgetBase >	nested_root
	Root of the nested tree.

WidgetLookup	widget_lookup
	Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.

NWidgetStacked *	shade_select
	Selection widget (NWID_SELECTION) to use for shading the window. If `nullptr`, window cannot shade.

Dimension	unshaded_size
	Last known unshaded size (only valid while shaded).

WidgetID	mouse_capture_widget
	ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.

Window *	parent
	Parent window.

WindowList::iterator	z_position

Detailed Description

Class managing the smallmap window.

Definition at line 625 of file smallmap_gui.cpp.

Member Enumeration Documentation

◆ ZoomLevelChange

enum SmallMapWindow::ZoomLevelChange

protected

Available kinds of zoomlevel changes.

Enumerator
ZLC_INITIALIZE	Initialize zoom level.
ZLC_ZOOM_OUT	Zoom out.
ZLC_ZOOM_IN	Zoom in.

Definition at line 628 of file smallmap_gui.cpp.

Member Function Documentation

◆ ComputeScroll()

Point SmallMapWindow::ComputeScroll	(	int	tx,
		int	ty,
		int	x,
		int	y,
		int *	sub
	)		const

inlineprotected

Compute base parameters of the smallmap such that tile (tx, ty) starts at pixel (x, y).

Parameters

	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.
[out]	sub	Value of subscroll needed.

Returns: scroll_x, scroll_y values.

Definition at line 1179 of file smallmap_gui.cpp.

◆ DrawHorizMapIndicator()

static void SmallMapWindow::DrawHorizMapIndicator	(	int	x,
		int	x2,
		int	y
	)

inlinestaticprotected

Draws horizontal part of map indicator.

Parameters

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 685 of file smallmap_gui.cpp.

Referenced by DrawMapIndicators().

◆ DrawIndustryNames()

void SmallMapWindow::DrawIndustryNames	(	const DrawPixelInfo *	dpi,
		const int	vertical_padding
	)		const

inlineprotected

Adds industry names to the smallmap.

Parameters

dpi	the part of the smallmap to be drawn into

Definition at line 1010 of file smallmap_gui.cpp.

◆ DrawSmallMap()

void SmallMapWindow::DrawSmallMap ( DrawPixelInfo * dpi ) const

inlineprotected

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:

The colours of tiles in the different modes.
Town names (optional)

Parameters

dpi	pointer to pixel to write onto

Definition at line 1056 of file smallmap_gui.cpp.

References BlitterFactory::GetCurrentBlitter().

◆ DrawSmallMapColumn()

void SmallMapWindow::DrawSmallMapColumn	(	void *	dst,
		uint	xc,
		uint	yc,
		int	pitch,
		int	reps,
		int	start_pos,
		int	end_pos,
		Blitter *	blitter
	)		const

inlineprotected

Draws one column of tiles of the small map in a certain mode onto the screen buffer, skipping the shifted rows in between.

Parameters

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

Note: If pixel position is below 0, skip drawing.

Definition at line 908 of file smallmap_gui.cpp.

References Blitter::MoveTo().

◆ DrawTowns()

void SmallMapWindow::DrawTowns	(	const DrawPixelInfo *	dpi,
		const int	vertical_padding
	)		const

inlineprotected

Adds town names to the smallmap.

Parameters

dpi	the part of the smallmap to be drawn into

Definition at line 986 of file smallmap_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_town_pool >::Iterate(), TileX(), and TileY().

◆ DrawVehicles()

void SmallMapWindow::DrawVehicles	(	const DrawPixelInfo *	dpi,
		Blitter *	blitter
	)		const

inlineprotected

Adds vehicles to the smallmap.

Parameters

dpi	the part of the smallmap to be drawn into
blitter	current blitter

Definition at line 948 of file smallmap_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Iterate(), TILE_SIZE, VEH_EFFECT, VS_HIDDEN, and VS_UNCLICKABLE.

◆ DrawVertMapIndicator()

static void SmallMapWindow::DrawVertMapIndicator	(	int	x,
		int	y,
		int	y2
	)

inlinestaticprotected

Draws vertical part of map indicator.

Parameters

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 673 of file smallmap_gui.cpp.

Referenced by DrawMapIndicators().

◆ GetLegendHeight()

uint SmallMapWindow::GetLegendHeight ( uint num_columns ) const

inlineprotected

Compute height given a number of columns.

Parameters

num_columns Number of columns.

Returns: Needed height for displaying the smallmap legends in pixels.

Definition at line 714 of file smallmap_gui.cpp.

References WidgetDimensions::framerect, FS_SMALL, GetCharacterHeight(), WidgetDimensions::scaled, and RectPadding::Vertical().

Referenced by NWidgetSmallmapDisplay::SetupSmallestSize().

◆ GetMinLegendWidth()

uint SmallMapWindow::GetMinLegendWidth ( ) const

inlineprotected

Compute minimal required width of the legends.

Returns: Minimally needed width for displaying the smallmap legends in pixels.

Definition at line 695 of file smallmap_gui.cpp.

References WidgetDimensions::framerect, and WidgetDimensions::scaled.

Referenced by NWidgetSmallmapDisplay::SetupSmallestSize().

◆ GetNumberColumnsLegend()

uint SmallMapWindow::GetNumberColumnsLegend ( uint width ) const

inlineprotected

Return number of columns that can be displayed in width pixels.

Returns: Number of columns to display.

Definition at line 704 of file smallmap_gui.cpp.

◆ GetNumberRowsLegend()

uint SmallMapWindow::GetNumberRowsLegend ( uint columns ) const

inlineprotected

Get the number of rows in the legend from the number of columns.

Those are at least min_number_of_fixed_rows and possibly more if there are so many cargoes, industry types or companies that they won't fit in the available space.

Parameters

columns Number of columns in the legend.

Returns: Number of rows needed for everything to fit in.

Definition at line 773 of file smallmap_gui.cpp.

References _smallmap_cargo_count, _smallmap_company_count, _smallmap_industry_count, and CeilDiv().

◆ GetOverlayCompanyMask()

CompanyMask SmallMapWindow::GetOverlayCompanyMask ( ) const

inlineprotected

Get a bitmask for company links to be displayed.

Usually this will be the _local_company. Spectators get to see all companies' links.

Returns: Company mask.

Definition at line 725 of file smallmap_gui.cpp.

References _local_company, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), and MAX_UVALUE.

◆ GetPositionOnLegend()

int SmallMapWindow::GetPositionOnLegend ( Point pt )

inlineprotected

Determines the mouse position on the legend.

Parameters

pt	Mouse position.

Returns: Legend item under the mouse.

Definition at line 1400 of file smallmap_gui.cpp.

References _current_text_dir, NWidgetBase::current_x, WidgetDimensions::framerect, FS_SMALL, GetCharacterHeight(), NWidgetBase::pos_y, WidgetDimensions::scaled, TD_RTL, and WID_SM_LEGEND.

◆ GetStationMiddle()

Point SmallMapWindow::GetStationMiddle ( const Station * st ) const

inline

Get the center of the given station as point on the screen in the smallmap window.

Parameters

st	Station to find in the smallmap.

Returns: Point with coordinates of the station.

Definition at line 1495 of file smallmap_gui.cpp.

◆ GetTileColours()

uint32_t SmallMapWindow::GetTileColours ( const TileArea & ta ) const

inlineprotected

Decide which colours to show to the user for a group of tiles.

Parameters

ta	Tile area to investigate.

Returns: Colours to display.

Definition at line 1319 of file smallmap_gui.cpp.

References GetTileType(), GetTunnelBridgeTransportType(), INVALID_TILE, MP_INDUSTRY, MP_RAILWAY, MP_ROAD, MP_TUNNELBRIDGE, MP_VOID, MP_WATER, TRANSPORT_RAIL, and TRANSPORT_ROAD.

◆ OnInit()

void SmallMapWindow::OnInit ( )

inlineoverridevirtual

Notification that the nested widget tree gets initialized.

The event can be used to perform general computations.

Note: nested_root and/or widget_lookup (normally accessed via GetWidget()) may not exist during this call.

Reimplemented from Window.

Definition at line 1523 of file smallmap_gui.cpp.

References _linkstat_colours_in_legenda, and lengthof.

◆ OnInvalidateData()

void SmallMapWindow::OnInvalidateData	(	int	data = `0`,
		bool	gui_scope = `true`
	)

inlineoverride

Some data on this window has become invalid.

Parameters

data	Information about the changed data. data = 0: Displayed industries at the industry chain window have changed. data = 1: Companies have changed. data = 2: Cheat changing the maximum heightlevel has been used, rebuild our heightlevel-to-colour index
gui_scope	Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See InvalidateWindowData() for details.

Definition at line 1816 of file smallmap_gui.cpp.

References _displayed_industries.

◆ OnPaint()

void SmallMapWindow::OnPaint ( )

inlineoverridevirtual

The window must be repainted.

Note: This method should not change any state, it should only use drawing functions.

Reimplemented from Window.

Definition at line 1579 of file smallmap_gui.cpp.

◆ PixelToTile()

Point SmallMapWindow::PixelToTile	(	int	px,
		int	py,
		int *	sub,
		bool	add_sub = `true`
	)		const

inlineprotected

Determine the tile relative to the base tile of the smallmap, and the pixel position at that tile for a point in the smallmap.

Parameters

	px	Horizontal coordinate of the pixel.
	py	Vertical coordinate of the pixel.
[out]	sub	Pixel position at the tile (0..3).
	add_sub	Add current subscroll to the position.

Returns: Tile being displayed at the given position relative to scroll_x and scroll_y.

Note: The subscroll offset is already accounted for.

Definition at line 1147 of file smallmap_gui.cpp.

◆ RemapTile()

Point SmallMapWindow::RemapTile	(	int	tile_x,
		int	tile_y
	)		const

inlineprotected

Remap tile to location on this smallmap.

Parameters

tile_x	X coordinate of the tile.
tile_y	Y coordinate of the tile.

Returns: Position to draw on.

Definition at line 1123 of file smallmap_gui.cpp.

References TILE_SIZE.

◆ SelectLegendItem()

void SmallMapWindow::SelectLegendItem	(	int	click_pos,
		LegendAndColour *	legend,
		int	end_legend_item,
		int	begin_legend_item = `0`
	)

inlineprotected

Select and toggle a legend item.

When CTRL is pressed, disable all other items in the group defined by begin_legend_item and end_legend_item and keep the clicked one enabled even if it was already enabled before. If the other items in the group are all disabled already and CTRL is pressed enable them instead.

Parameters

click_pos	the index of the item being selected
legend	the legend from which we select
end_legend_item	index one past the last item in the group to be inverted
begin_legend_item	index of the first item in the group to be inverted

Definition at line 792 of file smallmap_gui.cpp.

References _ctrl_pressed, and LegendAndColour::show_on_map.

◆ SetNewScroll()

void SmallMapWindow::SetNewScroll	(	int	sx,
		int	sy,
		int	sub
	)

inlineprotected

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.

Parameters

sx	Proposed new scroll_x
sy	Proposed new scroll_y
sub	Proposed new subscroll

Definition at line 841 of file smallmap_gui.cpp.

References NWidgetBase::current_x, InverseRemapCoords(), and WID_SM_MAP.

◆ SetZoomLevel()

void SmallMapWindow::SetZoomLevel	(	ZoomLevelChange	change,
		const Point *	zoom_pt
	)

inlineprotected

Initialize or change the zoom level.

Parameters

change	Way to change the zoom level.
zoom_pt	Position to keep fixed while zooming.

Precondition: *zoom_pt should contain a point in the smallmap display when zooming in or out.

Definition at line 1207 of file smallmap_gui.cpp.

References Clamp(), and lengthof.

◆ SwitchMapType()

void SmallMapWindow::SwitchMapType ( SmallMapType map_type )

inlineprotected

Select a new map type.

Parameters

map_type New map type.

Definition at line 821 of file smallmap_gui.cpp.

References WID_SM_CONTOUR.

Field Documentation

◆ blink_interval

IntervalTimer<TimerWindow> SmallMapWindow::blink_interval

protected

Initial value:

= {std::chrono::milliseconds(450), [this](auto) {
    Blink();
  }}

Blink the industries (if selected) on a regular interval.

Definition at line 731 of file smallmap_gui.cpp.

◆ refresh_interval

IntervalTimer<TimerWindow> SmallMapWindow::refresh_interval

protected

Initial value:

= {std::chrono::milliseconds(930), [this](auto) {
    ForceRefresh();
  }}

Update the whole map on a regular interval.

Definition at line 736 of file smallmap_gui.cpp.

The documentation for this class was generated from the following file:

src/smallmap_gui.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ZoomLevelChange

Member Function Documentation

◆ ComputeScroll()

◆ DrawHorizMapIndicator()

◆ DrawIndustryNames()

◆ DrawSmallMap()

◆ DrawSmallMapColumn()

◆ DrawTowns()

◆ DrawVehicles()

◆ DrawVertMapIndicator()

◆ GetLegendHeight()

◆ GetMinLegendWidth()

◆ GetNumberColumnsLegend()

◆ GetNumberRowsLegend()

◆ GetOverlayCompanyMask()

◆ GetPositionOnLegend()

◆ GetStationMiddle()

◆ GetTileColours()

◆ OnInit()

◆ OnInvalidateData()

◆ OnPaint()

◆ PixelToTile()

◆ RemapTile()

◆ SelectLegendItem()

◆ SetNewScroll()

◆ SetZoomLevel()

◆ SwitchMapType()

Field Documentation

◆ blink_interval

◆ refresh_interval