OpenTTD Source 20250205-master-gfd85ab1e2c
BaseGraphWindow Struct Reference
Inheritance diagram for BaseGraphWindow:
Window ZeroedMemoryAllocator CompanyValueGraphWindow DeliveredCargoGraphWindow IncomeGraphWindow IndustryProductionGraphWindow OperatingProfitGraphWindow PaymentRatesGraphWindow PerformanceHistoryGraphWindow

Data Structures

struct  DataSet
 

Public Member Functions

void UpdateWidgetSize (WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
 Update size and resize step of a widget in the window.
 
void DrawWidget (const Rect &r, WidgetID widget) const override
 Draw the contents of a nested widget.
 
virtual OverflowSafeInt64 GetGraphData (const Company *, int)
 
void OnClick (Point pt, WidgetID widget, int click_count) override
 A click with the left mouse button has been made on the window.
 
void OnGameTick () override
 Called once per (game) tick.
 
void OnInvalidateData (int data=0, bool gui_scope=true) override
 Some data on this window has become invalid.
 
virtual void UpdateStatistics (bool initialize)
 Update the statistics.
 
- 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.
 
voidoperator new[] (size_t size)=delete
 Helper allocation function to disallow something.
 
template<class NWID >
const NWID * GetWidget (WidgetID widnum) const
 Get the nested widget with number widnum from the nested widget tree.
 
template<class NWID >
NWID * GetWidget (WidgetID widnum)
 Get the nested widget with number widnum from the nested widget tree.
 
const ScrollbarGetScrollbar (WidgetID widnum) const
 Return the Scrollbar to a widget index.
 
ScrollbarGetScrollbar (WidgetID widnum)
 Return the Scrollbar to a widget index.
 
const QueryStringGetQueryString (WidgetID widnum) const
 Return the querystring associated to a editbox.
 
QueryStringGetQueryString (WidgetID widnum)
 Return the querystring associated to a editbox.
 
void UpdateQueryStringSize ()
 Update size of all QueryStrings of this window.
 
virtual const struct TextbufGetFocusedTextbuf () const
 Get the current input text buffer.
 
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 ptrdiff_t 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 ()
 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 (WidgetID widget_index, TextColour highlighted_colour)
 Sets the highlighted status of a widget.
 
bool IsWidgetHighlighted (WidgetID widget_index) const
 Gets the highlighted status of a widget.
 
void SetWidgetDisabledState (WidgetID widget_index, bool disab_stat)
 Sets the enabled/disabled status of a widget.
 
void DisableWidget (WidgetID widget_index)
 Sets a widget to disabled.
 
void EnableWidget (WidgetID widget_index)
 Sets a widget to Enabled.
 
bool IsWidgetDisabled (WidgetID widget_index) const
 Gets the enabled/disabled status of a widget.
 
bool IsWidgetFocused (WidgetID widget_index) const
 Check if given widget is focused within this window.
 
bool IsWidgetGloballyFocused (WidgetID widget_index) const
 Check if given widget has user input focus.
 
void SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat)
 Sets the lowered/raised status of a widget.
 
void ToggleWidgetLoweredState (WidgetID widget_index)
 Invert the lowered/raised status of a widget.
 
void LowerWidget (WidgetID widget_index)
 Marks a widget as lowered.
 
void RaiseWidget (WidgetID widget_index)
 Marks a widget as raised.
 
void RaiseWidgetWhenLowered (WidgetID widget_index)
 Marks a widget as raised and dirty (redraw), when it is marked as lowered.
 
bool IsWidgetLowered (WidgetID widget_index) const
 Gets the lowered state of a widget.
 
void UnfocusFocusedWidget ()
 Makes no widget on this window have focus.
 
bool SetFocusedWidget (WidgetID widget_index)
 Set focus within this window to the given widget.
 
EventState HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode)
 Process keypress for editbox widget.
 
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.
 
void HandleButtonClick (WidgetID widget)
 Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
 
int GetRowFromWidget (int clickpos, WidgetID 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.
 
template<typename... Args>
void SetWidgetsDisabledState (bool disab_stat, Args... widgets)
 Sets the enabled/disabled status of a list of widgets.
 
template<typename... Args>
void SetWidgetsLoweredState (bool lowered_stat, Args... widgets)
 Sets the lowered/raised status of a list of widgets.
 
template<typename... Args>
void RaiseWidgetsWhenLowered (Args... widgets)
 Raises the widgets and sets widgets dirty that are lowered.
 
void SetWidgetDirty (WidgetID 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 (WidgetID widget, SortButtonState state) const
 Draw a sort button's up or down arrow symbol.
 
WindowFindChildWindow (WindowClass wc=WC_INVALID) const
 Find the Window whose parent pointer points to this window.
 
void CloseChildWindows (WindowClass wc=WC_INVALID) const
 Close all children a window might have in a head-recursive manner.
 
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.
 
bool IsShaded () const
 Is window shaded currently?
 
void SetShaded (bool make_shaded)
 Set the shaded state of the window to make_shaded.
 
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)
 
void ProcessScheduledInvalidations ()
 Process all scheduled invalidations.
 
void ProcessHighlightedInvalidations ()
 Process all invalidation of highlighted widgets.
 
virtual void OnInit ()
 Notification that the nested widget tree gets initialized.
 
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.
 
virtual void OnPaint ()
 The window must be repainted.
 
virtual void SetStringParameters (WidgetID widget) const
 Initialize string parameters for a widget.
 
virtual void OnFocus ()
 The window has gained focus.
 
virtual void OnFocusLost (bool closing)
 The window has lost focus.
 
virtual EventState OnKeyPress (char32_t key, uint16_t 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 bool OnRightClick (Point pt, WidgetID widget)
 A click with the right mouse button has been made on the window.
 
virtual void OnHover (Point pt, WidgetID widget)
 The mouse is hovering over a widget in the window, perform an action for it.
 
virtual bool OnTooltip (Point pt, WidgetID widget, TooltipCloseCondition close_cond)
 Event to display a custom tooltip.
 
virtual void OnMouseDrag (Point pt, WidgetID widget)
 An 'object' is being dragged at the provided position, highlight the target if possible.
 
virtual void OnDragDrop (Point pt, WidgetID widget)
 A dragged 'object' has been released.
 
virtual void OnScroll (Point delta)
 Handle the request for (viewport) scrolling.
 
virtual void OnMouseOver (Point pt, WidgetID widget)
 The mouse is currently moving over the window or has just moved outside of the window.
 
virtual void OnMouseWheel (int wheel)
 The mouse wheel has been turned.
 
virtual void OnMouseLoop ()
 Called for every mouse loop run, which is at least once per (game) tick.
 
virtual void OnRealtimeTick (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.
 
virtual void OnDropdownSelect (WidgetID widget, int index)
 A dropdown option associated to this window has been selected.
 
virtual void OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close)
 A dropdown window associated to this window has been closed.
 
virtual void OnEditboxChanged (WidgetID widget)
 The text in an editbox has been edited.
 
virtual void OnQueryTextFinished (std::optional< std::string > 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 bool OnVehicleSelect (VehicleList::const_iterator begin, VehicleList::const_iterator end)
 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.
 
template<>
const NWidgetBaseGetWidget (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.
 
void * operator new[] (size_t size)
 Memory allocator for an array of class instances.
 
void operator delete (void *ptr)
 Memory release for a single class instance.
 
void operator delete[] (void *ptr)
 Memory release for an array of class instances.
 

Protected Member Functions

std::span< const OverflowSafeInt64GetDataSetRange (const DataSet &dataset) const
 Get appropriate part of dataset values for the current number of horizontal points.
 
ValuesInterval GetValuesInterval (int num_hori_lines) const
 Get the interval that contains the graph's data.
 
uint GetYLabelWidth (ValuesInterval current_interval, int num_hori_lines) const
 Get width for Y labels.
 
void DrawGraph (Rect r) const
 Actually draw the graph.
 
 BaseGraphWindow (WindowDesc &desc, StringID format_str_y_axis)
 
void InitializeWindow (WindowNumber number)
 
- 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.
 
virtual ~Window ()
 Remove window and all its child windows from the window stack.
 

Protected Attributes

uint64_t excluded_data
 bitmask of the datasets that shouldn't be displayed.
 
uint64_t excluded_range
 bitmask of ranges that should not be displayed.
 
uint8_t num_on_x_axis
 
uint8_t num_vert_lines
 
TimerGameEconomy::Month month
 
TimerGameEconomy::Year year
 
uint8_t month_increment
 month increment between vertical lines. must be divisor of 12.
 
bool draw_dates = true
 Should we draw months and years on the time axis?
 
uint16_t x_values_start
 
uint16_t x_values_increment
 
StringID format_str_y_axis
 
std::vector< DataSetdata
 
std::span< const StringIDranges = {}
 
- Protected Attributes inherited from Window
std::vector< intscheduled_invalidation_data
 Data of scheduled OnInvalidateData() calls.
 
bool scheduled_resize
 Set if window has been resized.
 

Static Protected Attributes

static const int GRAPH_MAX_DATASETS = 64
 
static const int GRAPH_BASE_COLOUR = GREY_SCALE(2)
 
static const int GRAPH_GRID_COLOUR = GREY_SCALE(3)
 
static const int GRAPH_AXIS_LINE_COLOUR = GREY_SCALE(1)
 
static const int GRAPH_ZERO_LINE_COLOUR = GREY_SCALE(8)
 
static const int GRAPH_YEAR_LINE_COLOUR = GREY_SCALE(5)
 
static const int GRAPH_NUM_MONTHS = 24
 Number of months displayed in the graph.
 
static const int PAYMENT_GRAPH_X_STEP_DAYS = 10
 X-axis step label for cargo payment rates "Days in transit".
 
static const int PAYMENT_GRAPH_X_STEP_SECONDS = 20
 X-axis step label for cargo payment rates "Seconds in transit".
 
static const int ECONOMY_QUARTER_MINUTES = 3
 Minutes per economic quarter.
 
static const int ECONOMY_MONTH_MINUTES = 1
 Minutes per economic month.
 
static const TextColour GRAPH_AXIS_LABEL_COLOUR = TC_BLACK
 colour of the graph axis label.
 
static const int MIN_GRAPH_NUM_LINES_Y = 9
 Minimal number of horizontal lines to draw.
 
static const int MIN_GRID_PIXEL_SIZE = 20
 Minimum distance between graph lines.
 

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.
 
static void DeleteClosedWindows ()
 Delete all closed windows.
 
- 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.
 
int scale
 Scale of this window – used to determine how to resize.
 
uint8_t timeout_timer
 Timer value of the WindowFlag::Timeout for flags.
 
uint8_t white_border_timer
 Timer value of the WindowFlag::WhiteBorder 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 nullptr if no nested widget has focus.
 
std::map< WidgetID, QueryString * > querystrings
 QueryString associated to WWT_EDITBOX widgets.
 
std::unique_ptr< NWidgetBasenested_root
 Root of the nested tree.
 
WidgetLookup widget_lookup
 Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
 
NWidgetStackedshade_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.
 
Windowparent
 Parent window.
 
WindowList::iterator z_position
 

Detailed Description

Definition at line 168 of file graph_gui.cpp.

Constructor & Destructor Documentation

◆ BaseGraphWindow()

BaseGraphWindow::BaseGraphWindow ( WindowDesc desc,
StringID  format_str_y_axis 
)
inlineprotected

Definition at line 517 of file graph_gui.cpp.

Member Function Documentation

◆ DrawGraph()

void BaseGraphWindow::DrawGraph ( Rect  r) const
inlineprotected

Actually draw the graph.

Parameters
rthe rectangle of the data field of the graph

< Reused whenever x and y coordinates are needed.

< Interval that contains all of the graph data.

< Distance from the top of the graph to the x axis.

Definition at line 327 of file graph_gui.cpp.

References _settings_client, abs(), DrawString(), DrawStringMultiLine(), FS_SMALL, GetCharacterHeight(), GetDataSetRange(), GetValuesInterval(), Window::GetWidget(), GetYLabelWidth(), GfxFillRect(), GRAPH_AXIS_LABEL_COLOUR, GUISettings::graph_line_thickness, ClientSettings::gui, HasBit(), Window::height, ValuesInterval::highest, ValuesInterval::lowest, MAX_COMPANIES, MIN_GRID_PIXEL_SIZE, month_increment, NUM_CARGO, Window::resize, SA_HOR_CENTER, SA_LEFT, SA_RIGHT, ScaleGUITrad(), SetDParam(), and TimerGameEconomy::UsingWallclockUnits().

Referenced by DrawWidget().

◆ DrawWidget()

void BaseGraphWindow::DrawWidget ( const Rect r,
WidgetID  widget 
) const
inlineoverridevirtual

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.

Reimplemented in PaymentRatesGraphWindow, and IndustryProductionGraphWindow.

Definition at line 599 of file graph_gui.cpp.

References DrawFrameRect(), DrawGraph(), DrawString(), WidgetDimensions::framerect, FS_SMALL, GetCharacterHeight(), Window::GetWidget(), HasBit(), Lowered, SA_CENTER, WidgetDimensions::scaled, Rect::Shrink(), Rect::Translate(), RectPadding::Vertical(), WID_GRAPH_GRAPH, WID_GRAPH_RANGE_MATRIX, and Rect::WithHeight().

Referenced by PaymentRatesGraphWindow::DrawWidget(), and IndustryProductionGraphWindow::DrawWidget().

◆ GetDataSetRange()

std::span< const OverflowSafeInt64 > BaseGraphWindow::GetDataSetRange ( const DataSet dataset) const
inlineprotected

Get appropriate part of dataset values for the current number of horizontal points.

Parameters
datasetDataset to get values of
Returns
span covering dataset's current valid range.

Definition at line 222 of file graph_gui.cpp.

References Window::GetWidget().

Referenced by DrawGraph(), and GetValuesInterval().

◆ GetGraphData()

virtual OverflowSafeInt64 BaseGraphWindow::GetGraphData ( const Company ,
int   
)
inlinevirtual

Definition at line 629 of file graph_gui.cpp.

◆ GetValuesInterval()

ValuesInterval BaseGraphWindow::GetValuesInterval ( int  num_hori_lines) const
inlineprotected

Get the interval that contains the graph's data.

Excluded data is ignored to show smaller values in better detail when disabling higher ones.

Parameters
num_hori_linesNumber of horizontal lines to be drawn.
Returns
Highest and lowest values of the graph (ignoring disabled data).

Definition at line 233 of file graph_gui.cpp.

References abs(), GetDataSetRange(), Window::GetWidget(), HasBit(), ValuesInterval::highest, and INT64_MAX_IN_DOUBLE.

Referenced by DrawGraph().

◆ GetYLabelWidth()

uint BaseGraphWindow::GetYLabelWidth ( ValuesInterval  current_interval,
int  num_hori_lines 
) const
inlineprotected

Get width for Y labels.

Parameters
current_intervalInterval that contains all of the graph data.
num_hori_linesNumber of horizontal lines to be drawn.

Definition at line 303 of file graph_gui.cpp.

References GetStringBoundingBox(), Window::GetWidget(), and SetDParam().

Referenced by DrawGraph().

◆ InitializeWindow()

void BaseGraphWindow::InitializeWindow ( WindowNumber  number)
inlineprotected

Definition at line 526 of file graph_gui.cpp.

◆ OnClick()

void BaseGraphWindow::OnClick ( Point  pt,
WidgetID  widget,
int  click_count 
)
inlineoverridevirtual

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

Parameters
ptthe point inside the window that has been clicked.
widgetthe clicked widget.
click_countNumber of fast consecutive clicks at same position

Reimplemented from Window.

Reimplemented in PerformanceHistoryGraphWindow, PaymentRatesGraphWindow, and IndustryProductionGraphWindow.

Definition at line 634 of file graph_gui.cpp.

References FS_SMALL, GetCharacterHeight(), Window::GetRowFromWidget(), Window::GetWidget(), WidgetDimensions::scaled, Window::SetDirty(), ToggleBit(), WID_GRAPH_KEY_BUTTON, and WID_GRAPH_RANGE_MATRIX.

Referenced by PerformanceHistoryGraphWindow::OnClick(), PaymentRatesGraphWindow::OnClick(), and IndustryProductionGraphWindow::OnClick().

◆ OnGameTick()

void BaseGraphWindow::OnGameTick ( )
inlineoverridevirtual

Called once per (game) tick.

Reimplemented from Window.

Reimplemented in PaymentRatesGraphWindow.

Definition at line 654 of file graph_gui.cpp.

References UpdateStatistics().

◆ OnInvalidateData()

void BaseGraphWindow::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
)
inlineoverridevirtual

Some data on this window has become invalid.

Parameters
dataInformation about the changed data.
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.

Reimplemented in PaymentRatesGraphWindow.

Definition at line 664 of file graph_gui.cpp.

References Window::GetWidget(), and UpdateStatistics().

◆ UpdateStatistics()

◆ UpdateWidgetSize()

void BaseGraphWindow::UpdateWidgetSize ( WidgetID  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
)
inlineoverridevirtual

Update size and resize step of a widget in the window.

After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.

Parameters
widgetWidget number.
[in,out]sizeSize of the widget.
paddingRecommended amount of space between the widget content and the widget edge.
[in,out]fillFill step of the widget.
[in,out]resizeResize step of the widget.

Reimplemented from Window.

Reimplemented in PaymentRatesGraphWindow, and IndustryProductionGraphWindow.

Definition at line 542 of file graph_gui.cpp.

References WidgetDimensions::framerect, FS_SMALL, GetCharacterHeight(), GetStringBoundingBox(), Window::GetWidget(), RectPadding::Horizontal(), maxdim(), MIN_GRAPH_NUM_LINES_Y, month_increment, Window::resize, WidgetDimensions::scaled, ScaleGUITrad(), SetDParam(), SetDParamMaxValue(), RectPadding::Vertical(), WID_GRAPH_GRAPH, WID_GRAPH_RANGE_MATRIX, and Window::width.

Referenced by PaymentRatesGraphWindow::UpdateWidgetSize(), and IndustryProductionGraphWindow::UpdateWidgetSize().

Field Documentation

◆ data

std::vector<DataSet> BaseGraphWindow::data
protected

Definition at line 213 of file graph_gui.cpp.

◆ draw_dates

bool BaseGraphWindow::draw_dates = true
protected

Should we draw months and years on the time axis?

Definition at line 197 of file graph_gui.cpp.

◆ ECONOMY_MONTH_MINUTES

const int BaseGraphWindow::ECONOMY_MONTH_MINUTES = 1
staticprotected

Minutes per economic month.

Definition at line 180 of file graph_gui.cpp.

◆ ECONOMY_QUARTER_MINUTES

const int BaseGraphWindow::ECONOMY_QUARTER_MINUTES = 3
staticprotected

Minutes per economic quarter.

Definition at line 179 of file graph_gui.cpp.

◆ excluded_data

uint64_t BaseGraphWindow::excluded_data
protected

bitmask of the datasets that shouldn't be displayed.

Definition at line 187 of file graph_gui.cpp.

Referenced by IndustryProductionGraphWindow::UpdateStatistics().

◆ excluded_range

uint64_t BaseGraphWindow::excluded_range
protected

bitmask of ranges that should not be displayed.

Definition at line 188 of file graph_gui.cpp.

◆ format_str_y_axis

StringID BaseGraphWindow::format_str_y_axis
protected

Definition at line 204 of file graph_gui.cpp.

◆ GRAPH_AXIS_LABEL_COLOUR

const TextColour BaseGraphWindow::GRAPH_AXIS_LABEL_COLOUR = TC_BLACK
staticprotected

colour of the graph axis label.

Definition at line 182 of file graph_gui.cpp.

Referenced by DrawGraph().

◆ GRAPH_AXIS_LINE_COLOUR

const int BaseGraphWindow::GRAPH_AXIS_LINE_COLOUR = GREY_SCALE(1)
staticprotected

Definition at line 173 of file graph_gui.cpp.

◆ GRAPH_BASE_COLOUR

const int BaseGraphWindow::GRAPH_BASE_COLOUR = GREY_SCALE(2)
staticprotected

Definition at line 171 of file graph_gui.cpp.

◆ GRAPH_GRID_COLOUR

const int BaseGraphWindow::GRAPH_GRID_COLOUR = GREY_SCALE(3)
staticprotected

Definition at line 172 of file graph_gui.cpp.

◆ GRAPH_MAX_DATASETS

const int BaseGraphWindow::GRAPH_MAX_DATASETS = 64
staticprotected

Definition at line 170 of file graph_gui.cpp.

◆ GRAPH_NUM_MONTHS

const int BaseGraphWindow::GRAPH_NUM_MONTHS = 24
staticprotected

Number of months displayed in the graph.

Definition at line 176 of file graph_gui.cpp.

Referenced by IndustryProductionGraphWindow::UpdateStatistics().

◆ GRAPH_YEAR_LINE_COLOUR

const int BaseGraphWindow::GRAPH_YEAR_LINE_COLOUR = GREY_SCALE(5)
staticprotected

Definition at line 175 of file graph_gui.cpp.

◆ GRAPH_ZERO_LINE_COLOUR

const int BaseGraphWindow::GRAPH_ZERO_LINE_COLOUR = GREY_SCALE(8)
staticprotected

Definition at line 174 of file graph_gui.cpp.

◆ MIN_GRAPH_NUM_LINES_Y

const int BaseGraphWindow::MIN_GRAPH_NUM_LINES_Y = 9
staticprotected

Minimal number of horizontal lines to draw.

Definition at line 184 of file graph_gui.cpp.

Referenced by UpdateWidgetSize().

◆ MIN_GRID_PIXEL_SIZE

const int BaseGraphWindow::MIN_GRID_PIXEL_SIZE = 20
staticprotected

Minimum distance between graph lines.

Definition at line 185 of file graph_gui.cpp.

Referenced by DrawGraph().

◆ month

TimerGameEconomy::Month BaseGraphWindow::month
protected

Definition at line 193 of file graph_gui.cpp.

◆ month_increment

uint8_t BaseGraphWindow::month_increment
protected

month increment between vertical lines. must be divisor of 12.

Definition at line 195 of file graph_gui.cpp.

Referenced by DrawGraph(), and UpdateWidgetSize().

◆ num_on_x_axis

uint8_t BaseGraphWindow::num_on_x_axis
protected

Definition at line 189 of file graph_gui.cpp.

◆ num_vert_lines

uint8_t BaseGraphWindow::num_vert_lines
protected

Definition at line 190 of file graph_gui.cpp.

◆ PAYMENT_GRAPH_X_STEP_DAYS

const int BaseGraphWindow::PAYMENT_GRAPH_X_STEP_DAYS = 10
staticprotected

X-axis step label for cargo payment rates "Days in transit".

Definition at line 177 of file graph_gui.cpp.

◆ PAYMENT_GRAPH_X_STEP_SECONDS

const int BaseGraphWindow::PAYMENT_GRAPH_X_STEP_SECONDS = 20
staticprotected

X-axis step label for cargo payment rates "Seconds in transit".

Definition at line 178 of file graph_gui.cpp.

◆ ranges

std::span<const StringID> BaseGraphWindow::ranges = {}
protected

Definition at line 215 of file graph_gui.cpp.

◆ x_values_increment

uint16_t BaseGraphWindow::x_values_increment
protected

Definition at line 202 of file graph_gui.cpp.

◆ x_values_start

uint16_t BaseGraphWindow::x_values_start
protected

Definition at line 201 of file graph_gui.cpp.

◆ year

TimerGameEconomy::Year BaseGraphWindow::year
protected

Definition at line 194 of file graph_gui.cpp.


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