OpenTTD
Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends
SmallMapWindow Class Reference

Class managing the smallmap window. More...

#include <smallmap_gui.h>

Inheritance diagram for SmallMapWindow:
Window ZeroedMemoryAllocator

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.
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.
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.
virtual void OnScroll (Point delta)
 Handle the request for (viewport) scrolling.
virtual void OnMouseOver (Point pt, int widget)
 The mouse is currently moving over the window or has just moved outside of the window.
- 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.
virtual ~Window ()
 Remove window and all its child windows from the window stack.
void * operator new[] (size_t size)
 Helper allocation function to disallow something.
void operator delete (void *ptr)
 Helper allocation function to disallow something.
template<class NWID >
const NWID * GetWidget (uint widnum) const
 Specialized case of Window::GetWidget for the nested widget base class.
template<class NWID >
NWID * GetWidget (uint widnum)
 Get the nested widget with number widnum from the nested widget tree.
const ScrollbarGetScrollbar (uint widnum) const
 Return the Scrollbar to a widget index.
ScrollbarGetScrollbar (uint widnum)
 Return the Scrollbar to a widget index.
const QueryStringGetQueryString (uint widnum) const
 Return the querystring associated to a editbox.
QueryStringGetQueryString (uint widnum)
 Return the querystring associated to a editbox.
virtual const char * GetFocusedText () const
 Get the current input text if an edit box has the focus.
virtual const char * GetCaret () const
 Get the string at the caret if an edit box has the focus.
virtual const char * GetMarkedText (size_t *length) const
 Get the range of the currently marked input text.
virtual Point GetCaretPosition () const
 Get the current caret position if an edit box has the focus.
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.
virtual const char * GetTextCharacterAtPosition (const Point &pt) const
 Get the character that is rendered at a position by the focused edit box.
void InitNested (WindowNumber number=0)
 Perform complete initialization of the Window with nested widgets, to allow use.
void CreateNestedTree (bool fill_nested=true)
 Perform the first part of the initialization of a nested widget tree.
void FinishInitNested (WindowNumber window_number=0)
 Perform the second part of the initialization of a nested widget tree.
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 (byte widget_index, TextColour highlighted_colour)
 Sets the highlighted status of a widget.
bool IsWidgetHighlighted (byte widget_index) const
 Gets the highlighted status of a widget.
void SetWidgetDisabledState (byte widget_index, bool disab_stat)
 Sets the enabled/disabled status of a widget.
void DisableWidget (byte widget_index)
 Sets a widget to disabled.
void EnableWidget (byte widget_index)
 Sets a widget to Enabled.
bool IsWidgetDisabled (byte widget_index) const
 Gets the enabled/disabled status of a widget.
bool IsWidgetFocused (byte widget_index) const
 Check if given widget is focused within this window.
bool IsWidgetGloballyFocused (byte widget_index) const
 Check if given widget has user input focus.
void SetWidgetLoweredState (byte widget_index, bool lowered_stat)
 Sets the lowered/raised status of a widget.
void ToggleWidgetLoweredState (byte widget_index)
 Invert the lowered/raised status of a widget.
void LowerWidget (byte widget_index)
 Marks a widget as lowered.
void RaiseWidget (byte widget_index)
 Marks a widget as raised.
bool IsWidgetLowered (byte widget_index) const
 Gets the lowered state of a widget.
void UnfocusFocusedWidget ()
 Makes no widget on this window have focus.
bool SetFocusedWidget (int widget_index)
 Set focus within this window to the given widget.
EventState HandleEditBoxKey (int wid, WChar key, uint16 keycode)
 Process keypress for editbox widget.
virtual void InsertTextString (int 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.
void HandleButtonClick (byte widget)
 Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
int GetRowFromWidget (int clickpos, int widget, int padding, int line_height=-1) const
 Compute the row of a widget that a user clicked in.
void RaiseButtons (bool autoraise=false)
 Raise the buttons of the window.
void CDECL SetWidgetsDisabledState (bool disab_stat, int widgets,...)
 Sets the enabled/disabled status of a list of widgets.
void CDECL SetWidgetsLoweredState (bool lowered_stat, int widgets,...)
 Sets the lowered/raised status of a list of widgets.
void SetWidgetDirty (byte widget_index) const
 Invalidate a widget, i.e.
void DrawWidgets () const
 Paint all widgets of a window.
void DrawViewport () const
 Draw the viewport of this window.
void DrawSortButtonState (int widget, SortButtonState state) const
 Draw a sort button's up or down arrow symbol.
void DeleteChildWindows (WindowClass wc=WC_INVALID) const
 Delete all children a window might have in a head-recursive manner.
void SetDirty () const
 Mark entire window as dirty (in need of re-paint)
void ReInit (int rx=0, int ry=0)
 Re-initialize a window, and optionally change its size.
bool IsShaded () const
 Is window shaded currently?
void SetShaded (bool make_shaded)
 Set the shaded state of the window to make_shaded.
void InvalidateData (int data=0, bool gui_scope=true)
 Mark this window's data as invalid (in need of re-computing)
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 sm_width, int16 sm_height, int window_number)
 Compute the initial position of the window.
virtual void UpdateWidgetSize (int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 Update size and resize step of a widget in the window.
virtual void OnFocus ()
 Called when window gains focus.
virtual void OnFocusLost ()
 Called when window looses focus.
virtual EventState OnKeyPress (WChar key, uint16 keycode)
 A key has been pressed.
virtual EventState OnHotkey (int hotkey)
 A hotkey has been pressed.
virtual EventState OnCTRLStateChange ()
 The state of the control key has changed.
virtual void OnHover (Point pt, int widget)
 The mouse is hovering over a widget in the window, perform an action for it, like opening a custom tooltip.
virtual void OnMouseDrag (Point pt, int widget)
 An 'object' is being dragged at the provided position, highlight the target if possible.
virtual void OnDragDrop (Point pt, int widget)
 A dragged 'object' has been released.
virtual void OnMouseLoop ()
 Called for every mouse loop run, which is at least once per (game) tick.
virtual void OnHundredthTick ()
 Called once every 100 (game) ticks.
virtual void OnTimeout ()
 Called when this window's timeout has been reached.
virtual void OnResize ()
 Called after the window got resized.
virtual void OnDropdownSelect (int widget, int index)
 A dropdown option associated to this window has been selected.
virtual void OnDropdownClose (Point pt, int widget, int index, bool instant_close)
 A dropdown window associated to this window has been closed.
virtual void OnEditboxChanged (int widget)
 The text in an editbox has been edited.
virtual void OnQueryTextFinished (char *str)
 The query window opened from this window has closed.
virtual void OnPlaceObject (Point pt, TileIndex tile)
 The user clicked some place on the map when a tile highlight mode has been set.
virtual bool OnVehicleSelect (const struct Vehicle *v)
 The user clicked on a vehicle while HT_VEHICLE has been set.
virtual void OnPlaceObjectAbort ()
 The user cancelled a tile highlight mode that has been set.
virtual void OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
 The user is dragging over the map when the tile highlight mode has been set.
virtual void OnPlaceMouseUp (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
 The user has dragged over the map when the tile highlight mode has been set.
virtual void OnPlacePresize (Point pt, 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.
virtual bool IsNewGRFInspectable () const
 Is the data related to this window NewGRF inspectable?
virtual void ShowNewGRFInspectWindow () const
 Show the NewGRF inspection window.
- Public Member Functions inherited from ZeroedMemoryAllocator
void * operator new (size_t size)
 Memory allocator for a single class instance.
void operator delete[] (void *ptr)
 Memory release for an array of class instances.

Protected Types

enum  SmallMapType {
  SMT_CONTOUR, SMT_VEHICLES, SMT_INDUSTRY, SMT_LINKSTATS,
  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...

Protected Member Functions

Point SmallmapRemapCoords (int x, int y) const
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.
uint32 GetOverlayCompanyMask () const
 Get a bitmask for company links to be displayed.
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.
void SelectLegendItem (int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item=0)
 Select and toggle a legend item.
void SwitchMapType (SmallMapType map_type)
 Select a new map type.
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.
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.
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 DrawSmallMap (DrawPixelInfo *dpi) const
 Draws the small map.
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.
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 GetTileColours (const TileArea &ta) const
 Decide which colours to show to the user for a group of tiles.
int GetPositionOnLegend (Point pt)
 Determines the mouse position on the legend.
- Protected Member Functions inherited from Window
void InitializeData (WindowNumber window_number)
 Initializes the data (except the position and initial size) of a new Window.
void InitializePositionSize (int x, int y, int min_width, int min_height)
 Set the position and smallest size of the window.
virtual void FindWindowPlacementAndResize (int def_width, int def_height)
 Resize window towards the default size.

Static Protected 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.

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.
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.
LinkGraphOverlayoverlay
- Protected Attributes inherited from Window
SmallVector< int, 4 > scheduled_invalidation_data
 Data of scheduled OnInvalidateData() calls.

Static Protected Attributes

static SmallMapType map_type = SMT_CONTOUR
 Currently displayed legends.
static bool show_towns = true
 Display town names in the smallmap.
static int max_heightlevel = -1
 Currently used/cached maximum heightlevel.
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 uint FORCE_REFRESH_PERIOD = 0x1F
 map is redrawn after that many ticks
static const uint BLINK_PERIOD = 0x0F
 highlight blinking interval

Friends

class NWidgetSmallmapDisplay

Additional Inherited Members

- Static Public Member Functions inherited from Window
static int SortButtonWidth ()
 Get width of up/down arrow of sort button state.
- Data Fields inherited from Window
WindowDescwindow_desc
 Window description.
WindowFlags flags
 Window flags.
WindowClass window_class
 Window class.
WindowNumber window_number
 Window number within the window class.
uint8 timeout_timer
 Timer value of the WF_TIMEOUT for flags.
uint8 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.
ViewportDataviewport
 Pointer to viewport data, if present.
const NWidgetCorenested_focus
 Currently focused nested widget, or NULL if no nested widget has focus.
SmallMap< int, QueryString * > querystrings
 QueryString associated to WWT_EDITBOX widgets.
NWidgetBasenested_root
 Root of the nested tree.
NWidgetBase ** nested_array
 Array of pointers into the tree. Do not access directly, use Window::GetWidget() instead.
uint nested_array_size
 Size of the nested array.
NWidgetStackedshade_select
 Selection widget (NWID_SELECTION) to use for shading the window. If NULL, window cannot shade.
Dimension unshaded_size
 Last known unshaded size (only valid while shaded).
int scrolling_scrollbar
 Widgetindex of just being dragged scrollbar. -1 if none is active.
Windowparent
 Parent window.
Windowz_front
 The window in front of us in z-order.
Windowz_back
 The window behind us in z-order.

Detailed Description

Class managing the smallmap window.

Definition at line 44 of file smallmap_gui.h.

Member Enumeration Documentation

Types of legends in the WID_SM_LEGEND widget.

Definition at line 47 of file smallmap_gui.h.

Available kinds of zoomlevel changes.

Enumerator:
ZLC_INITIALIZE 

Initialize zoom level.

ZLC_ZOOM_OUT 

Zoom out.

ZLC_ZOOM_IN 

Zoom in.

Definition at line 58 of file smallmap_gui.h.

Member Function Documentation

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

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

Parameters
txTile x coordinate.
tyTile y coordinate.
xNon-negative horizontal position in the display where the tile starts.
yNon-negative vertical position in the display where the tile starts.
sub[out] Value of subscroll needed.
Returns
scroll_x, scroll_y values.

Definition at line 673 of file smallmap_gui.cpp.

References PixelToTile(), TILE_SIZE, and zoom.

Referenced by SmallMapCenterOnCurrentPos().

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

Draws horizontal part of map indicator.

Parameters
xX coord of left border of main viewport
x2X coord of right border of main viewport
yY coord of top/bottom border of main viewport

Definition at line 105 of file smallmap_gui.h.

References GfxFillRect(), and PC_VERY_LIGHT_YELLOW.

Referenced by DrawMapIndicators().

void SmallMapWindow::DrawSmallMap ( DrawPixelInfo dpi) const
protected

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:

  1. The colours of tiles in the different modes.
  2. Town names (optional)
Parameters
dpipointer to pixel to write onto

Definition at line 939 of file smallmap_gui.cpp.

References LinkGraphOverlay::Draw(), DrawMapIndicators(), DrawSmallMapColumn(), DrawTowns(), DrawVehicles(), BlitterFactory::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
protected

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

Parameters
dstPointer to a part of the screen buffer to write to.
xcThe X coordinate of the first tile in the column.
ycThe Y coordinate of the first tile in the column
pitchNumber of pixels to advance in the screen buffer each time a pixel is written.
repsNumber of lines to draw
start_posPosition of first pixel to draw.
end_posPosition of last pixel to draw (exclusive).
blittercurrent blitter
Note
If pixel position is below 0, skip drawing.

Definition at line 804 of file smallmap_gui.cpp.

References _settings_game, OrthogonalTileArea::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
protected
void SmallMapWindow::DrawVehicles ( const DrawPixelInfo dpi,
Blitter blitter 
) const
protected

Adds vehicles to the smallmap.

Parameters
dpithe part of the smallmap to be drawn into
blittercurrent blitter

Definition at line 844 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 
)
inlinestaticprotected

Draws vertical part of map indicator.

Parameters
xX coord of left/right border of main viewport
yY coord of top border of main viewport
y2Y coord of bottom border of main viewport

Definition at line 93 of file smallmap_gui.h.

References GfxFillRect(), and PC_VERY_LIGHT_YELLOW.

Referenced by DrawMapIndicators().

void SmallMapWindow::DrawWidget ( const Rect r,
int  widget 
) const
virtual

Draw the contents of a nested widget.

Parameters
rRectangle occupied by the widget.
widgetNumber of the widget to draw.
Note
This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 1165 of file smallmap_gui.cpp.

References _current_text_dir, _smallmap_industry_highlight, _smallmap_industry_highlight_state, column_width, DrawSmallMap(), DrawString(), LegendAndColour::end, FillDrawPixelInfo(), FONT_HEIGHT_SMALL, Industry::GetIndustryTypeCount(), GetNumberColumnsLegend(), GetNumberRowsLegend(), GfxFillRect(), INVALID_COMPANY, LEGEND_BLOB_WIDTH, map_type, PC_BLACK, PC_WHITE, SetDParam(), TD_RTL, TILE_HEIGHT_STEP, WD_FRAMERECT_LEFT, WD_FRAMERECT_RIGHT, WD_FRAMERECT_TOP, WID_SM_LEGEND, and WID_SM_MAP.

uint SmallMapWindow::GetLegendHeight ( uint  num_columns) const
inlineprotected

Compute height given a number of columns.

Parameters
num_columnsNumber of columns.
Returns
Needed height for displaying the smallmap legends in pixels.

Definition at line 134 of file smallmap_gui.h.

References FONT_HEIGHT_SMALL, GetNumberRowsLegend(), WD_FRAMERECT_BOTTOM, and WD_FRAMERECT_TOP.

Referenced by NWidgetSmallmapDisplay::SetupSmallestSize().

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 115 of file smallmap_gui.h.

References column_width, min_number_of_columns, and WD_FRAMERECT_LEFT.

Referenced by NWidgetSmallmapDisplay::SetupSmallestSize().

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 124 of file smallmap_gui.h.

References column_width.

Referenced by DrawWidget(), and GetPositionOnLegend().

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
columnsNumber of columns in the legend.
Returns
Number of rows needed for everything to fit in.

Definition at line 1282 of file smallmap_gui.cpp.

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

Referenced by DrawWidget(), GetLegendHeight(), and GetPositionOnLegend().

uint32 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 145 of file smallmap_gui.h.

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

Referenced by OnTick().

int SmallMapWindow::GetPositionOnLegend ( Point  pt)
protected

Determines the mouse position on the legend.

Parameters
ptMouse position.
Returns
Legend item under the mouse.

Definition at line 1341 of file smallmap_gui.cpp.

References _current_text_dir, column_width, NWidgetBase::current_x, FONT_HEIGHT_SMALL, GetNumberColumnsLegend(), GetNumberRowsLegend(), NWidgetBase::pos_x, NWidgetBase::pos_y, TD_RTL, WD_FRAMERECT_LEFT, WD_FRAMERECT_TOP, and WID_SM_LEGEND.

Referenced by OnClick(), and OnMouseOver().

Point SmallMapWindow::GetStationMiddle ( const Station st) const

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

Parameters
stStation to find in the smallmap.
Returns
Point with coordinates of the station.

Definition at line 1640 of file smallmap_gui.cpp.

References BaseStation::rect, RemapTile(), and subscroll.

uint32 SmallMapWindow::GetTileColours ( const TileArea ta) const
inlineprotected

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

Parameters
taTile area to investigate.
Returns
Colours to display.

Definition at line 750 of file smallmap_gui.cpp.

References GetSmallMapContoursPixels(), GetSmallMapIndustriesPixels(), GetSmallMapLinkStatsPixels(), GetSmallMapOwnerPixels(), GetSmallMapRoutesPixels(), GetSmallMapVegetationPixels(), GetSmallMapVehiclesPixels(), INVALID_TILE, map_type, MP_VOID, and TILE_AREA_LOOP.

Referenced by DrawSmallMapColumn().

void SmallMapWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
)
virtual
void SmallMapWindow::OnInit ( )
virtual
void SmallMapWindow::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
)
virtual

Some data on this window has become invalid.

Parameters
dataInformation 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_scopeWhether 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 1501 of file smallmap_gui.cpp.

References _displayed_industries, _smallmap_industry_count, map_type, RebuildColourIndexIfNecessary(), Window::ReInit(), Window::SetDirty(), LegendAndColour::show_on_map, and SwitchMapType().

void SmallMapWindow::OnMouseOver ( Point  pt,
int  widget 
)
virtual

The mouse is currently moving over the window or has just moved outside of the window.

In the latter case pt is (-1, -1).

Parameters
ptthe point inside the window that the mouse hovers over.
widgetthe widget the mouse hovers over.

Reimplemented from Window.

Definition at line 1357 of file smallmap_gui.cpp.

References _smallmap_industry_count, _smallmap_industry_highlight, _smallmap_industry_highlight_state, BLINK_PERIOD, FORCE_REFRESH_PERIOD, GetPositionOnLegend(), INVALID_INDUSTRYTYPE, map_type, refresh, Window::SetDirty(), LegendAndColour::type, and WID_SM_LEGEND.

void SmallMapWindow::OnMouseWheel ( int  wheel)
virtual

The mouse wheel has been turned.

Parameters
wheelthe amount of movement of the mouse wheel.

Reimplemented from Window.

Definition at line 1538 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, WID_SM_MAP, ZLC_ZOOM_IN, and ZLC_ZOOM_OUT.

void SmallMapWindow::OnPaint ( )
virtual

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

bool SmallMapWindow::OnRightClick ( Point  pt,
int  widget 
)
virtual

A click with the right mouse button has been made on the window.

Parameters
ptthe point inside the window that has been clicked.
widgetthe clicked widget.
Returns
true if the click was actually handled, i.e. do not show a tooltip if tooltip-on-right-click is enabled.

Reimplemented from Window.

Definition at line 1530 of file smallmap_gui.cpp.

References _scrolling_viewport, and WID_SM_MAP.

void SmallMapWindow::OnScroll ( Point  delta)
virtual

Handle the request for (viewport) scrolling.

Parameters
deltathe amount the viewport must be scrolled.

Reimplemented from Window.

Definition at line 1607 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
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
pxHorizontal coordinate of the pixel.
pyVertical coordinate of the pixel.
sub[out]Pixel position at the tile (0..3).
add_subAdd 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 641 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
inlineprotected

Remap tile to location on this smallmap.

Parameters
tile_xX coordinate of the tile.
tile_yY coordinate of the tile.
Returns
Position to draw on.

Definition at line 617 of file smallmap_gui.cpp.

References scroll_x, scroll_y, TILE_SIZE, and zoom.

Referenced by DrawMapIndicators(), DrawTowns(), DrawVehicles(), and GetStationMiddle().

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

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_posthe index of the item being selected
legendthe legend from which we select
end_legend_itemindex one past the last item in the group to be inverted
begin_legend_itemindex of the first item in the group to be inverted

Definition at line 1301 of file smallmap_gui.cpp.

References _ctrl_pressed, and LegendAndColour::show_on_map.

Referenced by OnClick().

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

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
sxProposed new scroll_x
syProposed new scroll_y
subProposed new subscroll

Definition at line 1577 of file smallmap_gui.cpp.

References NWidgetBase::current_x, NWidgetBase::current_y, InverseRemapCoords(), map_type, MapMaxX(), MapMaxY(), LinkGraphOverlay::RebuildCache(), scroll_x, scroll_y, subscroll, TILE_SIZE, WID_SM_MAP, and zoom.

Referenced by OnScroll(), SetZoomLevel(), and SmallMapCenterOnCurrentPos().

void SmallMapWindow::SetStringParameters ( int  widget) const
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.

Parameters
widgetWidget number.

Reimplemented from Window.

Definition at line 1090 of file smallmap_gui.cpp.

References map_type, SetDParam(), and WID_SM_CAPTION.

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

Initialize or change the zoom level.

Parameters
changeWay to change the zoom level.
zoom_ptPosition to keep fixed while zooming.
Precondition
*zoom_pt should contain a point in the smallmap display when zooming in or out.

Definition at line 701 of file smallmap_gui.cpp.

References Clamp(), lengthof, map_type, PixelToTile(), LinkGraphOverlay::RebuildCache(), 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)
protected

Select a new map type.

Parameters
map_typeNew map type.

Definition at line 1262 of file smallmap_gui.cpp.

References Window::LowerWidget(), map_type, Window::RaiseWidget(), LinkGraphOverlay::RebuildCache(), Window::SetDirty(), SetupWidgetData(), and WID_SM_CONTOUR.

Referenced by OnClick(), and OnInvalidateData().


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