The GUI for stations. More...

#include "stdafx.h"
#include "debug.h"
#include "gui.h"
#include "textbuf_gui.h"
#include "company_func.h"
#include "command_func.h"
#include "vehicle_gui.h"
#include "cargotype.h"
#include "station_gui.h"
#include "strings_func.h"
#include "string_func.h"
#include "window_func.h"
#include "viewport_func.h"
#include "dropdown_type.h"
#include "dropdown_common_type.h"
#include "dropdown_func.h"
#include "station_base.h"
#include "waypoint_base.h"
#include "tilehighlight_func.h"
#include "company_base.h"
#include "sortlist_type.h"
#include "core/geometry_func.hpp"
#include "vehiclelist.h"
#include "town.h"
#include "linkgraph/linkgraph.h"
#include "zoom_func.h"
#include "station_cmd.h"
#include "widgets/station_widget.h"
#include "table/strings.h"
#include "safeguards.h"

Data Structures
struct	StationTypeFilter

struct	GenericWaypointTypeFilter< ROAD, TILE_TYPE >

class	CompanyStationsWindow
	The list of stations per company. More...

struct	CompanyStationsWindow::FilterState

class	CargoSorter

class	CargoDataEntry
	A cargo data entry representing one possible row in the station view window's top part. More...

struct	StationViewWindow
	The StationView window. More...

struct	StationViewWindow::RowDisplay
	A row being displayed in the cargo view (as opposed to being "hidden" behind a plus sign). More...

struct	TileAndStation
	Struct containing TileIndex and StationID. More...

struct	SelectStationWindow< T >
	Window for selecting stations/waypoints to (distant) join to. More...

Typedefs
using	RailWaypointTypeFilter = GenericWaypointTypeFilter< false, MP_RAILWAY >

using	RoadWaypointTypeFilter = GenericWaypointTypeFilter< true, MP_ROAD >

typedef GUIList< const Station *, const CargoTypes & >	GUIStationList

typedef std::set< CargoDataEntry *, CargoSorter >	CargoDataSet

Enumerations
enum	SortOrder { SO_DESCENDING , SO_ASCENDING }

enum class	CargoSortType : uint8_t { AsGrouping , Count , StationString , StationID , CargoID }

Functions
int	DrawStationCoverageAreaText (int left, int right, int top, StationCoverageType sct, int rad, bool supplies)
	Calculates and draws the accepted or supplied cargo around the selected tile(s)

template<typename T >
void	FindStationsAroundSelection ()
	Find stations adjacent to the current tile highlight area, so that existing coverage area can be drawn.

void	CheckRedrawStationCoverage (const Window *w)
	Check whether we need to redraw the station coverage text.

template<typename T >
void	CheckRedrawWaypointCoverage ()

void	CheckRedrawRailWaypointCoverage (const Window *)

void	CheckRedrawRoadWaypointCoverage (const Window *)

static void	StationsWndShowStationRating (int left, int right, int y, CargoID type, uint amount, uint8_t rating)
	Draw small boxes of cargo amount and ratings data at the given coordinates.

void	ShowCompanyStations (CompanyID company)
	Opens window with list of company's stations.

static void	DrawCargoIcons (CargoID i, uint waiting, int left, int right, int y)
	Draws icons of waiting cargo in the StationView window.

void	ShowStationViewWindow (StationID station)
	Opens StationViewWindow for given station.

template<class T >
static bool	AddNearbyStation (TileIndex tile, void *user_data)
	Add station on this tile to _stations_nearby_list if it's fully within the station spread.

template<class T >
static const BaseStation *	FindStationsNearby (TileArea ta, bool distant_join)
	Circulate around the to-be-built station to find stations we could join.

template<class T >
static bool	StationJoinerNeeded (TileArea ta, const StationPickerCmdProc &proc)
	Check whether we need to show the station selection window.

template<class T >
void	ShowSelectBaseStationIfNeeded (TileArea ta, StationPickerCmdProc &&proc)
	Show the station selection window when needed.

void	ShowSelectStationIfNeeded (TileArea ta, StationPickerCmdProc proc)
	Show the station selection window when needed.

void	ShowSelectRailWaypointIfNeeded (TileArea ta, StationPickerCmdProc proc)
	Show the rail waypoint selection window when needed.

void	ShowSelectRoadWaypointIfNeeded (TileArea ta, StationPickerCmdProc proc)
	Show the road waypoint selection window when needed.

Variables
static constexpr NWidgetPart	_nested_company_stations_widgets []

static WindowDesc	_company_stations_desc (WDP_AUTO, "list_stations", 358, 162, WC_STATION_LIST, WC_NONE, 0, _nested_company_stations_widgets)

static constexpr NWidgetPart	_nested_station_view_widgets []

static WindowDesc	_station_view_desc (WDP_AUTO, "view_station", 249, 117, WC_STATION_VIEW, WC_NONE, 0, _nested_station_view_widgets)

static std::vector< TileAndStation >	_deleted_stations_nearby

static std::vector< StationID >	_stations_nearby_list

static constexpr NWidgetPart	_nested_select_station_widgets []

static WindowDesc	_select_station_desc (WDP_AUTO, "build_station_join", 200, 180, WC_SELECT_STATION, WC_NONE, WDF_CONSTRUCTION, _nested_select_station_widgets)

Detailed Description

The GUI for stations.

Definition in file station_gui.cpp.

Typedef Documentation

◆ CargoDataSet

typedef std::set<CargoDataEntry *, CargoSorter> CargoDataSet

Definition at line 913 of file station_gui.cpp.

◆ GUIStationList

typedef GUIList<const Station*, const CargoTypes &> GUIStationList

Definition at line 257 of file station_gui.cpp.

◆ RailWaypointTypeFilter

using RailWaypointTypeFilter = GenericWaypointTypeFilter<false, MP_RAILWAY>

Definition at line 64 of file station_gui.cpp.

◆ RoadWaypointTypeFilter

using RoadWaypointTypeFilter = GenericWaypointTypeFilter<true, MP_ROAD>

Definition at line 65 of file station_gui.cpp.

Enumeration Type Documentation

◆ CargoSortType

enum class CargoSortType : uint8_t

strong

Enumerator
AsGrouping	by the same principle the entries are being grouped
Count	by amount of cargo
StationString	by station name
StationID	by station id
CargoID	by cargo id

Definition at line 889 of file station_gui.cpp.

◆ SortOrder

enum SortOrder

Definition at line 882 of file station_gui.cpp.

Function Documentation

◆ AddNearbyStation()

template<class T >

static bool AddNearbyStation	(	TileIndex	tile,
		void *	user_data
	)

static

Add station on this tile to _stations_nearby_list if it's fully within the station spread.

Parameters

tile	Tile just being checked
user_data	Pointer to TileArea context

Template Parameters

T	the station filter type

Definition at line 2198 of file station_gui.cpp.

References _local_company, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_station_pool >::Get(), GetStationIndex(), OrthogonalTileArea::h, IsTileType(), MP_STATION, BaseStation::owner, BaseStation::rect, CommandCost::Succeeded(), OrthogonalTileArea::tile, and OrthogonalTileArea::w.

◆ CheckRedrawRailWaypointCoverage()

void CheckRedrawRailWaypointCoverage ( const Window * w )

Definition at line 198 of file station_gui.cpp.

◆ CheckRedrawRoadWaypointCoverage()

void CheckRedrawRoadWaypointCoverage ( const Window * w )

Definition at line 203 of file station_gui.cpp.

◆ CheckRedrawStationCoverage()

void CheckRedrawStationCoverage ( const Window * w )

Check whether we need to redraw the station coverage text.

If it is needed actually make the window for redrawing.

Parameters

w	the window to check.

Definition at line 160 of file station_gui.cpp.

References _ctrl_pressed, _settings_client, TileHighlightData::dirty, TileHighlightData::drawstyle, ClientSettings::gui, HT_RECT, Window::SetDirty(), and GUISettings::station_show_coverage.

Referenced by BuildAirportWindow::OnRealtimeTick(), BuildDocksStationWindow::OnRealtimeTick(), BuildRailStationWindow::OnRealtimeTick(), and BuildRoadStationWindow::OnRealtimeTick().

◆ CheckRedrawWaypointCoverage()

template<typename T >

void CheckRedrawWaypointCoverage ( )

Definition at line 180 of file station_gui.cpp.

◆ DrawCargoIcons()

static void DrawCargoIcons	(	CargoID	i,
		uint	waiting,
		int	left,
		int	right,
		int	y
	)

static

Draws icons of waiting cargo in the StationView window.

Parameters

i	type of cargo
waiting	number of waiting units
left	left most coordinate to draw on
right	right most coordinate to draw on
y	y coordinate

Definition at line 867 of file station_gui.cpp.

References _current_text_dir, DrawSprite(), CargoSpec::Get(), CargoSpec::GetCargoIcon(), ScaleSpriteTrad(), and TD_RTL.

Referenced by StationViewWindow::DrawEntries().

◆ DrawStationCoverageAreaText()

int DrawStationCoverageAreaText	(	int	left,
		int	right,
		int	top,
		StationCoverageType	sct,
		int	rad,
		bool	supplies
	)

Calculates and draws the accepted or supplied cargo around the selected tile(s)

Parameters

left	x position where the string is to be drawn
right	the right most position to draw on
top	y position where the string is to be drawn
sct	which type of cargo is to be displayed (passengers/non-passengers)
rad	radius around selected tile(s) to be searched
supplies	if supplied cargoes should be drawn, else accepted cargoes

Returns: Returns the y value below the string that was drawn

Definition at line 77 of file station_gui.cpp.

References CC_PASSENGERS, DrawStringMultiLine(), TileHighlightData::drawstyle, GetAcceptanceAroundTiles(), GetProductionAroundTiles(), HT_RECT, IsCargoInClass(), NUM_CARGO, TileHighlightData::pos, SCT_ALL, SCT_NON_PASSENGERS_ONLY, SCT_PASSENGERS_ONLY, SetBit(), SetDParam(), Map::Size(), TileHighlightData::size, TILE_SIZE, and TileVirtXY().

Referenced by BuildAirportWindow::OnPaint(), BuildDocksStationWindow::OnPaint(), BuildRailStationWindow::OnPaint(), and BuildRoadStationWindow::OnPaint().

◆ FindStationsAroundSelection()

template<typename T >

void FindStationsAroundSelection ( )

Find stations adjacent to the current tile highlight area, so that existing coverage area can be drawn.

Definition at line 109 of file station_gui.cpp.

References _ctrl_pressed, _local_company, GetTileOwner(), OrthogonalTileArea::h, IsTileType(), Map::MaxX(), Map::MaxY(), MP_STATION, TileHighlightData::pos, TileHighlightData::size, OrthogonalTileArea::tile, TILE_SIZE, TileVirtXY(), TileX(), TileXY(), TileY(), and OrthogonalTileArea::w.

◆ FindStationsNearby()

template<class T >

static const BaseStation * FindStationsNearby	(	TileArea	ta,
		bool	distant_join
	)

static

Circulate around the to-be-built station to find stations we could join.

Make sure that only stations are returned where joining wouldn't exceed station spread and are our own station.

Parameters

ta	Base tile area of the to-be-built station
distant_join	Search for adjacent stations (false) or stations fully within station spread

Template Parameters

T	the station filter type, for stations to look for

Definition at line 2240 of file station_gui.cpp.

References _local_company, _settings_game, CircularTileSearch(), DIR_N, DistanceMax(), BaseStation::GetByTile(), GetStationIndex(), OrthogonalTileArea::h, IsInsideBS(), IsTileType(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_station_pool >::Iterate(), MP_STATION, Map::Size(), GameSettings::station, StationSettings::station_spread, OrthogonalTileArea::tile, TileAddByDir(), TileAddXY(), TileX(), TileY(), and OrthogonalTileArea::w.

◆ ShowCompanyStations()

void ShowCompanyStations ( CompanyID company )

Opens window with list of company's stations.

Parameters

company whose stations' list show

Definition at line 814 of file station_gui.cpp.

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

Referenced by MenuClickStations(), and MainToolbarWindow::OnHotkey().

◆ ShowSelectBaseStationIfNeeded()

template<class T >

void ShowSelectBaseStationIfNeeded	(	TileArea	ta,
		StationPickerCmdProc &&	proc
	)

Show the station selection window when needed.

If not, build the station.

Parameters

cmd	Command to build the station.
ta	Area to build the station in

Template Parameters

the	class to find stations for

Definition at line 2468 of file station_gui.cpp.

References _settings_client, ClientSettings::gui, GUISettings::persistent_buildingtools, and ResetObjectToPlace().

◆ ShowSelectRailWaypointIfNeeded()

void ShowSelectRailWaypointIfNeeded	(	TileArea	ta,
		StationPickerCmdProc	proc
	)

Show the rail waypoint selection window when needed.

If not, build the waypoint.

Parameters

ta	Area to build the waypoint in
proc	Function called to execute the build command.

Definition at line 2493 of file station_gui.cpp.

Referenced by BuildRailToolbarWindow::OnPlaceMouseUp().

◆ ShowSelectRoadWaypointIfNeeded()

void ShowSelectRoadWaypointIfNeeded	(	TileArea	ta,
		StationPickerCmdProc	proc
	)

Show the road waypoint selection window when needed.

If not, build the waypoint.

Parameters

ta	Area to build the waypoint in
proc	Function called to execute the build command.

Definition at line 2503 of file station_gui.cpp.

Referenced by BuildRoadToolbarWindow::OnPlaceMouseUp().

◆ ShowSelectStationIfNeeded()

void ShowSelectStationIfNeeded	(	TileArea	ta,
		StationPickerCmdProc	proc
	)

Show the station selection window when needed.

If not, build the station.

Parameters

ta	Area to build the station in
proc	Function called to execute the build command.

Definition at line 2483 of file station_gui.cpp.

Referenced by BuildDocksToolbarWindow::OnPlaceObject(), PlaceAirport(), PlaceRail_Station(), and PlaceRoadStop().

◆ ShowStationViewWindow()

void ShowStationViewWindow ( StationID station )

Opens StationViewWindow for given station.

Parameters

station station which window should be opened

Definition at line 2176 of file station_gui.cpp.

◆ StationJoinerNeeded()

template<class T >

static bool StationJoinerNeeded	(	TileArea	ta,
		const StationPickerCmdProc &	proc
	)

static

Check whether we need to show the station selection window.

Parameters

cmd	Command to build the station.
ta	Tile area of the to-be-built station

Template Parameters

T	the station filter type

Returns: whether we need to show the station selection window.

Definition at line 2438 of file station_gui.cpp.

References _ctrl_pressed, _settings_game, Window::Close(), StationSettings::distant_join_stations, FindWindowById(), GameSettings::station, UpdateTileSelection(), and WC_SELECT_STATION.

◆ StationsWndShowStationRating()

static void StationsWndShowStationRating	(	int	left,
		int	right,
		int	y,
		CargoID	type,
		uint	amount,
		uint8_t	rating
	)

static

Draw small boxes of cargo amount and ratings data at the given coordinates.

If amount exceeds 576 units, it is shown 'full', same goes for the rating: at above 90% orso (224) it is also 'full'

Parameters

left	left most coordinate to draw the box at
right	right most coordinate to draw the box at
y	coordinate to draw the box at
type	Cargo type
amount	Cargo amount
rating	ratings data for that particular cargo

< number of units to show station as 'full'

< rating needed so it is shown as 'full'

Definition at line 220 of file station_gui.cpp.

References CargoSpec::abbrev, DrawString(), FS_SMALL, CargoSpec::Get(), GetCharacterHeight(), GetContrastColour(), GfxFillRect(), CargoSpec::IsValid(), PC_GREEN, PC_RED, SA_CENTER, and ScaleGUITrad().

Referenced by CompanyStationsWindow::DrawWidget().

Variable Documentation

◆ _deleted_stations_nearby

std::vector<TileAndStation> _deleted_stations_nearby

static

Definition at line 2187 of file station_gui.cpp.

◆ _nested_company_stations_widgets

constexpr NWidgetPart _nested_company_stations_widgets[]

staticconstexpr

Definition at line 769 of file station_gui.cpp.

◆ _nested_select_station_widgets

constexpr NWidgetPart _nested_select_station_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN, WID_JS_CAPTION), SetDataTip(STR_JOIN_STATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_JS_PANEL), SetResize(1, 0), SetScrollbar(WID_JS_SCROLLBAR), EndContainer(),
    NWidget(NWID_VERTICAL),
      NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_JS_SCROLLBAR),
      NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
    EndContainer(),
  EndContainer(),
}

Definition at line 2281 of file station_gui.cpp.

◆ _nested_station_view_widgets

constexpr NWidgetPart _nested_station_view_widgets[]

staticconstexpr

Definition at line 821 of file station_gui.cpp.

◆ _stations_nearby_list

std::vector<StationID> _stations_nearby_list

static

Definition at line 2188 of file station_gui.cpp.

Data Structures

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ CargoDataSet

◆ GUIStationList

◆ RailWaypointTypeFilter

◆ RoadWaypointTypeFilter

Enumeration Type Documentation

◆ CargoSortType

◆ SortOrder

Function Documentation

◆ AddNearbyStation()

◆ CheckRedrawRailWaypointCoverage()

◆ CheckRedrawRoadWaypointCoverage()

◆ CheckRedrawStationCoverage()

◆ CheckRedrawWaypointCoverage()

◆ DrawCargoIcons()

◆ DrawStationCoverageAreaText()

◆ FindStationsAroundSelection()

◆ FindStationsNearby()

◆ ShowCompanyStations()

◆ ShowSelectBaseStationIfNeeded()

◆ ShowSelectRailWaypointIfNeeded()

◆ ShowSelectRoadWaypointIfNeeded()

◆ ShowSelectStationIfNeeded()

◆ ShowStationViewWindow()

◆ StationJoinerNeeded()

◆ StationsWndShowStationRating()

Variable Documentation

◆ _deleted_stations_nearby

◆ _nested_company_stations_widgets

◆ _nested_select_station_widgets

◆ _nested_station_view_widgets

◆ _stations_nearby_list