Fix: Data races on cursor state in OpenGL backends
[openttd-github.git] / src / graph_gui.cpp
blob5b04592bff1f3d431ead4a67ad74220aab89605f
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"
25 #include "widgets/graph_widget.h"
27 #include "table/strings.h"
28 #include "table/sprites.h"
29 #include <math.h>
31 #include "safeguards.h"
33 /* Bitmasks of company and cargo indices that shouldn't be drawn. */
34 static CompanyMask _legend_excluded_companies;
35 static CargoTypes _legend_excluded_cargo;
37 /* Apparently these don't play well with enums. */
38 static const OverflowSafeInt64 INVALID_DATAPOINT(INT64_MAX); // Value used for a datapoint that shouldn't be drawn.
39 static const uint INVALID_DATAPOINT_POS = UINT_MAX; // Used to determine if the previous point was drawn.
41 /****************/
42 /* GRAPH LEGEND */
43 /****************/
45 struct GraphLegendWindow : Window {
46 GraphLegendWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
48 this->InitNested(window_number);
50 for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
51 if (!HasBit(_legend_excluded_companies, c)) this->LowerWidget(c + WID_GL_FIRST_COMPANY);
53 this->OnInvalidateData(c);
57 void DrawWidget(const Rect &r, int widget) const override
59 if (!IsInsideMM(widget, WID_GL_FIRST_COMPANY, MAX_COMPANIES + WID_GL_FIRST_COMPANY)) return;
61 CompanyID cid = (CompanyID)(widget - WID_GL_FIRST_COMPANY);
63 if (!Company::IsValidID(cid)) return;
65 bool rtl = _current_text_dir == TD_RTL;
67 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
68 DrawCompanyIcon(cid, rtl ? r.right - d.width - 2 : r.left + 2, r.top + (r.bottom - r.top - d.height) / 2);
70 SetDParam(0, cid);
71 SetDParam(1, cid);
72 DrawString(r.left + (rtl ? (uint)WD_FRAMERECT_LEFT : (d.width + 4)), r.right - (rtl ? (d.width + 4) : (uint)WD_FRAMERECT_RIGHT), r.top + (r.bottom - r.top + 1 - FONT_HEIGHT_NORMAL) / 2, STR_COMPANY_NAME_COMPANY_NUM, HasBit(_legend_excluded_companies, cid) ? TC_BLACK : TC_WHITE);
75 void OnClick(Point pt, int widget, int click_count) override
77 if (!IsInsideMM(widget, WID_GL_FIRST_COMPANY, MAX_COMPANIES + WID_GL_FIRST_COMPANY)) return;
79 ToggleBit(_legend_excluded_companies, widget - WID_GL_FIRST_COMPANY);
80 this->ToggleWidgetLoweredState(widget);
81 this->SetDirty();
82 InvalidateWindowData(WC_INCOME_GRAPH, 0);
83 InvalidateWindowData(WC_OPERATING_PROFIT, 0);
84 InvalidateWindowData(WC_DELIVERED_CARGO, 0);
85 InvalidateWindowData(WC_PERFORMANCE_HISTORY, 0);
86 InvalidateWindowData(WC_COMPANY_VALUE, 0);
89 /**
90 * Some data on this window has become invalid.
91 * @param data Information about the changed data.
92 * @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.
94 void OnInvalidateData(int data = 0, bool gui_scope = true) override
96 if (!gui_scope) return;
97 if (Company::IsValidID(data)) return;
99 SetBit(_legend_excluded_companies, data);
100 this->RaiseWidget(data + WID_GL_FIRST_COMPANY);
105 * Construct a vertical list of buttons, one for each company.
106 * @param biggest_index Storage for collecting the biggest index used in the returned tree.
107 * @return Panel with company buttons.
108 * @post \c *biggest_index contains the largest used index in the tree.
110 static NWidgetBase *MakeNWidgetCompanyLines(int *biggest_index)
112 NWidgetVertical *vert = new NWidgetVertical();
113 uint line_height = std::max<uint>(GetSpriteSize(SPR_COMPANY_ICON).height, FONT_HEIGHT_NORMAL) + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
115 for (int widnum = WID_GL_FIRST_COMPANY; widnum <= WID_GL_LAST_COMPANY; widnum++) {
116 NWidgetBackground *panel = new NWidgetBackground(WWT_PANEL, COLOUR_BROWN, widnum);
117 panel->SetMinimalSize(246, line_height);
118 panel->SetFill(1, 0);
119 panel->SetDataTip(0x0, STR_GRAPH_KEY_COMPANY_SELECTION_TOOLTIP);
120 vert->Add(panel);
122 *biggest_index = WID_GL_LAST_COMPANY;
123 return vert;
126 static const NWidgetPart _nested_graph_legend_widgets[] = {
127 NWidget(NWID_HORIZONTAL),
128 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
129 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_KEY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
130 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
131 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
132 EndContainer(),
133 NWidget(WWT_PANEL, COLOUR_BROWN, WID_GL_BACKGROUND),
134 NWidget(NWID_SPACER), SetMinimalSize(0, 2),
135 NWidget(NWID_HORIZONTAL),
136 NWidget(NWID_SPACER), SetMinimalSize(2, 0),
137 NWidgetFunction(MakeNWidgetCompanyLines),
138 NWidget(NWID_SPACER), SetMinimalSize(2, 0),
139 EndContainer(),
140 EndContainer(),
143 static WindowDesc _graph_legend_desc(
144 WDP_AUTO, "graph_legend", 0, 0,
145 WC_GRAPH_LEGEND, WC_NONE,
147 _nested_graph_legend_widgets, lengthof(_nested_graph_legend_widgets)
150 static void ShowGraphLegend()
152 AllocateWindowDescFront<GraphLegendWindow>(&_graph_legend_desc, 0);
155 /** Contains the interval of a graph's data. */
156 struct ValuesInterval {
157 OverflowSafeInt64 highest; ///< Highest value of this interval. Must be zero or greater.
158 OverflowSafeInt64 lowest; ///< Lowest value of this interval. Must be zero or less.
161 /******************/
162 /* BASE OF GRAPHS */
163 /*****************/
165 struct BaseGraphWindow : Window {
166 protected:
167 static const int GRAPH_MAX_DATASETS = 64;
168 static const int GRAPH_BASE_COLOUR = GREY_SCALE(2);
169 static const int GRAPH_GRID_COLOUR = GREY_SCALE(3);
170 static const int GRAPH_AXIS_LINE_COLOUR = GREY_SCALE(1);
171 static const int GRAPH_ZERO_LINE_COLOUR = GREY_SCALE(8);
172 static const int GRAPH_YEAR_LINE_COLOUR = GREY_SCALE(5);
173 static const int GRAPH_NUM_MONTHS = 24; ///< Number of months displayed in the graph.
175 static const TextColour GRAPH_AXIS_LABEL_COLOUR = TC_BLACK; ///< colour of the graph axis label.
177 static const int MIN_GRAPH_NUM_LINES_Y = 9; ///< Minimal number of horizontal lines to draw.
178 static const int MIN_GRID_PIXEL_SIZE = 20; ///< Minimum distance between graph lines.
180 uint64 excluded_data; ///< bitmask of the datasets that shouldn't be displayed.
181 byte num_dataset;
182 byte num_on_x_axis;
183 byte num_vert_lines;
185 /* The starting month and year that values are plotted against. If month is
186 * 0xFF, use x_values_start and x_values_increment below instead. */
187 byte month;
188 Year year;
190 /* These values are used if the graph is being plotted against values
191 * rather than the dates specified by month and year. */
192 uint16 x_values_start;
193 uint16 x_values_increment;
195 int graph_widget;
196 StringID format_str_y_axis;
197 byte colours[GRAPH_MAX_DATASETS];
198 OverflowSafeInt64 cost[GRAPH_MAX_DATASETS][GRAPH_NUM_MONTHS]; ///< Stored costs for the last #GRAPH_NUM_MONTHS months
201 * Get the interval that contains the graph's data. Excluded data is ignored to show smaller values in
202 * better detail when disabling higher ones.
203 * @param num_hori_lines Number of horizontal lines to be drawn.
204 * @return Highest and lowest values of the graph (ignoring disabled data).
206 ValuesInterval GetValuesInterval(int num_hori_lines) const
208 assert(num_hori_lines > 0);
210 ValuesInterval current_interval;
211 current_interval.highest = INT64_MIN;
212 current_interval.lowest = INT64_MAX;
214 for (int i = 0; i < this->num_dataset; i++) {
215 if (HasBit(this->excluded_data, i)) continue;
216 for (int j = 0; j < this->num_on_x_axis; j++) {
217 OverflowSafeInt64 datapoint = this->cost[i][j];
219 if (datapoint != INVALID_DATAPOINT) {
220 current_interval.highest = std::max(current_interval.highest, datapoint);
221 current_interval.lowest = std::min(current_interval.lowest, datapoint);
226 /* Prevent showing values too close to the graph limits. */
227 current_interval.highest = (11 * current_interval.highest) / 10;
228 current_interval.lowest = (11 * current_interval.lowest) / 10;
230 /* Always include zero in the shown range. */
231 double abs_lower = (current_interval.lowest > 0) ? 0 : (double)abs(current_interval.lowest);
232 double abs_higher = (current_interval.highest < 0) ? 0 : (double)current_interval.highest;
234 int num_pos_grids;
235 int64 grid_size;
237 if (abs_lower != 0 || abs_higher != 0) {
238 /* The number of grids to reserve for the positive part is: */
239 num_pos_grids = (int)floor(0.5 + num_hori_lines * abs_higher / (abs_higher + abs_lower));
241 /* If there are any positive or negative values, force that they have at least one grid. */
242 if (num_pos_grids == 0 && abs_higher != 0) num_pos_grids++;
243 if (num_pos_grids == num_hori_lines && abs_lower != 0) num_pos_grids--;
245 /* Get the required grid size for each side and use the maximum one. */
246 int64 grid_size_higher = (abs_higher > 0) ? ((int64)abs_higher + num_pos_grids - 1) / num_pos_grids : 0;
247 int64 grid_size_lower = (abs_lower > 0) ? ((int64)abs_lower + num_hori_lines - num_pos_grids - 1) / (num_hori_lines - num_pos_grids) : 0;
248 grid_size = std::max(grid_size_higher, grid_size_lower);
249 } else {
250 /* If both values are zero, show an empty graph. */
251 num_pos_grids = num_hori_lines / 2;
252 grid_size = 1;
255 current_interval.highest = num_pos_grids * grid_size;
256 current_interval.lowest = -(num_hori_lines - num_pos_grids) * grid_size;
257 return current_interval;
261 * Get width for Y labels.
262 * @param current_interval Interval that contains all of the graph data.
263 * @param num_hori_lines Number of horizontal lines to be drawn.
265 uint GetYLabelWidth(ValuesInterval current_interval, int num_hori_lines) const
267 /* draw text strings on the y axis */
268 int64 y_label = current_interval.highest;
269 int64 y_label_separation = (current_interval.highest - current_interval.lowest) / num_hori_lines;
271 uint max_width = 0;
273 for (int i = 0; i < (num_hori_lines + 1); i++) {
274 SetDParam(0, this->format_str_y_axis);
275 SetDParam(1, y_label);
276 Dimension d = GetStringBoundingBox(STR_GRAPH_Y_LABEL);
277 if (d.width > max_width) max_width = d.width;
279 y_label -= y_label_separation;
282 return max_width;
286 * Actually draw the graph.
287 * @param r the rectangle of the data field of the graph
289 void DrawGraph(Rect r) const
291 uint x, y; ///< Reused whenever x and y coordinates are needed.
292 ValuesInterval interval; ///< Interval that contains all of the graph data.
293 int x_axis_offset; ///< Distance from the top of the graph to the x axis.
295 /* the colours and cost array of GraphDrawer must accommodate
296 * both values for cargo and companies. So if any are higher, quit */
297 static_assert(GRAPH_MAX_DATASETS >= (int)NUM_CARGO && GRAPH_MAX_DATASETS >= (int)MAX_COMPANIES);
298 assert(this->num_vert_lines > 0);
300 /* Rect r will be adjusted to contain just the graph, with labels being
301 * placed outside the area. */
302 r.top += 5 + GetCharacterHeight(FS_SMALL) / 2;
303 r.bottom -= (this->month == 0xFF ? 1 : 2) * GetCharacterHeight(FS_SMALL) + 4;
304 r.left += 9;
305 r.right -= 5;
307 /* Initial number of horizontal lines. */
308 int num_hori_lines = 160 / MIN_GRID_PIXEL_SIZE;
309 /* For the rest of the height, the number of horizontal lines will increase more slowly. */
310 int resize = (r.bottom - r.top - 160) / (2 * MIN_GRID_PIXEL_SIZE);
311 if (resize > 0) num_hori_lines += resize;
313 interval = GetValuesInterval(num_hori_lines);
315 int label_width = GetYLabelWidth(interval, num_hori_lines);
317 r.left += label_width;
319 int x_sep = (r.right - r.left) / this->num_vert_lines;
320 int y_sep = (r.bottom - r.top) / num_hori_lines;
322 /* Redetermine right and bottom edge of graph to fit with the integer
323 * separation values. */
324 r.right = r.left + x_sep * this->num_vert_lines;
325 r.bottom = r.top + y_sep * num_hori_lines;
327 OverflowSafeInt64 interval_size = interval.highest + abs(interval.lowest);
328 /* Where to draw the X axis. Use floating point to avoid overflowing and results of zero. */
329 x_axis_offset = (int)((r.bottom - r.top) * (double)interval.highest / (double)interval_size);
331 /* Draw the background of the graph itself. */
332 GfxFillRect(r.left, r.top, r.right, r.bottom, GRAPH_BASE_COLOUR);
334 /* Draw the vertical grid lines. */
336 /* Don't draw the first line, as that's where the axis will be. */
337 x = r.left + x_sep;
339 for (int i = 0; i < this->num_vert_lines; i++) {
340 GfxFillRect(x, r.top, x, r.bottom, GRAPH_GRID_COLOUR);
341 x += x_sep;
344 /* Draw the horizontal grid lines. */
345 y = r.bottom;
347 for (int i = 0; i < (num_hori_lines + 1); i++) {
348 GfxFillRect(r.left - 3, y, r.left - 1, y, GRAPH_AXIS_LINE_COLOUR);
349 GfxFillRect(r.left, y, r.right, y, GRAPH_GRID_COLOUR);
350 y -= y_sep;
353 /* Draw the y axis. */
354 GfxFillRect(r.left, r.top, r.left, r.bottom, GRAPH_AXIS_LINE_COLOUR);
356 /* Draw the x axis. */
357 y = x_axis_offset + r.top;
358 GfxFillRect(r.left, y, r.right, y, GRAPH_ZERO_LINE_COLOUR);
360 /* Find the largest value that will be drawn. */
361 if (this->num_on_x_axis == 0) return;
363 assert(this->num_on_x_axis > 0);
364 assert(this->num_dataset > 0);
366 /* draw text strings on the y axis */
367 int64 y_label = interval.highest;
368 int64 y_label_separation = abs(interval.highest - interval.lowest) / num_hori_lines;
370 y = r.top - GetCharacterHeight(FS_SMALL) / 2;
372 for (int i = 0; i < (num_hori_lines + 1); i++) {
373 SetDParam(0, this->format_str_y_axis);
374 SetDParam(1, y_label);
375 DrawString(r.left - label_width - 4, r.left - 4, y, STR_GRAPH_Y_LABEL, GRAPH_AXIS_LABEL_COLOUR, SA_RIGHT);
377 y_label -= y_label_separation;
378 y += y_sep;
381 /* Draw x-axis labels and markings for graphs based on financial quarters and years. */
382 if (this->month != 0xFF) {
383 x = r.left;
384 y = r.bottom + 2;
385 byte month = this->month;
386 Year year = this->year;
387 for (int i = 0; i < this->num_on_x_axis; i++) {
388 SetDParam(0, month + STR_MONTH_ABBREV_JAN);
389 SetDParam(1, year);
390 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);
392 month += 3;
393 if (month >= 12) {
394 month = 0;
395 year++;
397 /* Draw a lighter grid line between years. Top and bottom adjustments ensure we don't draw over top and bottom horizontal grid lines. */
398 GfxFillRect(x + x_sep, r.top + 1, x + x_sep, r.bottom - 1, GRAPH_YEAR_LINE_COLOUR);
400 x += x_sep;
402 } else {
403 /* Draw x-axis labels for graphs not based on quarterly performance (cargo payment rates). */
404 x = r.left;
405 y = r.bottom + 2;
406 uint16 label = this->x_values_start;
408 for (int i = 0; i < this->num_on_x_axis; i++) {
409 SetDParam(0, label);
410 DrawString(x + 1, x + x_sep - 1, y, STR_GRAPH_Y_LABEL_NUMBER, GRAPH_AXIS_LABEL_COLOUR, SA_HOR_CENTER);
412 label += this->x_values_increment;
413 x += x_sep;
417 /* draw lines and dots */
418 uint linewidth = _settings_client.gui.graph_line_thickness;
419 uint pointoffs1 = (linewidth + 1) / 2;
420 uint pointoffs2 = linewidth + 1 - pointoffs1;
421 for (int i = 0; i < this->num_dataset; i++) {
422 if (!HasBit(this->excluded_data, i)) {
423 /* Centre the dot between the grid lines. */
424 x = r.left + (x_sep / 2);
426 byte colour = this->colours[i];
427 uint prev_x = INVALID_DATAPOINT_POS;
428 uint prev_y = INVALID_DATAPOINT_POS;
430 for (int j = 0; j < this->num_on_x_axis; j++) {
431 OverflowSafeInt64 datapoint = this->cost[i][j];
433 if (datapoint != INVALID_DATAPOINT) {
435 * Check whether we need to reduce the 'accuracy' of the
436 * datapoint value and the highest value to split overflows.
437 * And when 'drawing' 'one million' or 'one million and one'
438 * there is no significant difference, so the least
439 * significant bits can just be removed.
441 * If there are more bits needed than would fit in a 32 bits
442 * integer, so at about 31 bits because of the sign bit, the
443 * least significant bits are removed.
445 int mult_range = FindLastBit(x_axis_offset) + FindLastBit(abs(datapoint));
446 int reduce_range = std::max(mult_range - 31, 0);
448 /* Handle negative values differently (don't shift sign) */
449 if (datapoint < 0) {
450 datapoint = -(abs(datapoint) >> reduce_range);
451 } else {
452 datapoint >>= reduce_range;
454 y = r.top + x_axis_offset - ((r.bottom - r.top) * datapoint) / (interval_size >> reduce_range);
456 /* Draw the point. */
457 GfxFillRect(x - pointoffs1, y - pointoffs1, x + pointoffs2, y + pointoffs2, colour);
459 /* Draw the line connected to the previous point. */
460 if (prev_x != INVALID_DATAPOINT_POS) GfxDrawLine(prev_x, prev_y, x, y, colour, linewidth);
462 prev_x = x;
463 prev_y = y;
464 } else {
465 prev_x = INVALID_DATAPOINT_POS;
466 prev_y = INVALID_DATAPOINT_POS;
469 x += x_sep;
476 BaseGraphWindow(WindowDesc *desc, int widget, StringID format_str_y_axis) :
477 Window(desc),
478 format_str_y_axis(format_str_y_axis)
480 SetWindowDirty(WC_GRAPH_LEGEND, 0);
481 this->num_vert_lines = 24;
482 this->graph_widget = widget;
485 void InitializeWindow(WindowNumber number)
487 /* Initialise the dataset */
488 this->UpdateStatistics(true);
490 this->InitNested(number);
493 public:
494 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
496 if (widget != this->graph_widget) return;
498 uint x_label_width = 0;
500 /* Draw x-axis labels and markings for graphs based on financial quarters and years. */
501 if (this->month != 0xFF) {
502 byte month = this->month;
503 Year year = this->year;
504 for (int i = 0; i < this->num_on_x_axis; i++) {
505 SetDParam(0, month + STR_MONTH_ABBREV_JAN);
506 SetDParam(1, year);
507 x_label_width = std::max(x_label_width, GetStringBoundingBox(month == 0 ? STR_GRAPH_X_LABEL_MONTH_YEAR : STR_GRAPH_X_LABEL_MONTH).width);
509 month += 3;
510 if (month >= 12) {
511 month = 0;
512 year++;
515 } else {
516 /* Draw x-axis labels for graphs not based on quarterly performance (cargo payment rates). */
517 SetDParamMaxValue(0, this->x_values_start + this->num_on_x_axis * this->x_values_increment, 0, FS_SMALL);
518 x_label_width = GetStringBoundingBox(STR_GRAPH_Y_LABEL_NUMBER).width;
521 SetDParam(0, this->format_str_y_axis);
522 SetDParam(1, INT64_MAX);
523 uint y_label_width = GetStringBoundingBox(STR_GRAPH_Y_LABEL).width;
525 size->width = std::max<uint>(size->width, 5 + y_label_width + this->num_on_x_axis * (x_label_width + 5) + 9);
526 size->height = std::max<uint>(size->height, 5 + (1 + MIN_GRAPH_NUM_LINES_Y * 2 + (this->month != 0xFF ? 3 : 1)) * FONT_HEIGHT_SMALL + 4);
527 size->height = std::max<uint>(size->height, size->width / 3);
530 void DrawWidget(const Rect &r, int widget) const override
532 if (widget != this->graph_widget) return;
534 DrawGraph(r);
537 virtual OverflowSafeInt64 GetGraphData(const Company *c, int j)
539 return INVALID_DATAPOINT;
542 void OnClick(Point pt, int widget, int click_count) override
544 /* Clicked on legend? */
545 if (widget == WID_CV_KEY_BUTTON) ShowGraphLegend();
548 void OnGameTick() override
550 this->UpdateStatistics(false);
554 * Some data on this window has become invalid.
555 * @param data Information about the changed data.
556 * @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.
558 void OnInvalidateData(int data = 0, bool gui_scope = true) override
560 if (!gui_scope) return;
561 this->UpdateStatistics(true);
565 * Update the statistics.
566 * @param initialize Initialize the data structure.
568 void UpdateStatistics(bool initialize)
570 CompanyMask excluded_companies = _legend_excluded_companies;
572 /* Exclude the companies which aren't valid */
573 for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
574 if (!Company::IsValidID(c)) SetBit(excluded_companies, c);
577 byte nums = 0;
578 for (const Company *c : Company::Iterate()) {
579 nums = std::min(this->num_vert_lines, std::max(nums, c->num_valid_stat_ent));
582 int mo = (_cur_month / 3 - nums) * 3;
583 int yr = _cur_year;
584 while (mo < 0) {
585 yr--;
586 mo += 12;
589 if (!initialize && this->excluded_data == excluded_companies && this->num_on_x_axis == nums &&
590 this->year == yr && this->month == mo) {
591 /* There's no reason to get new stats */
592 return;
595 this->excluded_data = excluded_companies;
596 this->num_on_x_axis = nums;
597 this->year = yr;
598 this->month = mo;
600 int numd = 0;
601 for (CompanyID k = COMPANY_FIRST; k < MAX_COMPANIES; k++) {
602 const Company *c = Company::GetIfValid(k);
603 if (c != nullptr) {
604 this->colours[numd] = _colour_gradient[c->colour][6];
605 for (int j = this->num_on_x_axis, i = 0; --j >= 0;) {
606 this->cost[numd][i] = (j >= c->num_valid_stat_ent) ? INVALID_DATAPOINT : GetGraphData(c, j);
607 i++;
610 numd++;
613 this->num_dataset = numd;
618 /********************/
619 /* OPERATING PROFIT */
620 /********************/
622 struct OperatingProfitGraphWindow : BaseGraphWindow {
623 OperatingProfitGraphWindow(WindowDesc *desc, WindowNumber window_number) :
624 BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
626 this->InitializeWindow(window_number);
629 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
631 return c->old_economy[j].income + c->old_economy[j].expenses;
635 static const NWidgetPart _nested_operating_profit_widgets[] = {
636 NWidget(NWID_HORIZONTAL),
637 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
638 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_OPERATING_PROFIT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
639 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),
640 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
641 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
642 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
643 EndContainer(),
644 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CV_BACKGROUND),
645 NWidget(NWID_HORIZONTAL),
646 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CV_GRAPH), SetMinimalSize(576, 160), SetFill(1, 1), SetResize(1, 1),
647 NWidget(NWID_VERTICAL),
648 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
649 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CV_RESIZE),
650 EndContainer(),
651 EndContainer(),
652 EndContainer(),
655 static WindowDesc _operating_profit_desc(
656 WDP_AUTO, "graph_operating_profit", 0, 0,
657 WC_OPERATING_PROFIT, WC_NONE,
659 _nested_operating_profit_widgets, lengthof(_nested_operating_profit_widgets)
663 void ShowOperatingProfitGraph()
665 AllocateWindowDescFront<OperatingProfitGraphWindow>(&_operating_profit_desc, 0);
669 /****************/
670 /* INCOME GRAPH */
671 /****************/
673 struct IncomeGraphWindow : BaseGraphWindow {
674 IncomeGraphWindow(WindowDesc *desc, WindowNumber window_number) :
675 BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
677 this->InitializeWindow(window_number);
680 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
682 return c->old_economy[j].income;
686 static const NWidgetPart _nested_income_graph_widgets[] = {
687 NWidget(NWID_HORIZONTAL),
688 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
689 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_INCOME_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
690 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),
691 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
692 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
693 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
694 EndContainer(),
695 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CV_BACKGROUND),
696 NWidget(NWID_HORIZONTAL),
697 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CV_GRAPH), SetMinimalSize(576, 128), SetFill(1, 1), SetResize(1, 1),
698 NWidget(NWID_VERTICAL),
699 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
700 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CV_RESIZE),
701 EndContainer(),
702 EndContainer(),
703 EndContainer(),
706 static WindowDesc _income_graph_desc(
707 WDP_AUTO, "graph_income", 0, 0,
708 WC_INCOME_GRAPH, WC_NONE,
710 _nested_income_graph_widgets, lengthof(_nested_income_graph_widgets)
713 void ShowIncomeGraph()
715 AllocateWindowDescFront<IncomeGraphWindow>(&_income_graph_desc, 0);
718 /*******************/
719 /* DELIVERED CARGO */
720 /*******************/
722 struct DeliveredCargoGraphWindow : BaseGraphWindow {
723 DeliveredCargoGraphWindow(WindowDesc *desc, WindowNumber window_number) :
724 BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_COMMA)
726 this->InitializeWindow(window_number);
729 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
731 return c->old_economy[j].delivered_cargo.GetSum<OverflowSafeInt64>();
735 static const NWidgetPart _nested_delivered_cargo_graph_widgets[] = {
736 NWidget(NWID_HORIZONTAL),
737 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
738 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_CARGO_DELIVERED_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
739 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),
740 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
741 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
742 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
743 EndContainer(),
744 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CV_BACKGROUND),
745 NWidget(NWID_HORIZONTAL),
746 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CV_GRAPH), SetMinimalSize(576, 128), SetFill(1, 1), SetResize(1, 1),
747 NWidget(NWID_VERTICAL),
748 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
749 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CV_RESIZE),
750 EndContainer(),
751 EndContainer(),
752 EndContainer(),
755 static WindowDesc _delivered_cargo_graph_desc(
756 WDP_AUTO, "graph_delivered_cargo", 0, 0,
757 WC_DELIVERED_CARGO, WC_NONE,
759 _nested_delivered_cargo_graph_widgets, lengthof(_nested_delivered_cargo_graph_widgets)
762 void ShowDeliveredCargoGraph()
764 AllocateWindowDescFront<DeliveredCargoGraphWindow>(&_delivered_cargo_graph_desc, 0);
767 /***********************/
768 /* PERFORMANCE HISTORY */
769 /***********************/
771 struct PerformanceHistoryGraphWindow : BaseGraphWindow {
772 PerformanceHistoryGraphWindow(WindowDesc *desc, WindowNumber window_number) :
773 BaseGraphWindow(desc, WID_PHG_GRAPH, STR_JUST_COMMA)
775 this->InitializeWindow(window_number);
778 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
780 return c->old_economy[j].performance_history;
783 void OnClick(Point pt, int widget, int click_count) override
785 if (widget == WID_PHG_DETAILED_PERFORMANCE) ShowPerformanceRatingDetail();
786 this->BaseGraphWindow::OnClick(pt, widget, click_count);
790 static const NWidgetPart _nested_performance_history_widgets[] = {
791 NWidget(NWID_HORIZONTAL),
792 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
793 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_COMPANY_PERFORMANCE_RATINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
794 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),
795 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),
796 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
797 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
798 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
799 EndContainer(),
800 NWidget(WWT_PANEL, COLOUR_BROWN, WID_PHG_BACKGROUND),
801 NWidget(NWID_HORIZONTAL),
802 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_PHG_GRAPH), SetMinimalSize(576, 224), SetFill(1, 1), SetResize(1, 1),
803 NWidget(NWID_VERTICAL),
804 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
805 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_PHG_RESIZE),
806 EndContainer(),
807 EndContainer(),
808 EndContainer(),
811 static WindowDesc _performance_history_desc(
812 WDP_AUTO, "graph_performance", 0, 0,
813 WC_PERFORMANCE_HISTORY, WC_NONE,
815 _nested_performance_history_widgets, lengthof(_nested_performance_history_widgets)
818 void ShowPerformanceHistoryGraph()
820 AllocateWindowDescFront<PerformanceHistoryGraphWindow>(&_performance_history_desc, 0);
823 /*****************/
824 /* COMPANY VALUE */
825 /*****************/
827 struct CompanyValueGraphWindow : BaseGraphWindow {
828 CompanyValueGraphWindow(WindowDesc *desc, WindowNumber window_number) :
829 BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
831 this->InitializeWindow(window_number);
834 OverflowSafeInt64 GetGraphData(const Company *c, int j) override
836 return c->old_economy[j].company_value;
840 static const NWidgetPart _nested_company_value_graph_widgets[] = {
841 NWidget(NWID_HORIZONTAL),
842 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
843 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_COMPANY_VALUES_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
844 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),
845 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
846 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
847 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
848 EndContainer(),
849 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CV_BACKGROUND),
850 NWidget(NWID_HORIZONTAL),
851 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CV_GRAPH), SetMinimalSize(576, 224), SetFill(1, 1), SetResize(1, 1),
852 NWidget(NWID_VERTICAL),
853 NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
854 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CV_RESIZE),
855 EndContainer(),
856 EndContainer(),
857 EndContainer(),
860 static WindowDesc _company_value_graph_desc(
861 WDP_AUTO, "graph_company_value", 0, 0,
862 WC_COMPANY_VALUE, WC_NONE,
864 _nested_company_value_graph_widgets, lengthof(_nested_company_value_graph_widgets)
867 void ShowCompanyValueGraph()
869 AllocateWindowDescFront<CompanyValueGraphWindow>(&_company_value_graph_desc, 0);
872 /*****************/
873 /* PAYMENT RATES */
874 /*****************/
876 struct PaymentRatesGraphWindow : BaseGraphWindow {
877 uint line_height; ///< Pixel height of each cargo type row.
878 Scrollbar *vscroll; ///< Cargo list scrollbar.
880 PaymentRatesGraphWindow(WindowDesc *desc, WindowNumber window_number) :
881 BaseGraphWindow(desc, WID_CPR_GRAPH, STR_JUST_CURRENCY_SHORT)
883 this->num_on_x_axis = 20;
884 this->num_vert_lines = 20;
885 this->month = 0xFF;
886 this->x_values_start = 10;
887 this->x_values_increment = 10;
889 this->CreateNestedTree();
890 this->vscroll = this->GetScrollbar(WID_CPR_MATRIX_SCROLLBAR);
891 this->vscroll->SetCount(_sorted_standard_cargo_specs_size);
893 /* Initialise the dataset */
894 this->OnHundredthTick();
896 this->FinishInitNested(window_number);
899 void UpdateExcludedData()
901 this->excluded_data = 0;
903 int i = 0;
904 const CargoSpec *cs;
905 FOR_ALL_SORTED_STANDARD_CARGOSPECS(cs) {
906 if (HasBit(_legend_excluded_cargo, cs->Index())) SetBit(this->excluded_data, i);
907 i++;
911 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
913 if (widget != WID_CPR_MATRIX) {
914 BaseGraphWindow::UpdateWidgetSize(widget, size, padding, fill, resize);
915 return;
918 const CargoSpec *cs;
919 FOR_ALL_SORTED_STANDARD_CARGOSPECS(cs) {
920 SetDParam(0, cs->name);
921 Dimension d = GetStringBoundingBox(STR_GRAPH_CARGO_PAYMENT_CARGO);
922 d.width += 14; // colour field
923 d.width += WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
924 d.height += WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
925 *size = maxdim(d, *size);
928 this->line_height = size->height;
929 size->height = this->line_height * 11; /* Default number of cargo types in most climates. */
930 resize->width = 0;
931 resize->height = this->line_height;
934 void DrawWidget(const Rect &r, int widget) const override
936 if (widget != WID_CPR_MATRIX) {
937 BaseGraphWindow::DrawWidget(r, widget);
938 return;
941 bool rtl = _current_text_dir == TD_RTL;
943 int x = r.left + WD_FRAMERECT_LEFT;
944 int y = r.top;
946 int pos = this->vscroll->GetPosition();
947 int max = pos + this->vscroll->GetCapacity();
949 const CargoSpec *cs;
950 FOR_ALL_SORTED_STANDARD_CARGOSPECS(cs) {
951 if (pos-- > 0) continue;
952 if (--max < 0) break;
954 bool lowered = !HasBit(_legend_excluded_cargo, cs->Index());
956 /* Redraw box if lowered */
957 if (lowered) DrawFrameRect(r.left, y, r.right, y + this->line_height - 1, COLOUR_BROWN, lowered ? FR_LOWERED : FR_NONE);
959 byte clk_dif = lowered ? 1 : 0;
960 int rect_x = clk_dif + (rtl ? r.right - 12 : r.left + WD_FRAMERECT_LEFT);
962 GfxFillRect(rect_x, y + clk_dif, rect_x + 8, y + 5 + clk_dif, PC_BLACK);
963 GfxFillRect(rect_x + 1, y + 1 + clk_dif, rect_x + 7, y + 4 + clk_dif, cs->legend_colour);
964 SetDParam(0, cs->name);
965 DrawString(rtl ? r.left : x + 14 + clk_dif, (rtl ? r.right - 14 + clk_dif : r.right), y + clk_dif, STR_GRAPH_CARGO_PAYMENT_CARGO);
967 y += this->line_height;
971 void OnClick(Point pt, int widget, int click_count) override
973 switch (widget) {
974 case WID_CPR_ENABLE_CARGOES:
975 /* Remove all cargoes from the excluded lists. */
976 _legend_excluded_cargo = 0;
977 this->excluded_data = 0;
978 this->SetDirty();
979 break;
981 case WID_CPR_DISABLE_CARGOES: {
982 /* Add all cargoes to the excluded lists. */
983 int i = 0;
984 const CargoSpec *cs;
985 FOR_ALL_SORTED_STANDARD_CARGOSPECS(cs) {
986 SetBit(_legend_excluded_cargo, cs->Index());
987 SetBit(this->excluded_data, i);
988 i++;
990 this->SetDirty();
991 break;
994 case WID_CPR_MATRIX: {
995 uint row = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_CPR_MATRIX, 0, this->line_height);
996 if (row >= this->vscroll->GetCount()) return;
998 const CargoSpec *cs;
999 FOR_ALL_SORTED_STANDARD_CARGOSPECS(cs) {
1000 if (row-- > 0) continue;
1002 ToggleBit(_legend_excluded_cargo, cs->Index());
1003 this->UpdateExcludedData();
1004 this->SetDirty();
1005 break;
1007 break;
1012 void OnResize() override
1014 this->vscroll->SetCapacityFromWidget(this, WID_CPR_MATRIX);
1017 void OnGameTick() override
1019 /* Override default OnGameTick */
1023 * Some data on this window has become invalid.
1024 * @param data Information about the changed data.
1025 * @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.
1027 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1029 if (!gui_scope) return;
1030 this->OnHundredthTick();
1033 void OnHundredthTick() override
1035 this->UpdateExcludedData();
1037 int i = 0;
1038 const CargoSpec *cs;
1039 FOR_ALL_SORTED_STANDARD_CARGOSPECS(cs) {
1040 this->colours[i] = cs->legend_colour;
1041 for (uint j = 0; j != 20; j++) {
1042 this->cost[i][j] = GetTransportedGoodsIncome(10, 20, j * 4 + 4, cs->Index());
1044 i++;
1046 this->num_dataset = i;
1050 static const NWidgetPart _nested_cargo_payment_rates_widgets[] = {
1051 NWidget(NWID_HORIZONTAL),
1052 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1053 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_GRAPH_CARGO_PAYMENT_RATES_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1054 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1055 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1056 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1057 EndContainer(),
1058 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CPR_BACKGROUND), SetMinimalSize(568, 128),
1059 NWidget(NWID_HORIZONTAL),
1060 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1061 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),
1062 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1063 EndContainer(),
1064 NWidget(NWID_HORIZONTAL),
1065 NWidget(WWT_EMPTY, COLOUR_BROWN, WID_CPR_GRAPH), SetMinimalSize(495, 0), SetFill(1, 1), SetResize(1, 1),
1066 NWidget(NWID_VERTICAL),
1067 NWidget(NWID_SPACER), SetMinimalSize(0, 24), SetFill(0, 1),
1068 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_CPR_ENABLE_CARGOES), SetDataTip(STR_GRAPH_CARGO_ENABLE_ALL, STR_GRAPH_CARGO_TOOLTIP_ENABLE_ALL), SetFill(1, 0),
1069 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_CPR_DISABLE_CARGOES), SetDataTip(STR_GRAPH_CARGO_DISABLE_ALL, STR_GRAPH_CARGO_TOOLTIP_DISABLE_ALL), SetFill(1, 0),
1070 NWidget(NWID_SPACER), SetMinimalSize(0, 4),
1071 NWidget(NWID_HORIZONTAL),
1072 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),
1073 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_CPR_MATRIX_SCROLLBAR),
1074 EndContainer(),
1075 NWidget(NWID_SPACER), SetMinimalSize(0, 24), SetFill(0, 1),
1076 EndContainer(),
1077 NWidget(NWID_SPACER), SetMinimalSize(5, 0), SetFill(0, 1), SetResize(0, 1),
1078 EndContainer(),
1079 NWidget(NWID_HORIZONTAL),
1080 NWidget(NWID_SPACER), SetMinimalSize(WD_RESIZEBOX_WIDTH, 0), SetFill(1, 0), SetResize(1, 0),
1081 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),
1082 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1083 NWidget(WWT_RESIZEBOX, COLOUR_BROWN, WID_CPR_RESIZE),
1084 EndContainer(),
1085 EndContainer(),
1088 static WindowDesc _cargo_payment_rates_desc(
1089 WDP_AUTO, "graph_cargo_payment_rates", 0, 0,
1090 WC_PAYMENT_RATES, WC_NONE,
1092 _nested_cargo_payment_rates_widgets, lengthof(_nested_cargo_payment_rates_widgets)
1096 void ShowCargoPaymentRates()
1098 AllocateWindowDescFront<PaymentRatesGraphWindow>(&_cargo_payment_rates_desc, 0);
1101 /************************/
1102 /* COMPANY LEAGUE TABLE */
1103 /************************/
1105 static const StringID _performance_titles[] = {
1106 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ENGINEER,
1107 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ENGINEER,
1108 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRAFFIC_MANAGER,
1109 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRAFFIC_MANAGER,
1110 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRANSPORT_COORDINATOR,
1111 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRANSPORT_COORDINATOR,
1112 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ROUTE_SUPERVISOR,
1113 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ROUTE_SUPERVISOR,
1114 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_DIRECTOR,
1115 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_DIRECTOR,
1116 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHIEF_EXECUTIVE,
1117 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHIEF_EXECUTIVE,
1118 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHAIRMAN,
1119 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHAIRMAN,
1120 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_PRESIDENT,
1121 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TYCOON,
1124 static inline StringID GetPerformanceTitleFromValue(uint value)
1126 return _performance_titles[std::min(value, 1000u) >> 6];
1129 class CompanyLeagueWindow : public Window {
1130 private:
1131 GUIList<const Company*> companies;
1132 uint ordinal_width; ///< The width of the ordinal number
1133 uint text_width; ///< The width of the actual text
1134 uint icon_width; ///< The width of the company icon
1135 int line_height; ///< Height of the text lines
1138 * (Re)Build the company league list
1140 void BuildCompanyList()
1142 if (!this->companies.NeedRebuild()) return;
1144 this->companies.clear();
1146 for (const Company *c : Company::Iterate()) {
1147 this->companies.push_back(c);
1150 this->companies.shrink_to_fit();
1151 this->companies.RebuildDone();
1154 /** Sort the company league by performance history */
1155 static bool PerformanceSorter(const Company * const &c1, const Company * const &c2)
1157 return c2->old_economy[0].performance_history < c1->old_economy[0].performance_history;
1160 public:
1161 CompanyLeagueWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
1163 this->InitNested(window_number);
1164 this->companies.ForceRebuild();
1165 this->companies.NeedResort();
1168 void OnPaint() override
1170 this->BuildCompanyList();
1171 this->companies.Sort(&PerformanceSorter);
1173 this->DrawWidgets();
1176 void DrawWidget(const Rect &r, int widget) const override
1178 if (widget != WID_CL_BACKGROUND) return;
1180 int icon_y_offset = 1 + (FONT_HEIGHT_NORMAL - this->line_height) / 2;
1181 uint y = r.top + WD_FRAMERECT_TOP - icon_y_offset;
1183 bool rtl = _current_text_dir == TD_RTL;
1184 uint ordinal_left = rtl ? r.right - WD_FRAMERECT_LEFT - this->ordinal_width : r.left + WD_FRAMERECT_LEFT;
1185 uint ordinal_right = rtl ? r.right - WD_FRAMERECT_LEFT : r.left + WD_FRAMERECT_LEFT + this->ordinal_width;
1186 uint icon_left = r.left + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT + (rtl ? this->text_width : this->ordinal_width);
1187 uint text_left = rtl ? r.left + WD_FRAMERECT_LEFT : r.right - WD_FRAMERECT_LEFT - this->text_width;
1188 uint text_right = rtl ? r.left + WD_FRAMERECT_LEFT + this->text_width : r.right - WD_FRAMERECT_LEFT;
1190 for (uint i = 0; i != this->companies.size(); i++) {
1191 const Company *c = this->companies[i];
1192 DrawString(ordinal_left, ordinal_right, y, i + STR_ORDINAL_NUMBER_1ST, i == 0 ? TC_WHITE : TC_YELLOW);
1194 DrawCompanyIcon(c->index, icon_left, y + icon_y_offset);
1196 SetDParam(0, c->index);
1197 SetDParam(1, c->index);
1198 SetDParam(2, GetPerformanceTitleFromValue(c->old_economy[0].performance_history));
1199 DrawString(text_left, text_right, y, STR_COMPANY_LEAGUE_COMPANY_NAME);
1200 y += this->line_height;
1204 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1206 if (widget != WID_CL_BACKGROUND) return;
1208 this->ordinal_width = 0;
1209 for (uint i = 0; i < MAX_COMPANIES; i++) {
1210 this->ordinal_width = std::max(this->ordinal_width, GetStringBoundingBox(STR_ORDINAL_NUMBER_1ST + i).width);
1212 this->ordinal_width += 5; // Keep some extra spacing
1214 uint widest_width = 0;
1215 uint widest_title = 0;
1216 for (uint i = 0; i < lengthof(_performance_titles); i++) {
1217 uint width = GetStringBoundingBox(_performance_titles[i]).width;
1218 if (width > widest_width) {
1219 widest_title = i;
1220 widest_width = width;
1224 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
1225 this->icon_width = d.width + 2;
1226 this->line_height = std::max<int>(d.height + 2, FONT_HEIGHT_NORMAL);
1228 for (const Company *c : Company::Iterate()) {
1229 SetDParam(0, c->index);
1230 SetDParam(1, c->index);
1231 SetDParam(2, _performance_titles[widest_title]);
1232 widest_width = std::max(widest_width, GetStringBoundingBox(STR_COMPANY_LEAGUE_COMPANY_NAME).width);
1235 this->text_width = widest_width + 30; // Keep some extra spacing
1237 size->width = WD_FRAMERECT_LEFT + this->ordinal_width + WD_FRAMERECT_RIGHT + this->icon_width + WD_FRAMERECT_LEFT + this->text_width + WD_FRAMERECT_RIGHT;
1238 size->height = WD_FRAMERECT_TOP + this->line_height * MAX_COMPANIES + WD_FRAMERECT_BOTTOM;
1242 void OnGameTick() override
1244 if (this->companies.NeedResort()) {
1245 this->SetDirty();
1250 * Some data on this window has become invalid.
1251 * @param data Information about the changed data.
1252 * @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.
1254 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1256 if (data == 0) {
1257 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
1258 this->companies.ForceRebuild();
1259 } else {
1260 this->companies.ForceResort();
1265 static const NWidgetPart _nested_company_league_widgets[] = {
1266 NWidget(NWID_HORIZONTAL),
1267 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1268 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_COMPANY_LEAGUE_TABLE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1269 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1270 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1271 EndContainer(),
1272 NWidget(WWT_PANEL, COLOUR_BROWN, WID_CL_BACKGROUND), SetMinimalSize(400, 0), SetMinimalTextLines(15, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM),
1275 static WindowDesc _company_league_desc(
1276 WDP_AUTO, "league", 0, 0,
1277 WC_COMPANY_LEAGUE, WC_NONE,
1279 _nested_company_league_widgets, lengthof(_nested_company_league_widgets)
1282 void ShowCompanyLeagueTable()
1284 AllocateWindowDescFront<CompanyLeagueWindow>(&_company_league_desc, 0);
1287 /*****************************/
1288 /* PERFORMANCE RATING DETAIL */
1289 /*****************************/
1291 struct PerformanceRatingDetailWindow : Window {
1292 static CompanyID company;
1293 int timeout;
1295 PerformanceRatingDetailWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
1297 this->UpdateCompanyStats();
1299 this->InitNested(window_number);
1300 this->OnInvalidateData(INVALID_COMPANY);
1303 void UpdateCompanyStats()
1305 /* Update all company stats with the current data
1306 * (this is because _score_info is not saved to a savegame) */
1307 for (Company *c : Company::Iterate()) {
1308 UpdateCompanyRatingAndValue(c, false);
1311 this->timeout = DAY_TICKS * 5;
1314 uint score_info_left;
1315 uint score_info_right;
1316 uint bar_left;
1317 uint bar_right;
1318 uint bar_width;
1319 uint bar_height;
1320 uint score_detail_left;
1321 uint score_detail_right;
1323 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1325 switch (widget) {
1326 case WID_PRD_SCORE_FIRST:
1327 this->bar_height = FONT_HEIGHT_NORMAL + 4;
1328 size->height = this->bar_height + 2 * WD_MATRIX_TOP;
1330 uint score_info_width = 0;
1331 for (uint i = SCORE_BEGIN; i < SCORE_END; i++) {
1332 score_info_width = std::max(score_info_width, GetStringBoundingBox(STR_PERFORMANCE_DETAIL_VEHICLES + i).width);
1334 SetDParamMaxValue(0, 1000);
1335 score_info_width += GetStringBoundingBox(STR_BLACK_COMMA).width + WD_FRAMERECT_LEFT;
1337 SetDParamMaxValue(0, 100);
1338 this->bar_width = GetStringBoundingBox(STR_PERFORMANCE_DETAIL_PERCENT).width + 20; // Wide bars!
1340 /* At this number we are roughly at the max; it can become wider,
1341 * but then you need at 1000 times more money. At that time you're
1342 * not that interested anymore in the last few digits anyway.
1343 * The 500 is because 999 999 500 to 999 999 999 are rounded to
1344 * 1 000 M, and not 999 999 k. Use negative numbers to account for
1345 * the negative income/amount of money etc. as well. */
1346 int max = -(999999999 - 500);
1348 /* Scale max for the display currency. Prior to rendering the value
1349 * is converted into the display currency, which may cause it to
1350 * raise significantly. We need to compensate for that since {{CURRCOMPACT}}
1351 * is used, which can produce quite short renderings of very large
1352 * values. Otherwise the calculated width could be too narrow.
1353 * Note that it doesn't work if there was a currency with an exchange
1354 * rate greater than max.
1355 * When the currency rate is more than 1000, the 999 999 k becomes at
1356 * least 999 999 M which roughly is equally long. Furthermore if the
1357 * exchange rate is that high, 999 999 k is usually not enough anymore
1358 * to show the different currency numbers. */
1359 if (_currency->rate < 1000) max /= _currency->rate;
1360 SetDParam(0, max);
1361 SetDParam(1, max);
1362 uint score_detail_width = GetStringBoundingBox(STR_PERFORMANCE_DETAIL_AMOUNT_CURRENCY).width;
1364 size->width = 7 + score_info_width + 5 + this->bar_width + 5 + score_detail_width + 7;
1365 uint left = 7;
1366 uint right = size->width - 7;
1368 bool rtl = _current_text_dir == TD_RTL;
1369 this->score_info_left = rtl ? right - score_info_width : left;
1370 this->score_info_right = rtl ? right : left + score_info_width;
1372 this->score_detail_left = rtl ? left : right - score_detail_width;
1373 this->score_detail_right = rtl ? left + score_detail_width : right;
1375 this->bar_left = left + (rtl ? score_detail_width : score_info_width) + 5;
1376 this->bar_right = this->bar_left + this->bar_width;
1377 break;
1381 void DrawWidget(const Rect &r, int widget) const override
1383 /* No need to draw when there's nothing to draw */
1384 if (this->company == INVALID_COMPANY) return;
1386 if (IsInsideMM(widget, WID_PRD_COMPANY_FIRST, WID_PRD_COMPANY_LAST + 1)) {
1387 if (this->IsWidgetDisabled(widget)) return;
1388 CompanyID cid = (CompanyID)(widget - WID_PRD_COMPANY_FIRST);
1389 int offset = (cid == this->company) ? 1 : 0;
1390 Dimension sprite_size = GetSpriteSize(SPR_COMPANY_ICON);
1391 DrawCompanyIcon(cid, (r.left + r.right - sprite_size.width) / 2 + offset, (r.top + r.bottom - sprite_size.height) / 2 + offset);
1392 return;
1395 if (!IsInsideMM(widget, WID_PRD_SCORE_FIRST, WID_PRD_SCORE_LAST + 1)) return;
1397 ScoreID score_type = (ScoreID)(widget - WID_PRD_SCORE_FIRST);
1399 /* The colours used to show how the progress is going */
1400 int colour_done = _colour_gradient[COLOUR_GREEN][4];
1401 int colour_notdone = _colour_gradient[COLOUR_RED][4];
1403 /* Draw all the score parts */
1404 int64 val = _score_part[company][score_type];
1405 int64 needed = _score_info[score_type].needed;
1406 int score = _score_info[score_type].score;
1408 /* SCORE_TOTAL has his own rules ;) */
1409 if (score_type == SCORE_TOTAL) {
1410 for (ScoreID i = SCORE_BEGIN; i < SCORE_END; i++) score += _score_info[i].score;
1411 needed = SCORE_MAX;
1414 uint bar_top = r.top + WD_MATRIX_TOP;
1415 uint text_top = bar_top + 2;
1417 DrawString(this->score_info_left, this->score_info_right, text_top, STR_PERFORMANCE_DETAIL_VEHICLES + score_type);
1419 /* Draw the score */
1420 SetDParam(0, score);
1421 DrawString(this->score_info_left, this->score_info_right, text_top, STR_BLACK_COMMA, TC_FROMSTRING, SA_RIGHT);
1423 /* Calculate the %-bar */
1424 uint x = Clamp<int64>(val, 0, needed) * this->bar_width / needed;
1425 bool rtl = _current_text_dir == TD_RTL;
1426 if (rtl) {
1427 x = this->bar_right - x;
1428 } else {
1429 x = this->bar_left + x;
1432 /* Draw the bar */
1433 if (x != this->bar_left) GfxFillRect(this->bar_left, bar_top, x, bar_top + this->bar_height, rtl ? colour_notdone : colour_done);
1434 if (x != this->bar_right) GfxFillRect(x, bar_top, this->bar_right, bar_top + this->bar_height, rtl ? colour_done : colour_notdone);
1436 /* Draw it */
1437 SetDParam(0, Clamp<int64>(val, 0, needed) * 100 / needed);
1438 DrawString(this->bar_left, this->bar_right, text_top, STR_PERFORMANCE_DETAIL_PERCENT, TC_FROMSTRING, SA_HOR_CENTER);
1440 /* SCORE_LOAN is inversed */
1441 if (score_type == SCORE_LOAN) val = needed - val;
1443 /* Draw the amount we have against what is needed
1444 * For some of them it is in currency format */
1445 SetDParam(0, val);
1446 SetDParam(1, needed);
1447 switch (score_type) {
1448 case SCORE_MIN_PROFIT:
1449 case SCORE_MIN_INCOME:
1450 case SCORE_MAX_INCOME:
1451 case SCORE_MONEY:
1452 case SCORE_LOAN:
1453 DrawString(this->score_detail_left, this->score_detail_right, text_top, STR_PERFORMANCE_DETAIL_AMOUNT_CURRENCY);
1454 break;
1455 default:
1456 DrawString(this->score_detail_left, this->score_detail_right, text_top, STR_PERFORMANCE_DETAIL_AMOUNT_INT);
1460 void OnClick(Point pt, int widget, int click_count) override
1462 /* Check which button is clicked */
1463 if (IsInsideMM(widget, WID_PRD_COMPANY_FIRST, WID_PRD_COMPANY_LAST + 1)) {
1464 /* Is it no on disable? */
1465 if (!this->IsWidgetDisabled(widget)) {
1466 this->RaiseWidget(this->company + WID_PRD_COMPANY_FIRST);
1467 this->company = (CompanyID)(widget - WID_PRD_COMPANY_FIRST);
1468 this->LowerWidget(this->company + WID_PRD_COMPANY_FIRST);
1469 this->SetDirty();
1474 void OnGameTick() override
1476 /* Update the company score every 5 days */
1477 if (--this->timeout == 0) {
1478 this->UpdateCompanyStats();
1479 this->SetDirty();
1484 * Some data on this window has become invalid.
1485 * @param data the company ID of the company that is going to be removed
1486 * @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.
1488 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1490 if (!gui_scope) return;
1491 /* Disable the companies who are not active */
1492 for (CompanyID i = COMPANY_FIRST; i < MAX_COMPANIES; i++) {
1493 this->SetWidgetDisabledState(i + WID_PRD_COMPANY_FIRST, !Company::IsValidID(i));
1496 /* Check if the currently selected company is still active. */
1497 if (this->company != INVALID_COMPANY && !Company::IsValidID(this->company)) {
1498 /* Raise the widget for the previous selection. */
1499 this->RaiseWidget(this->company + WID_PRD_COMPANY_FIRST);
1500 this->company = INVALID_COMPANY;
1503 if (this->company == INVALID_COMPANY) {
1504 for (const Company *c : Company::Iterate()) {
1505 this->company = c->index;
1506 break;
1510 /* Make sure the widget is lowered */
1511 this->LowerWidget(this->company + WID_PRD_COMPANY_FIRST);
1515 CompanyID PerformanceRatingDetailWindow::company = INVALID_COMPANY;
1518 * Make a vertical list of panels for outputting score details.
1519 * @param biggest_index Storage for collecting the biggest index used in the returned tree.
1520 * @return Panel with performance details.
1521 * @post \c *biggest_index contains the largest used index in the tree.
1523 static NWidgetBase *MakePerformanceDetailPanels(int *biggest_index)
1525 const StringID performance_tips[] = {
1526 STR_PERFORMANCE_DETAIL_VEHICLES_TOOLTIP,
1527 STR_PERFORMANCE_DETAIL_STATIONS_TOOLTIP,
1528 STR_PERFORMANCE_DETAIL_MIN_PROFIT_TOOLTIP,
1529 STR_PERFORMANCE_DETAIL_MIN_INCOME_TOOLTIP,
1530 STR_PERFORMANCE_DETAIL_MAX_INCOME_TOOLTIP,
1531 STR_PERFORMANCE_DETAIL_DELIVERED_TOOLTIP,
1532 STR_PERFORMANCE_DETAIL_CARGO_TOOLTIP,
1533 STR_PERFORMANCE_DETAIL_MONEY_TOOLTIP,
1534 STR_PERFORMANCE_DETAIL_LOAN_TOOLTIP,
1535 STR_PERFORMANCE_DETAIL_TOTAL_TOOLTIP,
1538 static_assert(lengthof(performance_tips) == SCORE_END - SCORE_BEGIN);
1540 NWidgetVertical *vert = new NWidgetVertical(NC_EQUALSIZE);
1541 for (int widnum = WID_PRD_SCORE_FIRST; widnum <= WID_PRD_SCORE_LAST; widnum++) {
1542 NWidgetBackground *panel = new NWidgetBackground(WWT_PANEL, COLOUR_BROWN, widnum);
1543 panel->SetFill(1, 1);
1544 panel->SetDataTip(0x0, performance_tips[widnum - WID_PRD_SCORE_FIRST]);
1545 vert->Add(panel);
1547 *biggest_index = WID_PRD_SCORE_LAST;
1548 return vert;
1551 /** Make a number of rows with buttons for each company for the performance rating detail window. */
1552 NWidgetBase *MakeCompanyButtonRowsGraphGUI(int *biggest_index)
1554 return MakeCompanyButtonRows(biggest_index, WID_PRD_COMPANY_FIRST, WID_PRD_COMPANY_LAST, COLOUR_BROWN, 8, STR_PERFORMANCE_DETAIL_SELECT_COMPANY_TOOLTIP);
1557 static const NWidgetPart _nested_performance_rating_detail_widgets[] = {
1558 NWidget(NWID_HORIZONTAL),
1559 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1560 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_PERFORMANCE_DETAIL, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1561 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1562 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1563 EndContainer(),
1564 NWidget(WWT_PANEL, COLOUR_BROWN),
1565 NWidgetFunction(MakeCompanyButtonRowsGraphGUI), SetPadding(0, 1, 1, 2),
1566 EndContainer(),
1567 NWidgetFunction(MakePerformanceDetailPanels),
1570 static WindowDesc _performance_rating_detail_desc(
1571 WDP_AUTO, "league_details", 0, 0,
1572 WC_PERFORMANCE_DETAIL, WC_NONE,
1574 _nested_performance_rating_detail_widgets, lengthof(_nested_performance_rating_detail_widgets)
1577 void ShowPerformanceRatingDetail()
1579 AllocateWindowDescFront<PerformanceRatingDetailWindow>(&_performance_rating_detail_desc, 0);
1582 void InitializeGraphGui()
1584 _legend_excluded_companies = 0;
1585 _legend_excluded_cargo = 0;