Feature: Wide rivers
[openttd-github.git] / src / graph_gui.cpp
blobe5e09aa66bb4c3fc471f8731932206652cdac7ae
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file graph_gui.cpp GUI that shows performance graphs. */
10 #include "stdafx.h"
11 #include "graph_gui.h"
12 #include "window_gui.h"
13 #include "company_base.h"
14 #include "company_gui.h"
15 #include "economy_func.h"
16 #include "cargotype.h"
17 #include "strings_func.h"
18 #include "window_func.h"
19 #include "date_func.h"
20 #include "gfx_func.h"
21 #include "sortlist_type.h"
22 #include "core/geometry_func.hpp"
23 #include "currency.h"
24 #include "zoom_func.h"
26 #include "widgets/graph_widget.h"
28 #include "table/strings.h"
29 #include "table/sprites.h"
30 #include <math.h>
32 #include "safeguards.h"
34 /* Bitmasks of company and cargo indices that shouldn't be drawn. */
35 static CompanyMask _legend_excluded_companies;
36 static CargoTypes _legend_excluded_cargo;
38 /* Apparently these don't play well with enums. */
39 static const OverflowSafeInt64 INVALID_DATAPOINT(INT64_MAX); // Value used for a datapoint that shouldn't be drawn.
40 static const uint INVALID_DATAPOINT_POS = UINT_MAX; // Used to determine if the previous point was drawn.
42 /****************/
43 /* GRAPH LEGEND */
44 /****************/
46 struct GraphLegendWindow : Window {
47 GraphLegendWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
49 this->InitNested(window_number);
51 for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
52 if (!HasBit(_legend_excluded_companies, c)) this->LowerWidget(c + WID_GL_FIRST_COMPANY);
54 this->OnInvalidateData(c);
58 void DrawWidget(const Rect &r, int widget) const override
60 if (!IsInsideMM(widget, WID_GL_FIRST_COMPANY, MAX_COMPANIES + WID_GL_FIRST_COMPANY)) return;
62 CompanyID cid = (CompanyID)(widget - WID_GL_FIRST_COMPANY);
64 if (!Company::IsValidID(cid)) return;
66 bool rtl = _current_text_dir == TD_RTL;
68 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
69 DrawCompanyIcon(cid, rtl ? r.right - d.width - ScaleGUITrad(2) : r.left + ScaleGUITrad(2), CenterBounds(r.top, r.bottom, d.height));
71 SetDParam(0, cid);
72 SetDParam(1, cid);
73 DrawString(r.left + (rtl ? (uint)WD_FRAMERECT_LEFT : (d.width + ScaleGUITrad(4))), r.right - (rtl ? (d.width + ScaleGUITrad(4)) : (uint)WD_FRAMERECT_RIGHT), CenterBounds(r.top, r.bottom, FONT_HEIGHT_NORMAL), STR_COMPANY_NAME_COMPANY_NUM, HasBit(_legend_excluded_companies, cid) ? TC_BLACK : TC_WHITE);
76 void OnClick(Point pt, int widget, int click_count) override
78 if (!IsInsideMM(widget, WID_GL_FIRST_COMPANY, MAX_COMPANIES + WID_GL_FIRST_COMPANY)) return;
80 ToggleBit(_legend_excluded_companies, widget - WID_GL_FIRST_COMPANY);
81 this->ToggleWidgetLoweredState(widget);
82 this->SetDirty();
83 InvalidateWindowData(WC_INCOME_GRAPH, 0);
84 InvalidateWindowData(WC_OPERATING_PROFIT, 0);
85 InvalidateWindowData(WC_DELIVERED_CARGO, 0);
86 InvalidateWindowData(WC_PERFORMANCE_HISTORY, 0);
87 InvalidateWindowData(WC_COMPANY_VALUE, 0);
90 /**
91 * Some data on this window has become invalid.
92 * @param data Information about the changed data.
93 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
95 void OnInvalidateData(int data = 0, bool gui_scope = true) override
97 if (!gui_scope) return;
98 if (Company::IsValidID(data)) return;
100 SetBit(_legend_excluded_companies, data);
101 this->RaiseWidget(data + WID_GL_FIRST_COMPANY);
106 * Construct a vertical list of buttons, one for each company.
107 * @param biggest_index Storage for collecting the biggest index used in the returned tree.
108 * @return Panel with company buttons.
109 * @post \c *biggest_index contains the largest used index in the tree.
111 static NWidgetBase *MakeNWidgetCompanyLines(int *biggest_index)
113 NWidgetVertical *vert = new NWidgetVertical(NC_EQUALSIZE);
114 vert->SetPadding(2, 2, 2, 2);
115 uint sprite_height = GetSpriteSize(SPR_COMPANY_ICON, nullptr, ZOOM_LVL_OUT_4X).height;
117 for (int widnum = WID_GL_FIRST_COMPANY; widnum <= WID_GL_LAST_COMPANY; widnum++) {
118 NWidgetBackground *panel = new NWidgetBackground(WWT_PANEL, COLOUR_BROWN, widnum);
119 panel->SetMinimalSize(246, sprite_height + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM);
120 panel->SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM, FS_NORMAL);
121 panel->SetFill(1, 1);
122 panel->SetDataTip(0x0, STR_GRAPH_KEY_COMPANY_SELECTION_TOOLTIP);
123 vert->Add(panel);
125 *biggest_index = WID_GL_LAST_COMPANY;
126 return vert;
129 static const NWidgetPart _nested_graph_legend_widgets[] = {
130 NWidget(NWID_HORIZONTAL),
131 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
132 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_KEY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
133 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
134 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
135 EndContainer(),
136 NWidget(WWT_PANEL, COLOUR_BROWN, WID_GL_BACKGROUND),
137 NWidgetFunction(MakeNWidgetCompanyLines),
138 EndContainer(),
141 static WindowDesc _graph_legend_desc(
142 WDP_AUTO, "graph_legend", 0, 0,
143 WC_GRAPH_LEGEND, WC_NONE,
145 _nested_graph_legend_widgets, lengthof(_nested_graph_legend_widgets)
148 static void ShowGraphLegend()
150 AllocateWindowDescFront<GraphLegendWindow>(&_graph_legend_desc, 0);
153 /** Contains the interval of a graph's data. */
154 struct ValuesInterval {
155 OverflowSafeInt64 highest; ///< Highest value of this interval. Must be zero or greater.
156 OverflowSafeInt64 lowest; ///< Lowest value of this interval. Must be zero or less.
159 /******************/
160 /* BASE OF GRAPHS */
161 /*****************/
163 struct BaseGraphWindow : Window {
164 protected:
165 static const int GRAPH_MAX_DATASETS = 64;
166 static const int GRAPH_BASE_COLOUR = GREY_SCALE(2);
167 static const int GRAPH_GRID_COLOUR = GREY_SCALE(3);
168 static const int GRAPH_AXIS_LINE_COLOUR = GREY_SCALE(1);
169 static const int GRAPH_ZERO_LINE_COLOUR = GREY_SCALE(8);
170 static const int GRAPH_YEAR_LINE_COLOUR = GREY_SCALE(5);
171 static const int GRAPH_NUM_MONTHS = 24; ///< Number of months displayed in the graph.
173 static const TextColour GRAPH_AXIS_LABEL_COLOUR = TC_BLACK; ///< colour of the graph axis label.
175 static const int MIN_GRAPH_NUM_LINES_Y = 9; ///< Minimal number of horizontal lines to draw.
176 static const int MIN_GRID_PIXEL_SIZE = 20; ///< Minimum distance between graph lines.
178 uint64 excluded_data; ///< bitmask of the datasets that shouldn't be displayed.
179 byte num_dataset;
180 byte num_on_x_axis;
181 byte num_vert_lines;
183 /* The starting month and year that values are plotted against. If month is
184 * 0xFF, use x_values_start and x_values_increment below instead. */
185 byte month;
186 Year year;
188 /* These values are used if the graph is being plotted against values
189 * rather than the dates specified by month and year. */
190 uint16 x_values_start;
191 uint16 x_values_increment;
193 int graph_widget;
194 StringID format_str_y_axis;
195 byte colours[GRAPH_MAX_DATASETS];
196 OverflowSafeInt64 cost[GRAPH_MAX_DATASETS][GRAPH_NUM_MONTHS]; ///< Stored costs for the last #GRAPH_NUM_MONTHS months
199 * Get the interval that contains the graph's data. Excluded data is ignored to show smaller values in
200 * better detail when disabling higher ones.
201 * @param num_hori_lines Number of horizontal lines to be drawn.
202 * @return Highest and lowest values of the graph (ignoring disabled data).
204 ValuesInterval GetValuesInterval(int num_hori_lines) const
206 assert(num_hori_lines > 0);
208 ValuesInterval current_interval;
209 current_interval.highest = INT64_MIN;
210 current_interval.lowest = INT64_MAX;
212 for (int i = 0; i < this->num_dataset; i++) {
213 if (HasBit(this->excluded_data, i)) continue;
214 for (int j = 0; j < this->num_on_x_axis; j++) {
215 OverflowSafeInt64 datapoint = this->cost[i][j];
217 if (datapoint != INVALID_DATAPOINT) {
218 current_interval.highest = std::max(current_interval.highest, datapoint);
219 current_interval.lowest = std::min(current_interval.lowest, datapoint);
224 /* Prevent showing values too close to the graph limits. */
225 current_interval.highest = (11 * current_interval.highest) / 10;
226 current_interval.lowest = (11 * current_interval.lowest) / 10;
228 /* Always include zero in the shown range. */
229 double abs_lower = (current_interval.lowest > 0) ? 0 : (double)abs(current_interval.lowest);
230 double abs_higher = (current_interval.highest < 0) ? 0 : (double)current_interval.highest;
232 int num_pos_grids;
233 int64 grid_size;
235 if (abs_lower != 0 || abs_higher != 0) {
236 /* The number of grids to reserve for the positive part is: */
237 num_pos_grids = (int)floor(0.5 + num_hori_lines * abs_higher / (abs_higher + abs_lower));
239 /* If there are any positive or negative values, force that they have at least one grid. */
240 if (num_pos_grids == 0 && abs_higher != 0) num_pos_grids++;
241 if (num_pos_grids == num_hori_lines && abs_lower != 0) num_pos_grids--;
243 /* Get the required grid size for each side and use the maximum one. */
244 int64 grid_size_higher = (abs_higher > 0) ? ((int64)abs_higher + num_pos_grids - 1) / num_pos_grids : 0;
245 int64 grid_size_lower = (abs_lower > 0) ? ((int64)abs_lower + num_hori_lines - num_pos_grids - 1) / (num_hori_lines - num_pos_grids) : 0;
246 grid_size = std::max(grid_size_higher, grid_size_lower);
247 } else {
248 /* If both values are zero, show an empty graph. */
249 num_pos_grids = num_hori_lines / 2;
250 grid_size = 1;
253 current_interval.highest = num_pos_grids * grid_size;
254 current_interval.lowest = -(num_hori_lines - num_pos_grids) * grid_size;
255 return current_interval;
259 * Get width for Y labels.
260 * @param current_interval Interval that contains all of the graph data.
261 * @param num_hori_lines Number of horizontal lines to be drawn.
263 uint GetYLabelWidth(ValuesInterval current_interval, int num_hori_lines) const
265 /* draw text strings on the y axis */
266 int64 y_label = current_interval.highest;
267 int64 y_label_separation = (current_interval.highest - current_interval.lowest) / num_hori_lines;
269 uint max_width = 0;
271 for (int i = 0; i < (num_hori_lines + 1); i++) {
272 SetDParam(0, this->format_str_y_axis);
273 SetDParam(1, y_label);
274 Dimension d = GetStringBoundingBox(STR_GRAPH_Y_LABEL);
275 if (d.width > max_width) max_width = d.width;
277 y_label -= y_label_separation;
280 return max_width;
284 * Actually draw the graph.
285 * @param r the rectangle of the data field of the graph
287 void DrawGraph(Rect r) const
289 uint x, y; ///< Reused whenever x and y coordinates are needed.
290 ValuesInterval interval; ///< Interval that contains all of the graph data.
291 int x_axis_offset; ///< Distance from the top of the graph to the x axis.
293 /* the colours and cost array of GraphDrawer must accommodate
294 * both values for cargo and companies. So if any are higher, quit */
295 static_assert(GRAPH_MAX_DATASETS >= (int)NUM_CARGO && GRAPH_MAX_DATASETS >= (int)MAX_COMPANIES);
296 assert(this->num_vert_lines > 0);
298 /* Rect r will be adjusted to contain just the graph, with labels being
299 * placed outside the area. */
300 r.top += 5 + GetCharacterHeight(FS_SMALL) / 2;
301 r.bottom -= (this->month == 0xFF ? 1 : 2) * GetCharacterHeight(FS_SMALL) + 4;
302 r.left += 9;
303 r.right -= 5;
305 /* Initial number of horizontal lines. */
306 int num_hori_lines = 160 / MIN_GRID_PIXEL_SIZE;
307 /* For the rest of the height, the number of horizontal lines will increase more slowly. */
308 int resize = (r.bottom - r.top - 160) / (2 * MIN_GRID_PIXEL_SIZE);
309 if (resize > 0) num_hori_lines += resize;
311 interval = GetValuesInterval(num_hori_lines);
313 int label_width = GetYLabelWidth(interval, num_hori_lines);
315 r.left += label_width;
317 int x_sep = (r.right - r.left) / this->num_vert_lines;
318 int y_sep = (r.bottom - r.top) / num_hori_lines;
320 /* Redetermine right and bottom edge of graph to fit with the integer
321 * separation values. */
322 r.right = r.left + x_sep * this->num_vert_lines;
323 r.bottom = r.top + y_sep * num_hori_lines;
325 OverflowSafeInt64 interval_size = interval.highest + abs(interval.lowest);
326 /* Where to draw the X axis. Use floating point to avoid overflowing and results of zero. */
327 x_axis_offset = (int)((r.bottom - r.top) * (double)interval.highest / (double)interval_size);
329 /* Draw the background of the graph itself. */
330 GfxFillRect(r.left, r.top, r.right, r.bottom, GRAPH_BASE_COLOUR);
332 /* Draw the vertical grid lines. */
334 /* Don't draw the first line, as that's where the axis will be. */
335 x = r.left + x_sep;
337 for (int i = 0; i < this->num_vert_lines; i++) {
338 GfxFillRect(x, r.top, x, r.bottom, GRAPH_GRID_COLOUR);
339 x += x_sep;
342 /* Draw the horizontal grid lines. */
343 y = r.bottom;
345 for (int i = 0; i < (num_hori_lines + 1); i++) {
346 GfxFillRect(r.left - 3, y, r.left - 1, y, GRAPH_AXIS_LINE_COLOUR);
347 GfxFillRect(r.left, y, r.right, y, GRAPH_GRID_COLOUR);
348 y -= y_sep;
351 /* Draw the y axis. */
352 GfxFillRect(r.left, r.top, r.left, r.bottom, GRAPH_AXIS_LINE_COLOUR);
354 /* Draw the x axis. */
355 y = x_axis_offset + r.top;
356 GfxFillRect(r.left, y, r.right, y, GRAPH_ZERO_LINE_COLOUR);
358 /* Find the largest value that will be drawn. */
359 if (this->num_on_x_axis == 0) return;
361 assert(this->num_on_x_axis > 0);
362 assert(this->num_dataset > 0);
364 /* draw text strings on the y axis */
365 int64 y_label = interval.highest;
366 int64 y_label_separation = abs(interval.highest - interval.lowest) / num_hori_lines;
368 y = r.top - GetCharacterHeight(FS_SMALL) / 2;
370 for (int i = 0; i < (num_hori_lines + 1); i++) {
371 SetDParam(0, this->format_str_y_axis);
372 SetDParam(1, y_label);
373 DrawString(r.left - label_width - 4, r.left - 4, y, STR_GRAPH_Y_LABEL, GRAPH_AXIS_LABEL_COLOUR, SA_RIGHT);
375 y_label -= y_label_separation;
376 y += y_sep;
379 /* Draw x-axis labels and markings for graphs based on financial quarters and years. */
380 if (this->month != 0xFF) {
381 x = r.left;
382 y = r.bottom + 2;
383 byte month = this->month;
384 Year year = this->year;
385 for (int i = 0; i < this->num_on_x_axis; i++) {
386 SetDParam(0, month + STR_MONTH_ABBREV_JAN);
387 SetDParam(1, year);
388 DrawStringMultiLine(x, x + x_sep, y, this->height, month == 0 ? STR_GRAPH_X_LABEL_MONTH_YEAR : STR_GRAPH_X_LABEL_MONTH, GRAPH_AXIS_LABEL_COLOUR, SA_LEFT);
390 month += 3;
391 if (month >= 12) {
392 month = 0;
393 year++;
395 /* Draw a lighter grid line between years. Top and bottom adjustments ensure we don't draw over top and bottom horizontal grid lines. */
396 GfxFillRect(x + x_sep, r.top + 1, x + x_sep, r.bottom - 1, GRAPH_YEAR_LINE_COLOUR);
398 x += x_sep;
400 } else {
401 /* Draw x-axis labels for graphs not based on quarterly performance (cargo payment rates). */
402 x = r.left;
403 y = r.bottom + 2;
404 uint16 label = this->x_values_start;
406 for (int i = 0; i < this->num_on_x_axis; i++) {
407 SetDParam(0, label);
408 DrawString(x + 1, x + x_sep - 1, y, STR_GRAPH_Y_LABEL_NUMBER, GRAPH_AXIS_LABEL_COLOUR, SA_HOR_CENTER);
410 label += this->x_values_increment;
411 x += x_sep;
415 /* draw lines and dots */
416 uint linewidth = _settings_client.gui.graph_line_thickness;
417 uint pointoffs1 = (linewidth + 1) / 2;
418 uint pointoffs2 = linewidth + 1 - pointoffs1;
419 for (int i = 0; i < this->num_dataset; i++) {
420 if (!HasBit(this->excluded_data, i)) {
421 /* Centre the dot between the grid lines. */
422 x = r.left + (x_sep / 2);
424 byte colour = this->colours[i];
425 uint prev_x = INVALID_DATAPOINT_POS;
426 uint prev_y = INVALID_DATAPOINT_POS;
428 for (int j = 0; j < this->num_on_x_axis; j++) {
429 OverflowSafeInt64 datapoint = this->cost[i][j];
431 if (datapoint != INVALID_DATAPOINT) {
433 * Check whether we need to reduce the 'accuracy' of the
434 * datapoint value and the highest value to split overflows.
435 * And when 'drawing' 'one million' or 'one million and one'
436 * there is no significant difference, so the least
437 * significant bits can just be removed.
439 * If there are more bits needed than would fit in a 32 bits
440 * integer, so at about 31 bits because of the sign bit, the
441 * least significant bits are removed.
443 int mult_range = FindLastBit(x_axis_offset) + FindLastBit(abs(datapoint));
444 int reduce_range = std::max(mult_range - 31, 0);
446 /* Handle negative values differently (don't shift sign) */
447 if (datapoint < 0) {
448 datapoint = -(abs(datapoint) >> reduce_range);
449 } else {
450 datapoint >>= reduce_range;
452 y = r.top + x_axis_offset - ((r.bottom - r.top) * datapoint) / (interval_size >> reduce_range);
454 /* Draw the point. */
455 GfxFillRect(x - pointoffs1, y - pointoffs1, x + pointoffs2, y + pointoffs2, colour);
457 /* Draw the line connected to the previous point. */
458 if (prev_x != INVALID_DATAPOINT_POS) GfxDrawLine(prev_x, prev_y, x, y, colour, linewidth);
460 prev_x = x;
461 prev_y = y;
462 } else {
463 prev_x = INVALID_DATAPOINT_POS;
464 prev_y = INVALID_DATAPOINT_POS;
467 x += x_sep;
474 BaseGraphWindow(WindowDesc *desc, int widget, StringID format_str_y_axis) :
475 Window(desc),
476 format_str_y_axis(format_str_y_axis)
478 SetWindowDirty(WC_GRAPH_LEGEND, 0);
479 this->num_vert_lines = 24;
480 this->graph_widget = widget;
483 void InitializeWindow(WindowNumber number)
485 /* Initialise the dataset */
486 this->UpdateStatistics(true);
488 this->InitNested(number);
491 public:
492 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
494 if (widget != this->graph_widget) return;
496 uint x_label_width = 0;
498 /* Draw x-axis labels and markings for graphs based on financial quarters and years. */
499 if (this->month != 0xFF) {
500 byte month = this->month;
501 Year year = this->year;
502 for (int i = 0; i < this->num_on_x_axis; i++) {
503 SetDParam(0, month + STR_MONTH_ABBREV_JAN);
504 SetDParam(1, year);
505 x_label_width = std::max(x_label_width, GetStringBoundingBox(month == 0 ? STR_GRAPH_X_LABEL_MONTH_YEAR : STR_GRAPH_X_LABEL_MONTH).width);
507 month += 3;
508 if (month >= 12) {
509 month = 0;
510 year++;
513 } else {
514 /* Draw x-axis labels for graphs not based on quarterly performance (cargo payment rates). */
515 SetDParamMaxValue(0, this->x_values_start + this->num_on_x_axis * this->x_values_increment, 0, FS_SMALL);
516 x_label_width = GetStringBoundingBox(STR_GRAPH_Y_LABEL_NUMBER).width;
519 SetDParam(0, this->format_str_y_axis);
520 SetDParam(1, INT64_MAX);
521 uint y_label_width = GetStringBoundingBox(STR_GRAPH_Y_LABEL).width;
523 size->width = std::max<uint>(size->width, 5 + y_label_width + this->num_on_x_axis * (x_label_width + 5) + 9);
524 size->height = std::max<uint>(size->height, 5 + (1 + MIN_GRAPH_NUM_LINES_Y * 2 + (this->month != 0xFF ? 3 : 1)) * FONT_HEIGHT_SMALL + 4);
525 size->height = std::max<uint>(size->height, size->width / 3);
528 void DrawWidget(const Rect &r, int widget) const override
530 if (widget != this->graph_widget) return;
532 DrawGraph(r);
535 virtual OverflowSafeInt64 GetGraphData(const Company *c, int j)
537 return INVALID_DATAPOINT;
540 void OnClick(Point pt, int widget, int click_count) override
542 /* Clicked on legend? */
543 if (widget == WID_CV_KEY_BUTTON) ShowGraphLegend();
546 void OnGameTick() override
548 this->UpdateStatistics(false);
552 * Some data on this window has become invalid.
553 * @param data Information about the changed data.
554 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
556 void OnInvalidateData(int data = 0, bool gui_scope = true) override
558 if (!gui_scope) return;
559 this->UpdateStatistics(true);
563 * Update the statistics.
564 * @param initialize Initialize the data structure.
566 void UpdateStatistics(bool initialize)
568 CompanyMask excluded_companies = _legend_excluded_companies;
570 /* Exclude the companies which aren't valid */
571 for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
572 if (!Company::IsValidID(c)) SetBit(excluded_companies, c);
575 byte nums = 0;
576 for (const Company *c : Company::Iterate()) {
577 nums = std::min(this->num_vert_lines, std::max(nums, c->num_valid_stat_ent));
580 int mo = (_cur_month / 3 - nums) * 3;
581 int yr = _cur_year;
582 while (mo < 0) {
583 yr--;
584 mo += 12;
587 if (!initialize && this->excluded_data == excluded_companies && this->num_on_x_axis == nums &&
588 this->year == yr && this->month == mo) {
589 /* There's no reason to get new stats */
590 return;
593 this->excluded_data = excluded_companies;
594 this->num_on_x_axis = nums;
595 this->year = yr;
596 this->month = mo;
598 int numd = 0;
599 for (CompanyID k = COMPANY_FIRST; k < MAX_COMPANIES; k++) {
600 const Company *c = Company::GetIfValid(k);
601 if (c != nullptr) {
602 this->colours[numd] = _colour_gradient[c->colour][6];
603 for (int j = this->num_on_x_axis, i = 0; --j >= 0;) {
604 this->cost[numd][i] = (j >= c->num_valid_stat_ent) ? INVALID_DATAPOINT : GetGraphData(c, j);
605 i++;
608 numd++;
611 this->num_dataset = numd;
616 /********************/
617 /* OPERATING PROFIT */
618 /********************/
620 struct OperatingProfitGraphWindow : BaseGraphWindow {
621 OperatingProfitGraphWindow(WindowDesc *desc, WindowNumber window_number) :
622 BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
624 this->InitializeWindow(window_number);
627 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
629 return c->old_economy[j].income + c->old_economy[j].expenses;
633 static const NWidgetPart _nested_operating_profit_widgets[] = {
634 NWidget(NWID_HORIZONTAL),
635 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
636 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_OPERATING_PROFIT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
637 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_CV_KEY_BUTTON), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_GRAPH_KEY_BUTTON, STR_GRAPH_KEY_TOOLTIP),
638 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
639 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
640 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
641 EndContainer(),
642 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CV_BACKGROUND),
643 NWidget(NWID_HORIZONTAL),
644 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CV_GRAPH), SetMinimalSize(576, 160), SetFill(1, 1), SetResize(1, 1),
645 NWidget(NWID_VERTICAL),
646 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
647 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CV_RESIZE),
648 EndContainer(),
649 EndContainer(),
650 EndContainer(),
653 static WindowDesc _operating_profit_desc(
654 WDP_AUTO, "graph_operating_profit", 0, 0,
655 WC_OPERATING_PROFIT, WC_NONE,
657 _nested_operating_profit_widgets, lengthof(_nested_operating_profit_widgets)
661 void ShowOperatingProfitGraph()
663 AllocateWindowDescFront<OperatingProfitGraphWindow>(&_operating_profit_desc, 0);
667 /****************/
668 /* INCOME GRAPH */
669 /****************/
671 struct IncomeGraphWindow : BaseGraphWindow {
672 IncomeGraphWindow(WindowDesc *desc, WindowNumber window_number) :
673 BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
675 this->InitializeWindow(window_number);
678 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
680 return c->old_economy[j].income;
684 static const NWidgetPart _nested_income_graph_widgets[] = {
685 NWidget(NWID_HORIZONTAL),
686 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
687 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_INCOME_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
688 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_CV_KEY_BUTTON), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_GRAPH_KEY_BUTTON, STR_GRAPH_KEY_TOOLTIP),
689 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
690 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
691 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
692 EndContainer(),
693 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CV_BACKGROUND),
694 NWidget(NWID_HORIZONTAL),
695 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CV_GRAPH), SetMinimalSize(576, 128), SetFill(1, 1), SetResize(1, 1),
696 NWidget(NWID_VERTICAL),
697 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
698 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CV_RESIZE),
699 EndContainer(),
700 EndContainer(),
701 EndContainer(),
704 static WindowDesc _income_graph_desc(
705 WDP_AUTO, "graph_income", 0, 0,
706 WC_INCOME_GRAPH, WC_NONE,
708 _nested_income_graph_widgets, lengthof(_nested_income_graph_widgets)
711 void ShowIncomeGraph()
713 AllocateWindowDescFront<IncomeGraphWindow>(&_income_graph_desc, 0);
716 /*******************/
717 /* DELIVERED CARGO */
718 /*******************/
720 struct DeliveredCargoGraphWindow : BaseGraphWindow {
721 DeliveredCargoGraphWindow(WindowDesc *desc, WindowNumber window_number) :
722 BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_COMMA)
724 this->InitializeWindow(window_number);
727 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
729 return c->old_economy[j].delivered_cargo.GetSum<OverflowSafeInt64>();
733 static const NWidgetPart _nested_delivered_cargo_graph_widgets[] = {
734 NWidget(NWID_HORIZONTAL),
735 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
736 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_CARGO_DELIVERED_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
737 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_CV_KEY_BUTTON), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_GRAPH_KEY_BUTTON, STR_GRAPH_KEY_TOOLTIP),
738 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
739 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
740 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
741 EndContainer(),
742 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CV_BACKGROUND),
743 NWidget(NWID_HORIZONTAL),
744 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CV_GRAPH), SetMinimalSize(576, 128), SetFill(1, 1), SetResize(1, 1),
745 NWidget(NWID_VERTICAL),
746 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
747 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CV_RESIZE),
748 EndContainer(),
749 EndContainer(),
750 EndContainer(),
753 static WindowDesc _delivered_cargo_graph_desc(
754 WDP_AUTO, "graph_delivered_cargo", 0, 0,
755 WC_DELIVERED_CARGO, WC_NONE,
757 _nested_delivered_cargo_graph_widgets, lengthof(_nested_delivered_cargo_graph_widgets)
760 void ShowDeliveredCargoGraph()
762 AllocateWindowDescFront<DeliveredCargoGraphWindow>(&_delivered_cargo_graph_desc, 0);
765 /***********************/
766 /* PERFORMANCE HISTORY */
767 /***********************/
769 struct PerformanceHistoryGraphWindow : BaseGraphWindow {
770 PerformanceHistoryGraphWindow(WindowDesc *desc, WindowNumber window_number) :
771 BaseGraphWindow(desc, WID_PHG_GRAPH, STR_JUST_COMMA)
773 this->InitializeWindow(window_number);
776 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
778 return c->old_economy[j].performance_history;
781 void OnClick(Point pt, int widget, int click_count) override
783 if (widget == WID_PHG_DETAILED_PERFORMANCE) ShowPerformanceRatingDetail();
784 this->BaseGraphWindow::OnClick(pt, widget, click_count);
788 static const NWidgetPart _nested_performance_history_widgets[] = {
789 NWidget(NWID_HORIZONTAL),
790 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
791 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_COMPANY_PERFORMANCE_RATINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
792 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_PHG_DETAILED_PERFORMANCE), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_PERFORMANCE_DETAIL_KEY, STR_GRAPH_PERFORMANCE_DETAIL_TOOLTIP),
793 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_PHG_KEY), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_GRAPH_KEY_BUTTON, STR_GRAPH_KEY_TOOLTIP),
794 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
795 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
796 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
797 EndContainer(),
798 NWidget(WWT_PANEL, COLOUR_BROWN, WID_PHG_BACKGROUND),
799 NWidget(NWID_HORIZONTAL),
800 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_PHG_GRAPH), SetMinimalSize(576, 224), SetFill(1, 1), SetResize(1, 1),
801 NWidget(NWID_VERTICAL),
802 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
803 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_PHG_RESIZE),
804 EndContainer(),
805 EndContainer(),
806 EndContainer(),
809 static WindowDesc _performance_history_desc(
810 WDP_AUTO, "graph_performance", 0, 0,
811 WC_PERFORMANCE_HISTORY, WC_NONE,
813 _nested_performance_history_widgets, lengthof(_nested_performance_history_widgets)
816 void ShowPerformanceHistoryGraph()
818 AllocateWindowDescFront<PerformanceHistoryGraphWindow>(&_performance_history_desc, 0);
821 /*****************/
822 /* COMPANY VALUE */
823 /*****************/
825 struct CompanyValueGraphWindow : BaseGraphWindow {
826 CompanyValueGraphWindow(WindowDesc *desc, WindowNumber window_number) :
827 BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
829 this->InitializeWindow(window_number);
832 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
834 return c->old_economy[j].company_value;
838 static const NWidgetPart _nested_company_value_graph_widgets[] = {
839 NWidget(NWID_HORIZONTAL),
840 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
841 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_COMPANY_VALUES_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
842 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_CV_KEY_BUTTON), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_GRAPH_KEY_BUTTON, STR_GRAPH_KEY_TOOLTIP),
843 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
844 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
845 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
846 EndContainer(),
847 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CV_BACKGROUND),
848 NWidget(NWID_HORIZONTAL),
849 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CV_GRAPH), SetMinimalSize(576, 224), SetFill(1, 1), SetResize(1, 1),
850 NWidget(NWID_VERTICAL),
851 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
852 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CV_RESIZE),
853 EndContainer(),
854 EndContainer(),
855 EndContainer(),
858 static WindowDesc _company_value_graph_desc(
859 WDP_AUTO, "graph_company_value", 0, 0,
860 WC_COMPANY_VALUE, WC_NONE,
862 _nested_company_value_graph_widgets, lengthof(_nested_company_value_graph_widgets)
865 void ShowCompanyValueGraph()
867 AllocateWindowDescFront<CompanyValueGraphWindow>(&_company_value_graph_desc, 0);
870 /*****************/
871 /* PAYMENT RATES */
872 /*****************/
874 struct PaymentRatesGraphWindow : BaseGraphWindow {
875 uint line_height; ///< Pixel height of each cargo type row.
876 Scrollbar *vscroll; ///< Cargo list scrollbar.
877 uint legend_width; ///< Width of legend 'blob'.
879 PaymentRatesGraphWindow(WindowDesc *desc, WindowNumber window_number) :
880 BaseGraphWindow(desc, WID_CPR_GRAPH, STR_JUST_CURRENCY_SHORT)
882 this->num_on_x_axis = 20;
883 this->num_vert_lines = 20;
884 this->month = 0xFF;
885 this->x_values_start = 10;
886 this->x_values_increment = 10;
888 this->CreateNestedTree();
889 this->vscroll = this->GetScrollbar(WID_CPR_MATRIX_SCROLLBAR);
890 this->vscroll->SetCount(static_cast<int>(_sorted_standard_cargo_specs.size()));
892 /* Initialise the dataset */
893 this->OnHundredthTick();
895 this->FinishInitNested(window_number);
898 void OnInit() override
900 /* Width of the legend blob. */
901 this->legend_width = (FONT_HEIGHT_SMALL - ScaleFontTrad(1)) * 8 / 5;
904 void UpdateExcludedData()
906 this->excluded_data = 0;
908 int i = 0;
909 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
910 if (HasBit(_legend_excluded_cargo, cs->Index())) SetBit(this->excluded_data, i);
911 i++;
915 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
917 if (widget != WID_CPR_MATRIX) {
918 BaseGraphWindow::UpdateWidgetSize(widget, size, padding, fill, resize);
919 return;
922 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
923 SetDParam(0, cs->name);
924 Dimension d = GetStringBoundingBox(STR_GRAPH_CARGO_PAYMENT_CARGO);
925 d.width += this->legend_width + 4; // colour field
926 d.width += WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
927 d.height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
928 *size = maxdim(d, *size);
931 this->line_height = size->height;
932 size->height = this->line_height * 11; /* Default number of cargo types in most climates. */
933 resize->width = 0;
934 resize->height = this->line_height;
937 void DrawWidget(const Rect &r, int widget) const override
939 if (widget != WID_CPR_MATRIX) {
940 BaseGraphWindow::DrawWidget(r, widget);
941 return;
944 bool rtl = _current_text_dir == TD_RTL;
946 int x = r.left + WD_FRAMERECT_LEFT;
947 int y = r.top;
948 uint row_height = FONT_HEIGHT_SMALL;
949 int padding = ScaleFontTrad(1);
951 int pos = this->vscroll->GetPosition();
952 int max = pos + this->vscroll->GetCapacity();
954 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
955 if (pos-- > 0) continue;
956 if (--max < 0) break;
958 bool lowered = !HasBit(_legend_excluded_cargo, cs->Index());
960 /* Redraw box if lowered */
961 if (lowered) DrawFrameRect(r.left, y, r.right, y + this->line_height - 1, COLOUR_BROWN, FR_LOWERED);
963 byte clk_dif = lowered ? 1 : 0;
964 int rect_x = clk_dif + (rtl ? r.right - this->legend_width - WD_FRAMERECT_RIGHT : r.left + WD_FRAMERECT_LEFT);
966 GfxFillRect(rect_x, y + padding + clk_dif, rect_x + this->legend_width, y + row_height - 1 + clk_dif, PC_BLACK);
967 GfxFillRect(rect_x + 1, y + padding + 1 + clk_dif, rect_x + this->legend_width - 1, y + row_height - 2 + clk_dif, cs->legend_colour);
968 SetDParam(0, cs->name);
969 DrawString(rtl ? r.left : x + this->legend_width + 4 + clk_dif, (rtl ? r.right - this->legend_width - 4 + clk_dif : r.right), y + clk_dif, STR_GRAPH_CARGO_PAYMENT_CARGO);
971 y += this->line_height;
975 void OnClick(Point pt, int widget, int click_count) override
977 switch (widget) {
978 case WID_CPR_ENABLE_CARGOES:
979 /* Remove all cargoes from the excluded lists. */
980 _legend_excluded_cargo = 0;
981 this->excluded_data = 0;
982 this->SetDirty();
983 break;
985 case WID_CPR_DISABLE_CARGOES: {
986 /* Add all cargoes to the excluded lists. */
987 int i = 0;
988 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
989 SetBit(_legend_excluded_cargo, cs->Index());
990 SetBit(this->excluded_data, i);
991 i++;
993 this->SetDirty();
994 break;
997 case WID_CPR_MATRIX: {
998 uint row = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_CPR_MATRIX);
999 if (row >= this->vscroll->GetCount()) return;
1001 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
1002 if (row-- > 0) continue;
1004 ToggleBit(_legend_excluded_cargo, cs->Index());
1005 this->UpdateExcludedData();
1006 this->SetDirty();
1007 break;
1009 break;
1014 void OnResize() override
1016 this->vscroll->SetCapacityFromWidget(this, WID_CPR_MATRIX);
1019 void OnGameTick() override
1021 /* Override default OnGameTick */
1025 * Some data on this window has become invalid.
1026 * @param data Information about the changed data.
1027 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
1029 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1031 if (!gui_scope) return;
1032 this->OnHundredthTick();
1035 void OnHundredthTick() override
1037 this->UpdateExcludedData();
1039 int i = 0;
1040 for (const CargoSpec *cs : _sorted_standard_cargo_specs) {
1041 this->colours[i] = cs->legend_colour;
1042 for (uint j = 0; j != 20; j++) {
1043 this->cost[i][j] = GetTransportedGoodsIncome(10, 20, j * 4 + 4, cs->Index());
1045 i++;
1047 this->num_dataset = i;
1051 static const NWidgetPart _nested_cargo_payment_rates_widgets[] = {
1052 NWidget(NWID_HORIZONTAL),
1053 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1054 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_CARGO_PAYMENT_RATES_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1055 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1056 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1057 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1058 EndContainer(),
1059 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CPR_BACKGROUND), SetMinimalSize(568, 128),
1060 NWidget(NWID_HORIZONTAL),
1061 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1062 NWidget(WWT_TEXT, COLOUR_BROWN, WID_CPR_HEADER), SetMinimalSize(0, 6), SetPadding(2, 0, 2, 0), SetDataTip(STR_GRAPH_CARGO_PAYMENT_RATES_TITLE, STR_NULL),
1063 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1064 EndContainer(),
1065 NWidget(NWID_HORIZONTAL),
1066 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CPR_GRAPH), SetMinimalSize(495, 0), SetFill(1, 1), SetResize(1, 1),
1067 NWidget(NWID_VERTICAL),
1068 NWidget(NWID_SPACER), SetMinimalSize(0, 24), SetFill(0, 1),
1069 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_CPR_ENABLE_CARGOES), SetDataTip(STR_GRAPH_CARGO_ENABLE_ALL, STR_GRAPH_CARGO_TOOLTIP_ENABLE_ALL), SetFill(1, 0),
1070 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_CPR_DISABLE_CARGOES), SetDataTip(STR_GRAPH_CARGO_DISABLE_ALL, STR_GRAPH_CARGO_TOOLTIP_DISABLE_ALL), SetFill(1, 0),
1071 NWidget(NWID_SPACER), SetMinimalSize(0, 4),
1072 NWidget(NWID_HORIZONTAL),
1073 NWidget(WWT_MATRIX, COLOUR_BROWN, WID_CPR_MATRIX), SetResize(0, 2), SetMatrixDataTip(1, 0, STR_GRAPH_CARGO_PAYMENT_TOGGLE_CARGO), SetScrollbar(WID_CPR_MATRIX_SCROLLBAR),
1074 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_CPR_MATRIX_SCROLLBAR),
1075 EndContainer(),
1076 NWidget(NWID_SPACER), SetMinimalSize(0, 24), SetFill(0, 1),
1077 EndContainer(),
1078 NWidget(NWID_SPACER), SetMinimalSize(5, 0), SetFill(0, 1), SetResize(0, 1),
1079 EndContainer(),
1080 NWidget(NWID_HORIZONTAL),
1081 NWidget(NWID_SPACER), SetMinimalSize(WD_RESIZEBOX_WIDTH, 0), SetFill(1, 0), SetResize(1, 0),
1082 NWidget(WWT_TEXT, COLOUR_BROWN, WID_CPR_FOOTER), SetMinimalSize(0, 6), SetPadding(2, 0, 2, 0), SetDataTip(STR_GRAPH_CARGO_PAYMENT_RATES_X_LABEL, STR_NULL),
1083 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1084 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CPR_RESIZE),
1085 EndContainer(),
1086 EndContainer(),
1089 static WindowDesc _cargo_payment_rates_desc(
1090 WDP_AUTO, "graph_cargo_payment_rates", 0, 0,
1091 WC_PAYMENT_RATES, WC_NONE,
1093 _nested_cargo_payment_rates_widgets, lengthof(_nested_cargo_payment_rates_widgets)
1097 void ShowCargoPaymentRates()
1099 AllocateWindowDescFront<PaymentRatesGraphWindow>(&_cargo_payment_rates_desc, 0);
1102 /************************/
1103 /* COMPANY LEAGUE TABLE */
1104 /************************/
1106 static const StringID _performance_titles[] = {
1107 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ENGINEER,
1108 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ENGINEER,
1109 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRAFFIC_MANAGER,
1110 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRAFFIC_MANAGER,
1111 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRANSPORT_COORDINATOR,
1112 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRANSPORT_COORDINATOR,
1113 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ROUTE_SUPERVISOR,
1114 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ROUTE_SUPERVISOR,
1115 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_DIRECTOR,
1116 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_DIRECTOR,
1117 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHIEF_EXECUTIVE,
1118 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHIEF_EXECUTIVE,
1119 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHAIRMAN,
1120 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHAIRMAN,
1121 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_PRESIDENT,
1122 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TYCOON,
1125 static inline StringID GetPerformanceTitleFromValue(uint value)
1127 return _performance_titles[std::min(value, 1000u) >> 6];
1130 class CompanyLeagueWindow : public Window {
1131 private:
1132 GUIList<const Company*> companies;
1133 uint ordinal_width; ///< The width of the ordinal number
1134 uint text_width; ///< The width of the actual text
1135 uint icon_width; ///< The width of the company icon
1136 int line_height; ///< Height of the text lines
1139 * (Re)Build the company league list
1141 void BuildCompanyList()
1143 if (!this->companies.NeedRebuild()) return;
1145 this->companies.clear();
1147 for (const Company *c : Company::Iterate()) {
1148 this->companies.push_back(c);
1151 this->companies.shrink_to_fit();
1152 this->companies.RebuildDone();
1155 /** Sort the company league by performance history */
1156 static bool PerformanceSorter(const Company * const &c1, const Company * const &c2)
1158 return c2->old_economy[0].performance_history < c1->old_economy[0].performance_history;
1161 public:
1162 CompanyLeagueWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
1164 this->InitNested(window_number);
1165 this->companies.ForceRebuild();
1166 this->companies.NeedResort();
1169 void OnPaint() override
1171 this->BuildCompanyList();
1172 this->companies.Sort(&PerformanceSorter);
1174 this->DrawWidgets();
1177 void DrawWidget(const Rect &r, int widget) const override
1179 if (widget != WID_CL_BACKGROUND) return;
1181 int icon_y_offset = 1 + (FONT_HEIGHT_NORMAL - this->line_height) / 2;
1182 uint y = r.top + WD_FRAMERECT_TOP - icon_y_offset;
1184 bool rtl = _current_text_dir == TD_RTL;
1185 uint ordinal_left = rtl ? r.right - WD_FRAMERECT_LEFT - this->ordinal_width : r.left + WD_FRAMERECT_LEFT;
1186 uint ordinal_right = rtl ? r.right - WD_FRAMERECT_LEFT : r.left + WD_FRAMERECT_LEFT + this->ordinal_width;
1187 uint icon_left = r.left + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT + (rtl ? this->text_width : this->ordinal_width);
1188 uint text_left = rtl ? r.left + WD_FRAMERECT_LEFT : r.right - WD_FRAMERECT_LEFT - this->text_width;
1189 uint text_right = rtl ? r.left + WD_FRAMERECT_LEFT + this->text_width : r.right - WD_FRAMERECT_LEFT;
1191 for (uint i = 0; i != this->companies.size(); i++) {
1192 const Company *c = this->companies[i];
1193 DrawString(ordinal_left, ordinal_right, y, i + STR_ORDINAL_NUMBER_1ST, i == 0 ? TC_WHITE : TC_YELLOW);
1195 DrawCompanyIcon(c->index, icon_left, y + icon_y_offset);
1197 SetDParam(0, c->index);
1198 SetDParam(1, c->index);
1199 SetDParam(2, GetPerformanceTitleFromValue(c->old_economy[0].performance_history));
1200 DrawString(text_left, text_right, y, STR_COMPANY_LEAGUE_COMPANY_NAME);
1201 y += this->line_height;
1205 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1207 if (widget != WID_CL_BACKGROUND) return;
1209 this->ordinal_width = 0;
1210 for (uint i = 0; i < MAX_COMPANIES; i++) {
1211 this->ordinal_width = std::max(this->ordinal_width, GetStringBoundingBox(STR_ORDINAL_NUMBER_1ST + i).width);
1213 this->ordinal_width += 5; // Keep some extra spacing
1215 uint widest_width = 0;
1216 uint widest_title = 0;
1217 for (uint i = 0; i < lengthof(_performance_titles); i++) {
1218 uint width = GetStringBoundingBox(_performance_titles[i]).width;
1219 if (width > widest_width) {
1220 widest_title = i;
1221 widest_width = width;
1225 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
1226 this->icon_width = d.width + 2;
1227 this->line_height = std::max<int>(d.height + 2, FONT_HEIGHT_NORMAL);
1229 for (const Company *c : Company::Iterate()) {
1230 SetDParam(0, c->index);
1231 SetDParam(1, c->index);
1232 SetDParam(2, _performance_titles[widest_title]);
1233 widest_width = std::max(widest_width, GetStringBoundingBox(STR_COMPANY_LEAGUE_COMPANY_NAME).width);
1236 this->text_width = widest_width + 30; // Keep some extra spacing
1238 size->width = WD_FRAMERECT_LEFT + this->ordinal_width + WD_FRAMERECT_RIGHT + this->icon_width + WD_FRAMERECT_LEFT + this->text_width + WD_FRAMERECT_RIGHT;
1239 size->height = WD_FRAMERECT_TOP + this->line_height * MAX_COMPANIES + WD_FRAMERECT_BOTTOM;
1243 void OnGameTick() override
1245 if (this->companies.NeedResort()) {
1246 this->SetDirty();
1251 * Some data on this window has become invalid.
1252 * @param data Information about the changed data.
1253 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
1255 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1257 if (data == 0) {
1258 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
1259 this->companies.ForceRebuild();
1260 } else {
1261 this->companies.ForceResort();
1266 static const NWidgetPart _nested_company_league_widgets[] = {
1267 NWidget(NWID_HORIZONTAL),
1268 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1269 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_COMPANY_LEAGUE_TABLE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1270 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1271 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1272 EndContainer(),
1273 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CL_BACKGROUND), SetMinimalSize(400, 0), SetMinimalTextLines(15, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM),
1276 static WindowDesc _company_league_desc(
1277 WDP_AUTO, "league", 0, 0,
1278 WC_COMPANY_LEAGUE, WC_NONE,
1280 _nested_company_league_widgets, lengthof(_nested_company_league_widgets)
1283 void ShowCompanyLeagueTable()
1285 AllocateWindowDescFront<CompanyLeagueWindow>(&_company_league_desc, 0);
1288 /*****************************/
1289 /* PERFORMANCE RATING DETAIL */
1290 /*****************************/
1292 struct PerformanceRatingDetailWindow : Window {
1293 static CompanyID company;
1294 int timeout;
1296 PerformanceRatingDetailWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
1298 this->UpdateCompanyStats();
1300 this->InitNested(window_number);
1301 this->OnInvalidateData(INVALID_COMPANY);
1304 void UpdateCompanyStats()
1306 /* Update all company stats with the current data
1307 * (this is because _score_info is not saved to a savegame) */
1308 for (Company *c : Company::Iterate()) {
1309 UpdateCompanyRatingAndValue(c, false);
1312 this->timeout = DAY_TICKS * 5;
1315 uint score_info_left;
1316 uint score_info_right;
1317 uint bar_left;
1318 uint bar_right;
1319 uint bar_width;
1320 uint bar_height;
1321 uint score_detail_left;
1322 uint score_detail_right;
1324 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1326 switch (widget) {
1327 case WID_PRD_SCORE_FIRST:
1328 this->bar_height = FONT_HEIGHT_NORMAL + 4;
1329 size->height = this->bar_height + 2 * WD_MATRIX_TOP;
1331 uint score_info_width = 0;
1332 for (uint i = SCORE_BEGIN; i < SCORE_END; i++) {
1333 score_info_width = std::max(score_info_width, GetStringBoundingBox(STR_PERFORMANCE_DETAIL_VEHICLES + i).width);
1335 SetDParamMaxValue(0, 1000);
1336 score_info_width += GetStringBoundingBox(STR_BLACK_COMMA).width + WD_FRAMERECT_LEFT;
1338 SetDParamMaxValue(0, 100);
1339 this->bar_width = GetStringBoundingBox(STR_PERFORMANCE_DETAIL_PERCENT).width + 20; // Wide bars!
1341 /* At this number we are roughly at the max; it can become wider,
1342 * but then you need at 1000 times more money. At that time you're
1343 * not that interested anymore in the last few digits anyway.
1344 * The 500 is because 999 999 500 to 999 999 999 are rounded to
1345 * 1 000 M, and not 999 999 k. Use negative numbers to account for
1346 * the negative income/amount of money etc. as well. */
1347 int max = -(999999999 - 500);
1349 /* Scale max for the display currency. Prior to rendering the value
1350 * is converted into the display currency, which may cause it to
1351 * raise significantly. We need to compensate for that since {{CURRCOMPACT}}
1352 * is used, which can produce quite short renderings of very large
1353 * values. Otherwise the calculated width could be too narrow.
1354 * Note that it doesn't work if there was a currency with an exchange
1355 * rate greater than max.
1356 * When the currency rate is more than 1000, the 999 999 k becomes at
1357 * least 999 999 M which roughly is equally long. Furthermore if the
1358 * exchange rate is that high, 999 999 k is usually not enough anymore
1359 * to show the different currency numbers. */
1360 if (_currency->rate < 1000) max /= _currency->rate;
1361 SetDParam(0, max);
1362 SetDParam(1, max);
1363 uint score_detail_width = GetStringBoundingBox(STR_PERFORMANCE_DETAIL_AMOUNT_CURRENCY).width;
1365 size->width = 7 + score_info_width + 5 + this->bar_width + 5 + score_detail_width + 7;
1366 uint left = 7;
1367 uint right = size->width - 7;
1369 bool rtl = _current_text_dir == TD_RTL;
1370 this->score_info_left = rtl ? right - score_info_width : left;
1371 this->score_info_right = rtl ? right : left + score_info_width;
1373 this->score_detail_left = rtl ? left : right - score_detail_width;
1374 this->score_detail_right = rtl ? left + score_detail_width : right;
1376 this->bar_left = left + (rtl ? score_detail_width : score_info_width) + 5;
1377 this->bar_right = this->bar_left + this->bar_width;
1378 break;
1382 void DrawWidget(const Rect &r, int widget) const override
1384 /* No need to draw when there's nothing to draw */
1385 if (this->company == INVALID_COMPANY) return;
1387 if (IsInsideMM(widget, WID_PRD_COMPANY_FIRST, WID_PRD_COMPANY_LAST + 1)) {
1388 if (this->IsWidgetDisabled(widget)) return;
1389 CompanyID cid = (CompanyID)(widget - WID_PRD_COMPANY_FIRST);
1390 int offset = (cid == this->company) ? 1 : 0;
1391 Dimension sprite_size = GetSpriteSize(SPR_COMPANY_ICON);
1392 DrawCompanyIcon(cid, (r.left + r.right - sprite_size.width) / 2 + offset, (r.top + r.bottom - sprite_size.height) / 2 + offset);
1393 return;
1396 if (!IsInsideMM(widget, WID_PRD_SCORE_FIRST, WID_PRD_SCORE_LAST + 1)) return;
1398 ScoreID score_type = (ScoreID)(widget - WID_PRD_SCORE_FIRST);
1400 /* The colours used to show how the progress is going */
1401 int colour_done = _colour_gradient[COLOUR_GREEN][4];
1402 int colour_notdone = _colour_gradient[COLOUR_RED][4];
1404 /* Draw all the score parts */
1405 int64 val = _score_part[company][score_type];
1406 int64 needed = _score_info[score_type].needed;
1407 int score = _score_info[score_type].score;
1409 /* SCORE_TOTAL has its own rules ;) */
1410 if (score_type == SCORE_TOTAL) {
1411 for (ScoreID i = SCORE_BEGIN; i < SCORE_END; i++) score += _score_info[i].score;
1412 needed = SCORE_MAX;
1415 uint bar_top = r.top + WD_MATRIX_TOP;
1416 uint text_top = bar_top + 2;
1418 DrawString(this->score_info_left, this->score_info_right, text_top, STR_PERFORMANCE_DETAIL_VEHICLES + score_type);
1420 /* Draw the score */
1421 SetDParam(0, score);
1422 DrawString(this->score_info_left, this->score_info_right, text_top, STR_BLACK_COMMA, TC_FROMSTRING, SA_RIGHT);
1424 /* Calculate the %-bar */
1425 uint x = Clamp<int64>(val, 0, needed) * this->bar_width / needed;
1426 bool rtl = _current_text_dir == TD_RTL;
1427 if (rtl) {
1428 x = this->bar_right - x;
1429 } else {
1430 x = this->bar_left + x;
1433 /* Draw the bar */
1434 if (x != this->bar_left) GfxFillRect(this->bar_left, bar_top, x, bar_top + this->bar_height, rtl ? colour_notdone : colour_done);
1435 if (x != this->bar_right) GfxFillRect(x, bar_top, this->bar_right, bar_top + this->bar_height, rtl ? colour_done : colour_notdone);
1437 /* Draw it */
1438 SetDParam(0, Clamp<int64>(val, 0, needed) * 100 / needed);
1439 DrawString(this->bar_left, this->bar_right, text_top, STR_PERFORMANCE_DETAIL_PERCENT, TC_FROMSTRING, SA_HOR_CENTER);
1441 /* SCORE_LOAN is inversed */
1442 if (score_type == SCORE_LOAN) val = needed - val;
1444 /* Draw the amount we have against what is needed
1445 * For some of them it is in currency format */
1446 SetDParam(0, val);
1447 SetDParam(1, needed);
1448 switch (score_type) {
1449 case SCORE_MIN_PROFIT:
1450 case SCORE_MIN_INCOME:
1451 case SCORE_MAX_INCOME:
1452 case SCORE_MONEY:
1453 case SCORE_LOAN:
1454 DrawString(this->score_detail_left, this->score_detail_right, text_top, STR_PERFORMANCE_DETAIL_AMOUNT_CURRENCY);
1455 break;
1456 default:
1457 DrawString(this->score_detail_left, this->score_detail_right, text_top, STR_PERFORMANCE_DETAIL_AMOUNT_INT);
1461 void OnClick(Point pt, int widget, int click_count) override
1463 /* Check which button is clicked */
1464 if (IsInsideMM(widget, WID_PRD_COMPANY_FIRST, WID_PRD_COMPANY_LAST + 1)) {
1465 /* Is it no on disable? */
1466 if (!this->IsWidgetDisabled(widget)) {
1467 this->RaiseWidget(this->company + WID_PRD_COMPANY_FIRST);
1468 this->company = (CompanyID)(widget - WID_PRD_COMPANY_FIRST);
1469 this->LowerWidget(this->company + WID_PRD_COMPANY_FIRST);
1470 this->SetDirty();
1475 void OnGameTick() override
1477 /* Update the company score every 5 days */
1478 if (--this->timeout == 0) {
1479 this->UpdateCompanyStats();
1480 this->SetDirty();
1485 * Some data on this window has become invalid.
1486 * @param data the company ID of the company that is going to be removed
1487 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
1489 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1491 if (!gui_scope) return;
1492 /* Disable the companies who are not active */
1493 for (CompanyID i = COMPANY_FIRST; i < MAX_COMPANIES; i++) {
1494 this->SetWidgetDisabledState(i + WID_PRD_COMPANY_FIRST, !Company::IsValidID(i));
1497 /* Check if the currently selected company is still active. */
1498 if (this->company != INVALID_COMPANY && !Company::IsValidID(this->company)) {
1499 /* Raise the widget for the previous selection. */
1500 this->RaiseWidget(this->company + WID_PRD_COMPANY_FIRST);
1501 this->company = INVALID_COMPANY;
1504 if (this->company == INVALID_COMPANY) {
1505 for (const Company *c : Company::Iterate()) {
1506 this->company = c->index;
1507 break;
1511 /* Make sure the widget is lowered */
1512 this->LowerWidget(this->company + WID_PRD_COMPANY_FIRST);
1516 CompanyID PerformanceRatingDetailWindow::company = INVALID_COMPANY;
1519 * Make a vertical list of panels for outputting score details.
1520 * @param biggest_index Storage for collecting the biggest index used in the returned tree.
1521 * @return Panel with performance details.
1522 * @post \c *biggest_index contains the largest used index in the tree.
1524 static NWidgetBase *MakePerformanceDetailPanels(int *biggest_index)
1526 const StringID performance_tips[] = {
1527 STR_PERFORMANCE_DETAIL_VEHICLES_TOOLTIP,
1528 STR_PERFORMANCE_DETAIL_STATIONS_TOOLTIP,
1529 STR_PERFORMANCE_DETAIL_MIN_PROFIT_TOOLTIP,
1530 STR_PERFORMANCE_DETAIL_MIN_INCOME_TOOLTIP,
1531 STR_PERFORMANCE_DETAIL_MAX_INCOME_TOOLTIP,
1532 STR_PERFORMANCE_DETAIL_DELIVERED_TOOLTIP,
1533 STR_PERFORMANCE_DETAIL_CARGO_TOOLTIP,
1534 STR_PERFORMANCE_DETAIL_MONEY_TOOLTIP,
1535 STR_PERFORMANCE_DETAIL_LOAN_TOOLTIP,
1536 STR_PERFORMANCE_DETAIL_TOTAL_TOOLTIP,
1539 static_assert(lengthof(performance_tips) == SCORE_END - SCORE_BEGIN);
1541 NWidgetVertical *vert = new NWidgetVertical(NC_EQUALSIZE);
1542 for (int widnum = WID_PRD_SCORE_FIRST; widnum <= WID_PRD_SCORE_LAST; widnum++) {
1543 NWidgetBackground *panel = new NWidgetBackground(WWT_PANEL, COLOUR_BROWN, widnum);
1544 panel->SetFill(1, 1);
1545 panel->SetDataTip(0x0, performance_tips[widnum - WID_PRD_SCORE_FIRST]);
1546 vert->Add(panel);
1548 *biggest_index = WID_PRD_SCORE_LAST;
1549 return vert;
1552 /** Make a number of rows with buttons for each company for the performance rating detail window. */
1553 NWidgetBase *MakeCompanyButtonRowsGraphGUI(int *biggest_index)
1555 return MakeCompanyButtonRows(biggest_index, WID_PRD_COMPANY_FIRST, WID_PRD_COMPANY_LAST, COLOUR_BROWN, 8, STR_PERFORMANCE_DETAIL_SELECT_COMPANY_TOOLTIP);
1558 static const NWidgetPart _nested_performance_rating_detail_widgets[] = {
1559 NWidget(NWID_HORIZONTAL),
1560 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1561 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_PERFORMANCE_DETAIL, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1562 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1563 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1564 EndContainer(),
1565 NWidget(WWT_PANEL, COLOUR_BROWN),
1566 NWidgetFunction(MakeCompanyButtonRowsGraphGUI), SetPadding(0, 1, 1, 2),
1567 EndContainer(),
1568 NWidgetFunction(MakePerformanceDetailPanels),
1571 static WindowDesc _performance_rating_detail_desc(
1572 WDP_AUTO, "league_details", 0, 0,
1573 WC_PERFORMANCE_DETAIL, WC_NONE,
1575 _nested_performance_rating_detail_widgets, lengthof(_nested_performance_rating_detail_widgets)
1578 void ShowPerformanceRatingDetail()
1580 AllocateWindowDescFront<PerformanceRatingDetailWindow>(&_performance_rating_detail_desc, 0);
1583 void InitializeGraphGui()
1585 _legend_excluded_companies = 0;
1586 _legend_excluded_cargo = 0;