OpenTTD
graph_gui.cpp
Go to the documentation of this file.
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  */
7 
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 
25 #include "widgets/graph_widget.h"
26 
27 #include "table/strings.h"
28 #include "table/sprites.h"
29 #include <math.h>
30 
31 #include "safeguards.h"
32 
33 /* Bitmasks of company and cargo indices that shouldn't be drawn. */
34 static CompanyMask _legend_excluded_companies;
35 static CargoTypes _legend_excluded_cargo;
36 
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.
40 
41 /****************/
42 /* GRAPH LEGEND */
43 /****************/
44 
47  {
48  this->InitNested(window_number);
49 
50  for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
51  if (!HasBit(_legend_excluded_companies, c)) this->LowerWidget(c + WID_GL_FIRST_COMPANY);
52 
53  this->OnInvalidateData(c);
54  }
55  }
56 
57  void DrawWidget(const Rect &r, int widget) const override
58  {
60 
61  CompanyID cid = (CompanyID)(widget - WID_GL_FIRST_COMPANY);
62 
63  if (!Company::IsValidID(cid)) return;
64 
65  bool rtl = _current_text_dir == TD_RTL;
66 
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);
69 
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);
73  }
74 
75  void OnClick(Point pt, int widget, int click_count) override
76  {
78 
79  ToggleBit(_legend_excluded_companies, widget - WID_GL_FIRST_COMPANY);
80  this->ToggleWidgetLoweredState(widget);
81  this->SetDirty();
87  }
88 
94  void OnInvalidateData(int data = 0, bool gui_scope = true) override
95  {
96  if (!gui_scope) return;
97  if (Company::IsValidID(data)) return;
98 
99  SetBit(_legend_excluded_companies, data);
100  this->RaiseWidget(data + WID_GL_FIRST_COMPANY);
101  }
102 };
103 
110 static NWidgetBase *MakeNWidgetCompanyLines(int *biggest_index)
111 {
112  NWidgetVertical *vert = new NWidgetVertical();
113  uint line_height = max<uint>(GetSpriteSize(SPR_COMPANY_ICON).height, FONT_HEIGHT_NORMAL) + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
114 
115  for (int widnum = WID_GL_FIRST_COMPANY; widnum <= WID_GL_LAST_COMPANY; widnum++) {
116  NWidgetBackground *panel = new NWidgetBackground(WWT_PANEL, COLOUR_GREY, 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);
121  }
122  *biggest_index = WID_GL_LAST_COMPANY;
123  return vert;
124 }
125 
126 static const NWidgetPart _nested_graph_legend_widgets[] = {
128  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
129  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GRAPH_KEY_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
130  NWidget(WWT_SHADEBOX, COLOUR_GREY),
131  NWidget(WWT_STICKYBOX, COLOUR_GREY),
132  EndContainer(),
133  NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_BACKGROUND),
139  EndContainer(),
140  EndContainer(),
141 };
142 
143 static WindowDesc _graph_legend_desc(
144  WDP_AUTO, "graph_legend", 0, 0,
146  0,
147  _nested_graph_legend_widgets, lengthof(_nested_graph_legend_widgets)
148 );
149 
150 static void ShowGraphLegend()
151 {
152  AllocateWindowDescFront<GraphLegendWindow>(&_graph_legend_desc, 0);
153 }
154 
159 };
160 
161 /******************/
162 /* BASE OF GRAPHS */
163 /*****************/
164 
166 protected:
167  static const int GRAPH_MAX_DATASETS = 64;
168  static const int GRAPH_AXIS_LINE_COLOUR = PC_BLACK;
169  static const int GRAPH_NUM_MONTHS = 24;
170 
171  static const int MIN_GRAPH_NUM_LINES_Y = 9;
172  static const int MIN_GRID_PIXEL_SIZE = 20;
173 
174  uint64 excluded_data;
175  byte num_dataset;
176  byte num_on_x_axis;
177  byte num_vert_lines;
178  static const TextColour graph_axis_label_colour = TC_BLACK;
179 
180  /* The starting month and year that values are plotted against. If month is
181  * 0xFF, use x_values_start and x_values_increment below instead. */
182  byte month;
183  Year year;
184 
185  /* These values are used if the graph is being plotted against values
186  * rather than the dates specified by month and year. */
187  uint16 x_values_start;
188  uint16 x_values_increment;
189 
190  int graph_widget;
191  StringID format_str_y_axis;
192  byte colours[GRAPH_MAX_DATASETS];
193  OverflowSafeInt64 cost[GRAPH_MAX_DATASETS][GRAPH_NUM_MONTHS];
194 
201  ValuesInterval GetValuesInterval(int num_hori_lines) const
202  {
203  assert(num_hori_lines > 0);
204 
205  ValuesInterval current_interval;
206  current_interval.highest = INT64_MIN;
207  current_interval.lowest = INT64_MAX;
208 
209  for (int i = 0; i < this->num_dataset; i++) {
210  if (HasBit(this->excluded_data, i)) continue;
211  for (int j = 0; j < this->num_on_x_axis; j++) {
212  OverflowSafeInt64 datapoint = this->cost[i][j];
213 
214  if (datapoint != INVALID_DATAPOINT) {
215  current_interval.highest = max(current_interval.highest, datapoint);
216  current_interval.lowest = min(current_interval.lowest, datapoint);
217  }
218  }
219  }
220 
221  /* Prevent showing values too close to the graph limits. */
222  current_interval.highest = (11 * current_interval.highest) / 10;
223  current_interval.lowest = (11 * current_interval.lowest) / 10;
224 
225  /* Always include zero in the shown range. */
226  double abs_lower = (current_interval.lowest > 0) ? 0 : (double)abs(current_interval.lowest);
227  double abs_higher = (current_interval.highest < 0) ? 0 : (double)current_interval.highest;
228 
229  int num_pos_grids;
230  int64 grid_size;
231 
232  if (abs_lower != 0 || abs_higher != 0) {
233  /* The number of grids to reserve for the positive part is: */
234  num_pos_grids = (int)floor(0.5 + num_hori_lines * abs_higher / (abs_higher + abs_lower));
235 
236  /* If there are any positive or negative values, force that they have at least one grid. */
237  if (num_pos_grids == 0 && abs_higher != 0) num_pos_grids++;
238  if (num_pos_grids == num_hori_lines && abs_lower != 0) num_pos_grids--;
239 
240  /* Get the required grid size for each side and use the maximum one. */
241  int64 grid_size_higher = (abs_higher > 0) ? ((int64)abs_higher + num_pos_grids - 1) / num_pos_grids : 0;
242  int64 grid_size_lower = (abs_lower > 0) ? ((int64)abs_lower + num_hori_lines - num_pos_grids - 1) / (num_hori_lines - num_pos_grids) : 0;
243  grid_size = max(grid_size_higher, grid_size_lower);
244  } else {
245  /* If both values are zero, show an empty graph. */
246  num_pos_grids = num_hori_lines / 2;
247  grid_size = 1;
248  }
249 
250  current_interval.highest = num_pos_grids * grid_size;
251  current_interval.lowest = -(num_hori_lines - num_pos_grids) * grid_size;
252  return current_interval;
253  }
254 
260  uint GetYLabelWidth(ValuesInterval current_interval, int num_hori_lines) const
261  {
262  /* draw text strings on the y axis */
263  int64 y_label = current_interval.highest;
264  int64 y_label_separation = (current_interval.highest - current_interval.lowest) / num_hori_lines;
265 
266  uint max_width = 0;
267 
268  for (int i = 0; i < (num_hori_lines + 1); i++) {
269  SetDParam(0, this->format_str_y_axis);
270  SetDParam(1, y_label);
271  Dimension d = GetStringBoundingBox(STR_GRAPH_Y_LABEL);
272  if (d.width > max_width) max_width = d.width;
273 
274  y_label -= y_label_separation;
275  }
276 
277  return max_width;
278  }
279 
284  void DrawGraph(Rect r) const
285  {
286  uint x, y;
287  ValuesInterval interval;
288  int x_axis_offset;
289 
290  /* the colours and cost array of GraphDrawer must accommodate
291  * both values for cargo and companies. So if any are higher, quit */
292  assert_compile(GRAPH_MAX_DATASETS >= (int)NUM_CARGO && GRAPH_MAX_DATASETS >= (int)MAX_COMPANIES);
293  assert(this->num_vert_lines > 0);
294 
295  byte grid_colour = _colour_gradient[COLOUR_GREY][4];
296 
297  /* Rect r will be adjusted to contain just the graph, with labels being
298  * placed outside the area. */
299  r.top += 5 + GetCharacterHeight(FS_SMALL) / 2;
300  r.bottom -= (this->month == 0xFF ? 1 : 3) * GetCharacterHeight(FS_SMALL) + 4;
301  r.left += 9;
302  r.right -= 5;
303 
304  /* Initial number of horizontal lines. */
305  int num_hori_lines = 160 / MIN_GRID_PIXEL_SIZE;
306  /* For the rest of the height, the number of horizontal lines will increase more slowly. */
307  int resize = (r.bottom - r.top - 160) / (2 * MIN_GRID_PIXEL_SIZE);
308  if (resize > 0) num_hori_lines += resize;
309 
310  interval = GetValuesInterval(num_hori_lines);
311 
312  int label_width = GetYLabelWidth(interval, num_hori_lines);
313 
314  r.left += label_width;
315 
316  int x_sep = (r.right - r.left) / this->num_vert_lines;
317  int y_sep = (r.bottom - r.top) / num_hori_lines;
318 
319  /* Redetermine right and bottom edge of graph to fit with the integer
320  * separation values. */
321  r.right = r.left + x_sep * this->num_vert_lines;
322  r.bottom = r.top + y_sep * num_hori_lines;
323 
324  OverflowSafeInt64 interval_size = interval.highest + abs(interval.lowest);
325  /* Where to draw the X axis. Use floating point to avoid overflowing and results of zero. */
326  x_axis_offset = (int)((r.bottom - r.top) * (double)interval.highest / (double)interval_size);
327 
328  /* Draw the vertical grid lines. */
329 
330  /* Don't draw the first line, as that's where the axis will be. */
331  x = r.left + x_sep;
332 
333  for (int i = 0; i < this->num_vert_lines; i++) {
334  GfxFillRect(x, r.top, x, r.bottom, grid_colour);
335  x += x_sep;
336  }
337 
338  /* Draw the horizontal grid lines. */
339  y = r.bottom;
340 
341  for (int i = 0; i < (num_hori_lines + 1); i++) {
342  GfxFillRect(r.left - 3, y, r.left - 1, y, GRAPH_AXIS_LINE_COLOUR);
343  GfxFillRect(r.left, y, r.right, y, grid_colour);
344  y -= y_sep;
345  }
346 
347  /* Draw the y axis. */
348  GfxFillRect(r.left, r.top, r.left, r.bottom, GRAPH_AXIS_LINE_COLOUR);
349 
350  /* Draw the x axis. */
351  y = x_axis_offset + r.top;
352  GfxFillRect(r.left, y, r.right, y, GRAPH_AXIS_LINE_COLOUR);
353 
354  /* Find the largest value that will be drawn. */
355  if (this->num_on_x_axis == 0) return;
356 
357  assert(this->num_on_x_axis > 0);
358  assert(this->num_dataset > 0);
359 
360  /* draw text strings on the y axis */
361  int64 y_label = interval.highest;
362  int64 y_label_separation = abs(interval.highest - interval.lowest) / num_hori_lines;
363 
364  y = r.top - GetCharacterHeight(FS_SMALL) / 2;
365 
366  for (int i = 0; i < (num_hori_lines + 1); i++) {
367  SetDParam(0, this->format_str_y_axis);
368  SetDParam(1, y_label);
369  DrawString(r.left - label_width - 4, r.left - 4, y, STR_GRAPH_Y_LABEL, graph_axis_label_colour, SA_RIGHT);
370 
371  y_label -= y_label_separation;
372  y += y_sep;
373  }
374 
375  /* draw strings on the x axis */
376  if (this->month != 0xFF) {
377  x = r.left;
378  y = r.bottom + 2;
379  byte month = this->month;
380  Year year = this->year;
381  for (int i = 0; i < this->num_on_x_axis; i++) {
382  SetDParam(0, month + STR_MONTH_ABBREV_JAN);
383  SetDParam(1, month + STR_MONTH_ABBREV_JAN + 2);
384  SetDParam(2, year);
385  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);
386 
387  month += 3;
388  if (month >= 12) {
389  month = 0;
390  year++;
391  }
392  x += x_sep;
393  }
394  } else {
395  /* Draw the label under the data point rather than on the grid line. */
396  x = r.left;
397  y = r.bottom + 2;
398  uint16 label = this->x_values_start;
399 
400  for (int i = 0; i < this->num_on_x_axis; i++) {
401  SetDParam(0, label);
402  DrawString(x + 1, x + x_sep - 1, y, STR_GRAPH_Y_LABEL_NUMBER, graph_axis_label_colour, SA_HOR_CENTER);
403 
404  label += this->x_values_increment;
405  x += x_sep;
406  }
407  }
408 
409  /* draw lines and dots */
410  uint linewidth = _settings_client.gui.graph_line_thickness;
411  uint pointoffs1 = (linewidth + 1) / 2;
412  uint pointoffs2 = linewidth + 1 - pointoffs1;
413  for (int i = 0; i < this->num_dataset; i++) {
414  if (!HasBit(this->excluded_data, i)) {
415  /* Centre the dot between the grid lines. */
416  x = r.left + (x_sep / 2);
417 
418  byte colour = this->colours[i];
419  uint prev_x = INVALID_DATAPOINT_POS;
420  uint prev_y = INVALID_DATAPOINT_POS;
421 
422  for (int j = 0; j < this->num_on_x_axis; j++) {
423  OverflowSafeInt64 datapoint = this->cost[i][j];
424 
425  if (datapoint != INVALID_DATAPOINT) {
426  /*
427  * Check whether we need to reduce the 'accuracy' of the
428  * datapoint value and the highest value to split overflows.
429  * And when 'drawing' 'one million' or 'one million and one'
430  * there is no significant difference, so the least
431  * significant bits can just be removed.
432  *
433  * If there are more bits needed than would fit in a 32 bits
434  * integer, so at about 31 bits because of the sign bit, the
435  * least significant bits are removed.
436  */
437  int mult_range = FindLastBit(x_axis_offset) + FindLastBit(abs(datapoint));
438  int reduce_range = max(mult_range - 31, 0);
439 
440  /* Handle negative values differently (don't shift sign) */
441  if (datapoint < 0) {
442  datapoint = -(abs(datapoint) >> reduce_range);
443  } else {
444  datapoint >>= reduce_range;
445  }
446  y = r.top + x_axis_offset - ((r.bottom - r.top) * datapoint) / (interval_size >> reduce_range);
447 
448  /* Draw the point. */
449  GfxFillRect(x - pointoffs1, y - pointoffs1, x + pointoffs2, y + pointoffs2, colour);
450 
451  /* Draw the line connected to the previous point. */
452  if (prev_x != INVALID_DATAPOINT_POS) GfxDrawLine(prev_x, prev_y, x, y, colour, linewidth);
453 
454  prev_x = x;
455  prev_y = y;
456  } else {
457  prev_x = INVALID_DATAPOINT_POS;
458  prev_y = INVALID_DATAPOINT_POS;
459  }
460 
461  x += x_sep;
462  }
463  }
464  }
465  }
466 
467 
468  BaseGraphWindow(WindowDesc *desc, int widget, StringID format_str_y_axis) :
469  Window(desc),
470  format_str_y_axis(format_str_y_axis)
471  {
473  this->num_vert_lines = 24;
474  this->graph_widget = widget;
475  }
476 
477  void InitializeWindow(WindowNumber number)
478  {
479  /* Initialise the dataset */
480  this->UpdateStatistics(true);
481 
482  this->InitNested(number);
483  }
484 
485 public:
486  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
487  {
488  if (widget != this->graph_widget) return;
489 
490  uint x_label_width = 0;
491 
492  if (this->month != 0xFF) {
493  byte month = this->month;
494  Year year = this->year;
495  for (int i = 0; i < this->num_on_x_axis; i++) {
496  SetDParam(0, month + STR_MONTH_ABBREV_JAN);
497  SetDParam(1, month + STR_MONTH_ABBREV_JAN + 2);
498  SetDParam(2, year);
499  x_label_width = max(x_label_width, GetStringBoundingBox(month == 0 ? STR_GRAPH_X_LABEL_MONTH_YEAR : STR_GRAPH_X_LABEL_MONTH).width);
500 
501  month += 3;
502  if (month >= 12) {
503  month = 0;
504  year++;
505  }
506  }
507  } else {
508  /* Draw the label under the data point rather than on the grid line. */
509  SetDParamMaxValue(0, this->x_values_start + this->num_on_x_axis * this->x_values_increment, 0, FS_SMALL);
510  x_label_width = GetStringBoundingBox(STR_GRAPH_Y_LABEL_NUMBER).width;
511  }
512 
513  SetDParam(0, this->format_str_y_axis);
514  SetDParam(1, INT64_MAX);
515  uint y_label_width = GetStringBoundingBox(STR_GRAPH_Y_LABEL).width;
516 
517  size->width = max<uint>(size->width, 5 + y_label_width + this->num_on_x_axis * (x_label_width + 5) + 9);
518  size->height = max<uint>(size->height, 5 + (1 + MIN_GRAPH_NUM_LINES_Y * 2 + (this->month != 0xFF ? 3 : 1)) * FONT_HEIGHT_SMALL + 4);
519  size->height = max<uint>(size->height, size->width / 3);
520  }
521 
522  void DrawWidget(const Rect &r, int widget) const override
523  {
524  if (widget != this->graph_widget) return;
525 
526  DrawGraph(r);
527  }
528 
529  virtual OverflowSafeInt64 GetGraphData(const Company *c, int j)
530  {
531  return INVALID_DATAPOINT;
532  }
533 
534  void OnClick(Point pt, int widget, int click_count) override
535  {
536  /* Clicked on legend? */
537  if (widget == WID_CV_KEY_BUTTON) ShowGraphLegend();
538  }
539 
540  void OnGameTick() override
541  {
542  this->UpdateStatistics(false);
543  }
544 
550  void OnInvalidateData(int data = 0, bool gui_scope = true) override
551  {
552  if (!gui_scope) return;
553  this->UpdateStatistics(true);
554  }
555 
560  void UpdateStatistics(bool initialize)
561  {
562  CompanyMask excluded_companies = _legend_excluded_companies;
563 
564  /* Exclude the companies which aren't valid */
565  for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
566  if (!Company::IsValidID(c)) SetBit(excluded_companies, c);
567  }
568 
569  byte nums = 0;
570  for (const Company *c : Company::Iterate()) {
571  nums = min(this->num_vert_lines, max(nums, c->num_valid_stat_ent));
572  }
573 
574  int mo = (_cur_month / 3 - nums) * 3;
575  int yr = _cur_year;
576  while (mo < 0) {
577  yr--;
578  mo += 12;
579  }
580 
581  if (!initialize && this->excluded_data == excluded_companies && this->num_on_x_axis == nums &&
582  this->year == yr && this->month == mo) {
583  /* There's no reason to get new stats */
584  return;
585  }
586 
587  this->excluded_data = excluded_companies;
588  this->num_on_x_axis = nums;
589  this->year = yr;
590  this->month = mo;
591 
592  int numd = 0;
593  for (CompanyID k = COMPANY_FIRST; k < MAX_COMPANIES; k++) {
594  const Company *c = Company::GetIfValid(k);
595  if (c != nullptr) {
596  this->colours[numd] = _colour_gradient[c->colour][6];
597  for (int j = this->num_on_x_axis, i = 0; --j >= 0;) {
598  this->cost[numd][i] = (j >= c->num_valid_stat_ent) ? INVALID_DATAPOINT : GetGraphData(c, j);
599  i++;
600  }
601  }
602  numd++;
603  }
604 
605  this->num_dataset = numd;
606  }
607 };
608 
609 
610 /********************/
611 /* OPERATING PROFIT */
612 /********************/
613 
616  BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
617  {
618  this->InitializeWindow(window_number);
619  }
620 
621  OverflowSafeInt64 GetGraphData(const Company *c, int j) override
622  {
623  return c->old_economy[j].income + c->old_economy[j].expenses;
624  }
625 };
626 
627 static const NWidgetPart _nested_operating_profit_widgets[] = {
629  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
630  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GRAPH_OPERATING_PROFIT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
631  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, 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),
632  NWidget(WWT_SHADEBOX, COLOUR_GREY),
633  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
634  NWidget(WWT_STICKYBOX, COLOUR_GREY),
635  EndContainer(),
636  NWidget(WWT_PANEL, COLOUR_GREY, WID_CV_BACKGROUND),
638  NWidget(WWT_EMPTY, COLOUR_GREY, WID_CV_GRAPH), SetMinimalSize(576, 160), SetFill(1, 1), SetResize(1, 1),
640  NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
641  NWidget(WWT_RESIZEBOX, COLOUR_GREY, WID_CV_RESIZE),
642  EndContainer(),
643  EndContainer(),
644  EndContainer(),
645 };
646 
647 static WindowDesc _operating_profit_desc(
648  WDP_AUTO, "graph_operating_profit", 0, 0,
650  0,
651  _nested_operating_profit_widgets, lengthof(_nested_operating_profit_widgets)
652 );
653 
654 
655 void ShowOperatingProfitGraph()
656 {
657  AllocateWindowDescFront<OperatingProfitGraphWindow>(&_operating_profit_desc, 0);
658 }
659 
660 
661 /****************/
662 /* INCOME GRAPH */
663 /****************/
664 
667  BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
668  {
669  this->InitializeWindow(window_number);
670  }
671 
672  OverflowSafeInt64 GetGraphData(const Company *c, int j) override
673  {
674  return c->old_economy[j].income;
675  }
676 };
677 
678 static const NWidgetPart _nested_income_graph_widgets[] = {
680  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
681  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GRAPH_INCOME_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
682  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, 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),
683  NWidget(WWT_SHADEBOX, COLOUR_GREY),
684  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
685  NWidget(WWT_STICKYBOX, COLOUR_GREY),
686  EndContainer(),
687  NWidget(WWT_PANEL, COLOUR_GREY, WID_CV_BACKGROUND),
689  NWidget(WWT_EMPTY, COLOUR_GREY, WID_CV_GRAPH), SetMinimalSize(576, 128), SetFill(1, 1), SetResize(1, 1),
691  NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
692  NWidget(WWT_RESIZEBOX, COLOUR_GREY, WID_CV_RESIZE),
693  EndContainer(),
694  EndContainer(),
695  EndContainer(),
696 };
697 
698 static WindowDesc _income_graph_desc(
699  WDP_AUTO, "graph_income", 0, 0,
701  0,
702  _nested_income_graph_widgets, lengthof(_nested_income_graph_widgets)
703 );
704 
705 void ShowIncomeGraph()
706 {
707  AllocateWindowDescFront<IncomeGraphWindow>(&_income_graph_desc, 0);
708 }
709 
710 /*******************/
711 /* DELIVERED CARGO */
712 /*******************/
713 
716  BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_COMMA)
717  {
718  this->InitializeWindow(window_number);
719  }
720 
721  OverflowSafeInt64 GetGraphData(const Company *c, int j) override
722  {
724  }
725 };
726 
727 static const NWidgetPart _nested_delivered_cargo_graph_widgets[] = {
729  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
730  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GRAPH_CARGO_DELIVERED_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
731  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, 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),
732  NWidget(WWT_SHADEBOX, COLOUR_GREY),
733  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
734  NWidget(WWT_STICKYBOX, COLOUR_GREY),
735  EndContainer(),
736  NWidget(WWT_PANEL, COLOUR_GREY, WID_CV_BACKGROUND),
738  NWidget(WWT_EMPTY, COLOUR_GREY, WID_CV_GRAPH), SetMinimalSize(576, 128), SetFill(1, 1), SetResize(1, 1),
740  NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
741  NWidget(WWT_RESIZEBOX, COLOUR_GREY, WID_CV_RESIZE),
742  EndContainer(),
743  EndContainer(),
744  EndContainer(),
745 };
746 
747 static WindowDesc _delivered_cargo_graph_desc(
748  WDP_AUTO, "graph_delivered_cargo", 0, 0,
750  0,
751  _nested_delivered_cargo_graph_widgets, lengthof(_nested_delivered_cargo_graph_widgets)
752 );
753 
754 void ShowDeliveredCargoGraph()
755 {
756  AllocateWindowDescFront<DeliveredCargoGraphWindow>(&_delivered_cargo_graph_desc, 0);
757 }
758 
759 /***********************/
760 /* PERFORMANCE HISTORY */
761 /***********************/
762 
765  BaseGraphWindow(desc, WID_PHG_GRAPH, STR_JUST_COMMA)
766  {
767  this->InitializeWindow(window_number);
768  }
769 
770  OverflowSafeInt64 GetGraphData(const Company *c, int j) override
771  {
772  return c->old_economy[j].performance_history;
773  }
774 
775  void OnClick(Point pt, int widget, int click_count) override
776  {
777  if (widget == WID_PHG_DETAILED_PERFORMANCE) ShowPerformanceRatingDetail();
778  this->BaseGraphWindow::OnClick(pt, widget, click_count);
779  }
780 };
781 
782 static const NWidgetPart _nested_performance_history_widgets[] = {
784  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
785  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GRAPH_COMPANY_PERFORMANCE_RATINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
786  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, 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),
787  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_PHG_KEY), SetMinimalSize(50, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_GRAPH_KEY_BUTTON, STR_GRAPH_KEY_TOOLTIP),
788  NWidget(WWT_SHADEBOX, COLOUR_GREY),
789  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
790  NWidget(WWT_STICKYBOX, COLOUR_GREY),
791  EndContainer(),
792  NWidget(WWT_PANEL, COLOUR_GREY, WID_PHG_BACKGROUND),
794  NWidget(WWT_EMPTY, COLOUR_GREY, WID_PHG_GRAPH), SetMinimalSize(576, 224), SetFill(1, 1), SetResize(1, 1),
796  NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
797  NWidget(WWT_RESIZEBOX, COLOUR_GREY, WID_PHG_RESIZE),
798  EndContainer(),
799  EndContainer(),
800  EndContainer(),
801 };
802 
803 static WindowDesc _performance_history_desc(
804  WDP_AUTO, "graph_performance", 0, 0,
806  0,
807  _nested_performance_history_widgets, lengthof(_nested_performance_history_widgets)
808 );
809 
810 void ShowPerformanceHistoryGraph()
811 {
812  AllocateWindowDescFront<PerformanceHistoryGraphWindow>(&_performance_history_desc, 0);
813 }
814 
815 /*****************/
816 /* COMPANY VALUE */
817 /*****************/
818 
821  BaseGraphWindow(desc, WID_CV_GRAPH, STR_JUST_CURRENCY_SHORT)
822  {
823  this->InitializeWindow(window_number);
824  }
825 
826  OverflowSafeInt64 GetGraphData(const Company *c, int j) override
827  {
828  return c->old_economy[j].company_value;
829  }
830 };
831 
832 static const NWidgetPart _nested_company_value_graph_widgets[] = {
834  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
835  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GRAPH_COMPANY_VALUES_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
836  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, 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),
837  NWidget(WWT_SHADEBOX, COLOUR_GREY),
838  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
839  NWidget(WWT_STICKYBOX, COLOUR_GREY),
840  EndContainer(),
841  NWidget(WWT_PANEL, COLOUR_GREY, WID_CV_BACKGROUND),
843  NWidget(WWT_EMPTY, COLOUR_GREY, WID_CV_GRAPH), SetMinimalSize(576, 224), SetFill(1, 1), SetResize(1, 1),
845  NWidget(NWID_SPACER), SetFill(0, 1), SetResize(0, 1),
846  NWidget(WWT_RESIZEBOX, COLOUR_GREY, WID_CV_RESIZE),
847  EndContainer(),
848  EndContainer(),
849  EndContainer(),
850 };
851 
852 static WindowDesc _company_value_graph_desc(
853  WDP_AUTO, "graph_company_value", 0, 0,
855  0,
856  _nested_company_value_graph_widgets, lengthof(_nested_company_value_graph_widgets)
857 );
858 
859 void ShowCompanyValueGraph()
860 {
861  AllocateWindowDescFront<CompanyValueGraphWindow>(&_company_value_graph_desc, 0);
862 }
863 
864 /*****************/
865 /* PAYMENT RATES */
866 /*****************/
867 
869  uint line_height;
871 
873  BaseGraphWindow(desc, WID_CPR_GRAPH, STR_JUST_CURRENCY_SHORT)
874  {
875  this->num_on_x_axis = 20;
876  this->num_vert_lines = 20;
877  this->month = 0xFF;
878  this->x_values_start = 10;
879  this->x_values_increment = 10;
880 
881  this->CreateNestedTree();
882  this->vscroll = this->GetScrollbar(WID_CPR_MATRIX_SCROLLBAR);
884 
885  /* Initialise the dataset */
886  this->OnHundredthTick();
887 
888  this->FinishInitNested(window_number);
889  }
890 
891  void UpdateExcludedData()
892  {
893  this->excluded_data = 0;
894 
895  int i = 0;
896  const CargoSpec *cs;
898  if (HasBit(_legend_excluded_cargo, cs->Index())) SetBit(this->excluded_data, i);
899  i++;
900  }
901  }
902 
903  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
904  {
905  if (widget != WID_CPR_MATRIX) {
906  BaseGraphWindow::UpdateWidgetSize(widget, size, padding, fill, resize);
907  return;
908  }
909 
910  const CargoSpec *cs;
912  SetDParam(0, cs->name);
913  Dimension d = GetStringBoundingBox(STR_GRAPH_CARGO_PAYMENT_CARGO);
914  d.width += 14; // colour field
917  *size = maxdim(d, *size);
918  }
919 
920  this->line_height = size->height;
921  size->height = this->line_height * 11; /* Default number of cargo types in most climates. */
922  resize->width = 0;
923  resize->height = this->line_height;
924  }
925 
926  void DrawWidget(const Rect &r, int widget) const override
927  {
928  if (widget != WID_CPR_MATRIX) {
929  BaseGraphWindow::DrawWidget(r, widget);
930  return;
931  }
932 
933  bool rtl = _current_text_dir == TD_RTL;
934 
935  int x = r.left + WD_FRAMERECT_LEFT;
936  int y = r.top;
937 
938  int pos = this->vscroll->GetPosition();
939  int max = pos + this->vscroll->GetCapacity();
940 
941  const CargoSpec *cs;
943  if (pos-- > 0) continue;
944  if (--max < 0) break;
945 
946  bool lowered = !HasBit(_legend_excluded_cargo, cs->Index());
947 
948  /* Redraw box if lowered */
949  if (lowered) DrawFrameRect(r.left, y, r.right, y + this->line_height - 1, COLOUR_ORANGE, lowered ? FR_LOWERED : FR_NONE);
950 
951  byte clk_dif = lowered ? 1 : 0;
952  int rect_x = clk_dif + (rtl ? r.right - 12 : r.left + WD_FRAMERECT_LEFT);
953 
954  GfxFillRect(rect_x, y + clk_dif, rect_x + 8, y + 5 + clk_dif, PC_BLACK);
955  GfxFillRect(rect_x + 1, y + 1 + clk_dif, rect_x + 7, y + 4 + clk_dif, cs->legend_colour);
956  SetDParam(0, cs->name);
957  DrawString(rtl ? r.left : x + 14 + clk_dif, (rtl ? r.right - 14 + clk_dif : r.right), y + clk_dif, STR_GRAPH_CARGO_PAYMENT_CARGO);
958 
959  y += this->line_height;
960  }
961  }
962 
963  void OnClick(Point pt, int widget, int click_count) override
964  {
965  switch (widget) {
967  /* Remove all cargoes from the excluded lists. */
968  _legend_excluded_cargo = 0;
969  this->excluded_data = 0;
970  this->SetDirty();
971  break;
972 
974  /* Add all cargoes to the excluded lists. */
975  int i = 0;
976  const CargoSpec *cs;
978  SetBit(_legend_excluded_cargo, cs->Index());
979  SetBit(this->excluded_data, i);
980  i++;
981  }
982  this->SetDirty();
983  break;
984  }
985 
986  case WID_CPR_MATRIX: {
987  uint row = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_CPR_MATRIX, 0, this->line_height);
988  if (row >= this->vscroll->GetCount()) return;
989 
990  const CargoSpec *cs;
992  if (row-- > 0) continue;
993 
994  ToggleBit(_legend_excluded_cargo, cs->Index());
995  this->UpdateExcludedData();
996  this->SetDirty();
997  break;
998  }
999  break;
1000  }
1001  }
1002  }
1003 
1004  void OnResize() override
1005  {
1006  this->vscroll->SetCapacityFromWidget(this, WID_CPR_MATRIX);
1007  }
1008 
1009  void OnGameTick() override
1010  {
1011  /* Override default OnGameTick */
1012  }
1013 
1019  void OnInvalidateData(int data = 0, bool gui_scope = true) override
1020  {
1021  if (!gui_scope) return;
1022  this->OnHundredthTick();
1023  }
1024 
1025  void OnHundredthTick() override
1026  {
1027  this->UpdateExcludedData();
1028 
1029  int i = 0;
1030  const CargoSpec *cs;
1032  this->colours[i] = cs->legend_colour;
1033  for (uint j = 0; j != 20; j++) {
1034  this->cost[i][j] = GetTransportedGoodsIncome(10, 20, j * 4 + 4, cs->Index());
1035  }
1036  i++;
1037  }
1038  this->num_dataset = i;
1039  }
1040 };
1041 
1042 static const NWidgetPart _nested_cargo_payment_rates_widgets[] = {
1044  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1045  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GRAPH_CARGO_PAYMENT_RATES_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1046  NWidget(WWT_SHADEBOX, COLOUR_GREY),
1047  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1048  NWidget(WWT_STICKYBOX, COLOUR_GREY),
1049  EndContainer(),
1050  NWidget(WWT_PANEL, COLOUR_GREY, WID_CPR_BACKGROUND), SetMinimalSize(568, 128),
1052  NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1053  NWidget(WWT_TEXT, COLOUR_GREY, WID_CPR_HEADER), SetMinimalSize(0, 6), SetPadding(2, 0, 2, 0), SetDataTip(STR_GRAPH_CARGO_PAYMENT_RATES_TITLE, STR_NULL),
1054  NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1055  EndContainer(),
1057  NWidget(WWT_EMPTY, COLOUR_GREY, WID_CPR_GRAPH), SetMinimalSize(495, 0), SetFill(1, 1), SetResize(1, 1),
1059  NWidget(NWID_SPACER), SetMinimalSize(0, 24), SetFill(0, 1),
1060  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_CPR_ENABLE_CARGOES), SetDataTip(STR_GRAPH_CARGO_ENABLE_ALL, STR_GRAPH_CARGO_TOOLTIP_ENABLE_ALL), SetFill(1, 0),
1061  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_CPR_DISABLE_CARGOES), SetDataTip(STR_GRAPH_CARGO_DISABLE_ALL, STR_GRAPH_CARGO_TOOLTIP_DISABLE_ALL), SetFill(1, 0),
1064  NWidget(WWT_MATRIX, COLOUR_ORANGE, WID_CPR_MATRIX), SetResize(0, 2), SetMatrixDataTip(1, 0, STR_GRAPH_CARGO_PAYMENT_TOGGLE_CARGO), SetScrollbar(WID_CPR_MATRIX_SCROLLBAR),
1066  EndContainer(),
1067  NWidget(NWID_SPACER), SetMinimalSize(0, 24), SetFill(0, 1),
1068  EndContainer(),
1069  NWidget(NWID_SPACER), SetMinimalSize(5, 0), SetFill(0, 1), SetResize(0, 1),
1070  EndContainer(),
1073  NWidget(WWT_TEXT, COLOUR_GREY, WID_CPR_FOOTER), SetMinimalSize(0, 6), SetPadding(2, 0, 2, 0), SetDataTip(STR_GRAPH_CARGO_PAYMENT_RATES_X_LABEL, STR_NULL),
1074  NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1075  NWidget(WWT_RESIZEBOX, COLOUR_GREY, WID_CPR_RESIZE),
1076  EndContainer(),
1077  EndContainer(),
1078 };
1079 
1080 static WindowDesc _cargo_payment_rates_desc(
1081  WDP_AUTO, "graph_cargo_payment_rates", 0, 0,
1083  0,
1084  _nested_cargo_payment_rates_widgets, lengthof(_nested_cargo_payment_rates_widgets)
1085 );
1086 
1087 
1088 void ShowCargoPaymentRates()
1089 {
1090  AllocateWindowDescFront<PaymentRatesGraphWindow>(&_cargo_payment_rates_desc, 0);
1091 }
1092 
1093 /************************/
1094 /* COMPANY LEAGUE TABLE */
1095 /************************/
1096 
1097 static const StringID _performance_titles[] = {
1098  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ENGINEER,
1099  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ENGINEER,
1100  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRAFFIC_MANAGER,
1101  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRAFFIC_MANAGER,
1102  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRANSPORT_COORDINATOR,
1103  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRANSPORT_COORDINATOR,
1104  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ROUTE_SUPERVISOR,
1105  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ROUTE_SUPERVISOR,
1106  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_DIRECTOR,
1107  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_DIRECTOR,
1108  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHIEF_EXECUTIVE,
1109  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHIEF_EXECUTIVE,
1110  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHAIRMAN,
1111  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHAIRMAN,
1112  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_PRESIDENT,
1113  STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TYCOON,
1114 };
1115 
1116 static inline StringID GetPerformanceTitleFromValue(uint value)
1117 {
1118  return _performance_titles[minu(value, 1000) >> 6];
1119 }
1120 
1121 class CompanyLeagueWindow : public Window {
1122 private:
1123  GUIList<const Company*> companies;
1125  uint text_width;
1126  uint icon_width;
1128 
1133  {
1134  if (!this->companies.NeedRebuild()) return;
1135 
1136  this->companies.clear();
1137 
1138  for (const Company *c : Company::Iterate()) {
1139  this->companies.push_back(c);
1140  }
1141 
1142  this->companies.shrink_to_fit();
1143  this->companies.RebuildDone();
1144  }
1145 
1147  static bool PerformanceSorter(const Company * const &c1, const Company * const &c2)
1148  {
1150  }
1151 
1152 public:
1154  {
1155  this->InitNested(window_number);
1156  this->companies.ForceRebuild();
1157  this->companies.NeedResort();
1158  }
1159 
1160  void OnPaint() override
1161  {
1162  this->BuildCompanyList();
1163  this->companies.Sort(&PerformanceSorter);
1164 
1165  this->DrawWidgets();
1166  }
1167 
1168  void DrawWidget(const Rect &r, int widget) const override
1169  {
1170  if (widget != WID_CL_BACKGROUND) return;
1171 
1172  int icon_y_offset = 1 + (FONT_HEIGHT_NORMAL - this->line_height) / 2;
1173  uint y = r.top + WD_FRAMERECT_TOP - icon_y_offset;
1174 
1175  bool rtl = _current_text_dir == TD_RTL;
1176  uint ordinal_left = rtl ? r.right - WD_FRAMERECT_LEFT - this->ordinal_width : r.left + WD_FRAMERECT_LEFT;
1177  uint ordinal_right = rtl ? r.right - WD_FRAMERECT_LEFT : r.left + WD_FRAMERECT_LEFT + this->ordinal_width;
1178  uint icon_left = r.left + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT + (rtl ? this->text_width : this->ordinal_width);
1179  uint text_left = rtl ? r.left + WD_FRAMERECT_LEFT : r.right - WD_FRAMERECT_LEFT - this->text_width;
1180  uint text_right = rtl ? r.left + WD_FRAMERECT_LEFT + this->text_width : r.right - WD_FRAMERECT_LEFT;
1181 
1182  for (uint i = 0; i != this->companies.size(); i++) {
1183  const Company *c = this->companies[i];
1184  DrawString(ordinal_left, ordinal_right, y, i + STR_ORDINAL_NUMBER_1ST, i == 0 ? TC_WHITE : TC_YELLOW);
1185 
1186  DrawCompanyIcon(c->index, icon_left, y + icon_y_offset);
1187 
1188  SetDParam(0, c->index);
1189  SetDParam(1, c->index);
1190  SetDParam(2, GetPerformanceTitleFromValue(c->old_economy[0].performance_history));
1191  DrawString(text_left, text_right, y, STR_COMPANY_LEAGUE_COMPANY_NAME);
1192  y += this->line_height;
1193  }
1194  }
1195 
1196  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1197  {
1198  if (widget != WID_CL_BACKGROUND) return;
1199 
1200  this->ordinal_width = 0;
1201  for (uint i = 0; i < MAX_COMPANIES; i++) {
1202  this->ordinal_width = max(this->ordinal_width, GetStringBoundingBox(STR_ORDINAL_NUMBER_1ST + i).width);
1203  }
1204  this->ordinal_width += 5; // Keep some extra spacing
1205 
1206  uint widest_width = 0;
1207  uint widest_title = 0;
1208  for (uint i = 0; i < lengthof(_performance_titles); i++) {
1209  uint width = GetStringBoundingBox(_performance_titles[i]).width;
1210  if (width > widest_width) {
1211  widest_title = i;
1212  widest_width = width;
1213  }
1214  }
1215 
1216  Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
1217  this->icon_width = d.width + 2;
1218  this->line_height = max<int>(d.height + 2, FONT_HEIGHT_NORMAL);
1219 
1220  for (const Company *c : Company::Iterate()) {
1221  SetDParam(0, c->index);
1222  SetDParam(1, c->index);
1223  SetDParam(2, _performance_titles[widest_title]);
1224  widest_width = max(widest_width, GetStringBoundingBox(STR_COMPANY_LEAGUE_COMPANY_NAME).width);
1225  }
1226 
1227  this->text_width = widest_width + 30; // Keep some extra spacing
1228 
1229  size->width = WD_FRAMERECT_LEFT + this->ordinal_width + WD_FRAMERECT_RIGHT + this->icon_width + WD_FRAMERECT_LEFT + this->text_width + WD_FRAMERECT_RIGHT;
1230  size->height = WD_FRAMERECT_TOP + this->line_height * MAX_COMPANIES + WD_FRAMERECT_BOTTOM;
1231  }
1232 
1233 
1234  void OnGameTick() override
1235  {
1236  if (this->companies.NeedResort()) {
1237  this->SetDirty();
1238  }
1239  }
1240 
1246  void OnInvalidateData(int data = 0, bool gui_scope = true) override
1247  {
1248  if (data == 0) {
1249  /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
1250  this->companies.ForceRebuild();
1251  } else {
1252  this->companies.ForceResort();
1253  }
1254  }
1255 };
1256 
1257 static const NWidgetPart _nested_company_league_widgets[] = {
1259  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1260  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_COMPANY_LEAGUE_TABLE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1261  NWidget(WWT_SHADEBOX, COLOUR_GREY),
1262  NWidget(WWT_STICKYBOX, COLOUR_GREY),
1263  EndContainer(),
1265 };
1266 
1267 static WindowDesc _company_league_desc(
1268  WDP_AUTO, "league", 0, 0,
1270  0,
1271  _nested_company_league_widgets, lengthof(_nested_company_league_widgets)
1272 );
1273 
1274 void ShowCompanyLeagueTable()
1275 {
1276  AllocateWindowDescFront<CompanyLeagueWindow>(&_company_league_desc, 0);
1277 }
1278 
1279 /*****************************/
1280 /* PERFORMANCE RATING DETAIL */
1281 /*****************************/
1282 
1284  static CompanyID company;
1285  int timeout;
1286 
1288  {
1289  this->UpdateCompanyStats();
1290 
1291  this->InitNested(window_number);
1293  }
1294 
1295  void UpdateCompanyStats()
1296  {
1297  /* Update all company stats with the current data
1298  * (this is because _score_info is not saved to a savegame) */
1299  for (Company *c : Company::Iterate()) {
1300  UpdateCompanyRatingAndValue(c, false);
1301  }
1302 
1303  this->timeout = DAY_TICKS * 5;
1304  }
1305 
1306  uint score_info_left;
1307  uint score_info_right;
1308  uint bar_left;
1309  uint bar_right;
1310  uint bar_width;
1311  uint bar_height;
1312  uint score_detail_left;
1313  uint score_detail_right;
1314 
1315  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1316  {
1317  switch (widget) {
1318  case WID_PRD_SCORE_FIRST:
1319  this->bar_height = FONT_HEIGHT_NORMAL + 4;
1320  size->height = this->bar_height + 2 * WD_MATRIX_TOP;
1321 
1322  uint score_info_width = 0;
1323  for (uint i = SCORE_BEGIN; i < SCORE_END; i++) {
1324  score_info_width = max(score_info_width, GetStringBoundingBox(STR_PERFORMANCE_DETAIL_VEHICLES + i).width);
1325  }
1326  SetDParamMaxValue(0, 1000);
1327  score_info_width += GetStringBoundingBox(STR_BLACK_COMMA).width + WD_FRAMERECT_LEFT;
1328 
1329  SetDParamMaxValue(0, 100);
1330  this->bar_width = GetStringBoundingBox(STR_PERFORMANCE_DETAIL_PERCENT).width + 20; // Wide bars!
1331 
1332  /* At this number we are roughly at the max; it can become wider,
1333  * but then you need at 1000 times more money. At that time you're
1334  * not that interested anymore in the last few digits anyway.
1335  * The 500 is because 999 999 500 to 999 999 999 are rounded to
1336  * 1 000 M, and not 999 999 k. Use negative numbers to account for
1337  * the negative income/amount of money etc. as well. */
1338  int max = -(999999999 - 500);
1339 
1340  /* Scale max for the display currency. Prior to rendering the value
1341  * is converted into the display currency, which may cause it to
1342  * raise significantly. We need to compensate for that since {{CURRCOMPACT}}
1343  * is used, which can produce quite short renderings of very large
1344  * values. Otherwise the calculated width could be too narrow.
1345  * Note that it doesn't work if there was a currency with an exchange
1346  * rate greater than max.
1347  * When the currency rate is more than 1000, the 999 999 k becomes at
1348  * least 999 999 M which roughly is equally long. Furthermore if the
1349  * exchange rate is that high, 999 999 k is usually not enough anymore
1350  * to show the different currency numbers. */
1351  if (_currency->rate < 1000) max /= _currency->rate;
1352  SetDParam(0, max);
1353  SetDParam(1, max);
1354  uint score_detail_width = GetStringBoundingBox(STR_PERFORMANCE_DETAIL_AMOUNT_CURRENCY).width;
1355 
1356  size->width = 7 + score_info_width + 5 + this->bar_width + 5 + score_detail_width + 7;
1357  uint left = 7;
1358  uint right = size->width - 7;
1359 
1360  bool rtl = _current_text_dir == TD_RTL;
1361  this->score_info_left = rtl ? right - score_info_width : left;
1362  this->score_info_right = rtl ? right : left + score_info_width;
1363 
1364  this->score_detail_left = rtl ? left : right - score_detail_width;
1365  this->score_detail_right = rtl ? left + score_detail_width : right;
1366 
1367  this->bar_left = left + (rtl ? score_detail_width : score_info_width) + 5;
1368  this->bar_right = this->bar_left + this->bar_width;
1369  break;
1370  }
1371  }
1372 
1373  void DrawWidget(const Rect &r, int widget) const override
1374  {
1375  /* No need to draw when there's nothing to draw */
1376  if (this->company == INVALID_COMPANY) return;
1377 
1379  if (this->IsWidgetDisabled(widget)) return;
1380  CompanyID cid = (CompanyID)(widget - WID_PRD_COMPANY_FIRST);
1381  int offset = (cid == this->company) ? 1 : 0;
1382  Dimension sprite_size = GetSpriteSize(SPR_COMPANY_ICON);
1383  DrawCompanyIcon(cid, (r.left + r.right - sprite_size.width) / 2 + offset, (r.top + r.bottom - sprite_size.height) / 2 + offset);
1384  return;
1385  }
1386 
1387  if (!IsInsideMM(widget, WID_PRD_SCORE_FIRST, WID_PRD_SCORE_LAST + 1)) return;
1388 
1389  ScoreID score_type = (ScoreID)(widget - WID_PRD_SCORE_FIRST);
1390 
1391  /* The colours used to show how the progress is going */
1392  int colour_done = _colour_gradient[COLOUR_GREEN][4];
1393  int colour_notdone = _colour_gradient[COLOUR_RED][4];
1394 
1395  /* Draw all the score parts */
1396  int64 val = _score_part[company][score_type];
1397  int64 needed = _score_info[score_type].needed;
1398  int score = _score_info[score_type].score;
1399 
1400  /* SCORE_TOTAL has his own rules ;) */
1401  if (score_type == SCORE_TOTAL) {
1402  for (ScoreID i = SCORE_BEGIN; i < SCORE_END; i++) score += _score_info[i].score;
1403  needed = SCORE_MAX;
1404  }
1405 
1406  uint bar_top = r.top + WD_MATRIX_TOP;
1407  uint text_top = bar_top + 2;
1408 
1409  DrawString(this->score_info_left, this->score_info_right, text_top, STR_PERFORMANCE_DETAIL_VEHICLES + score_type);
1410 
1411  /* Draw the score */
1412  SetDParam(0, score);
1413  DrawString(this->score_info_left, this->score_info_right, text_top, STR_BLACK_COMMA, TC_FROMSTRING, SA_RIGHT);
1414 
1415  /* Calculate the %-bar */
1416  uint x = Clamp<int64>(val, 0, needed) * this->bar_width / needed;
1417  bool rtl = _current_text_dir == TD_RTL;
1418  if (rtl) {
1419  x = this->bar_right - x;
1420  } else {
1421  x = this->bar_left + x;
1422  }
1423 
1424  /* Draw the bar */
1425  if (x != this->bar_left) GfxFillRect(this->bar_left, bar_top, x, bar_top + this->bar_height, rtl ? colour_notdone : colour_done);
1426  if (x != this->bar_right) GfxFillRect(x, bar_top, this->bar_right, bar_top + this->bar_height, rtl ? colour_done : colour_notdone);
1427 
1428  /* Draw it */
1429  SetDParam(0, Clamp<int64>(val, 0, needed) * 100 / needed);
1430  DrawString(this->bar_left, this->bar_right, text_top, STR_PERFORMANCE_DETAIL_PERCENT, TC_FROMSTRING, SA_HOR_CENTER);
1431 
1432  /* SCORE_LOAN is inversed */
1433  if (score_type == SCORE_LOAN) val = needed - val;
1434 
1435  /* Draw the amount we have against what is needed
1436  * For some of them it is in currency format */
1437  SetDParam(0, val);
1438  SetDParam(1, needed);
1439  switch (score_type) {
1440  case SCORE_MIN_PROFIT:
1441  case SCORE_MIN_INCOME:
1442  case SCORE_MAX_INCOME:
1443  case SCORE_MONEY:
1444  case SCORE_LOAN:
1445  DrawString(this->score_detail_left, this->score_detail_right, text_top, STR_PERFORMANCE_DETAIL_AMOUNT_CURRENCY);
1446  break;
1447  default:
1448  DrawString(this->score_detail_left, this->score_detail_right, text_top, STR_PERFORMANCE_DETAIL_AMOUNT_INT);
1449  }
1450  }
1451 
1452  void OnClick(Point pt, int widget, int click_count) override
1453  {
1454  /* Check which button is clicked */
1456  /* Is it no on disable? */
1457  if (!this->IsWidgetDisabled(widget)) {
1458  this->RaiseWidget(this->company + WID_PRD_COMPANY_FIRST);
1459  this->company = (CompanyID)(widget - WID_PRD_COMPANY_FIRST);
1460  this->LowerWidget(this->company + WID_PRD_COMPANY_FIRST);
1461  this->SetDirty();
1462  }
1463  }
1464  }
1465 
1466  void OnGameTick() override
1467  {
1468  /* Update the company score every 5 days */
1469  if (--this->timeout == 0) {
1470  this->UpdateCompanyStats();
1471  this->SetDirty();
1472  }
1473  }
1474 
1480  void OnInvalidateData(int data = 0, bool gui_scope = true) override
1481  {
1482  if (!gui_scope) return;
1483  /* Disable the companies who are not active */
1484  for (CompanyID i = COMPANY_FIRST; i < MAX_COMPANIES; i++) {
1486  }
1487 
1488  /* Check if the currently selected company is still active. */
1489  if (this->company != INVALID_COMPANY && !Company::IsValidID(this->company)) {
1490  /* Raise the widget for the previous selection. */
1491  this->RaiseWidget(this->company + WID_PRD_COMPANY_FIRST);
1492  this->company = INVALID_COMPANY;
1493  }
1494 
1495  if (this->company == INVALID_COMPANY) {
1496  for (const Company *c : Company::Iterate()) {
1497  this->company = c->index;
1498  break;
1499  }
1500  }
1501 
1502  /* Make sure the widget is lowered */
1503  this->LowerWidget(this->company + WID_PRD_COMPANY_FIRST);
1504  }
1505 };
1506 
1507 CompanyID PerformanceRatingDetailWindow::company = INVALID_COMPANY;
1508 
1515 static NWidgetBase *MakePerformanceDetailPanels(int *biggest_index)
1516 {
1517  const StringID performance_tips[] = {
1518  STR_PERFORMANCE_DETAIL_VEHICLES_TOOLTIP,
1519  STR_PERFORMANCE_DETAIL_STATIONS_TOOLTIP,
1520  STR_PERFORMANCE_DETAIL_MIN_PROFIT_TOOLTIP,
1521  STR_PERFORMANCE_DETAIL_MIN_INCOME_TOOLTIP,
1522  STR_PERFORMANCE_DETAIL_MAX_INCOME_TOOLTIP,
1523  STR_PERFORMANCE_DETAIL_DELIVERED_TOOLTIP,
1524  STR_PERFORMANCE_DETAIL_CARGO_TOOLTIP,
1525  STR_PERFORMANCE_DETAIL_MONEY_TOOLTIP,
1526  STR_PERFORMANCE_DETAIL_LOAN_TOOLTIP,
1527  STR_PERFORMANCE_DETAIL_TOTAL_TOOLTIP,
1528  };
1529 
1530  assert_compile(lengthof(performance_tips) == SCORE_END - SCORE_BEGIN);
1531 
1533  for (int widnum = WID_PRD_SCORE_FIRST; widnum <= WID_PRD_SCORE_LAST; widnum++) {
1534  NWidgetBackground *panel = new NWidgetBackground(WWT_PANEL, COLOUR_GREY, widnum);
1535  panel->SetFill(1, 1);
1536  panel->SetDataTip(0x0, performance_tips[widnum - WID_PRD_SCORE_FIRST]);
1537  vert->Add(panel);
1538  }
1539  *biggest_index = WID_PRD_SCORE_LAST;
1540  return vert;
1541 }
1542 
1545 {
1546  return MakeCompanyButtonRows(biggest_index, WID_PRD_COMPANY_FIRST, WID_PRD_COMPANY_LAST, 8, STR_PERFORMANCE_DETAIL_SELECT_COMPANY_TOOLTIP);
1547 }
1548 
1549 static const NWidgetPart _nested_performance_rating_detail_widgets[] = {
1551  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1552  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_PERFORMANCE_DETAIL, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1553  NWidget(WWT_SHADEBOX, COLOUR_GREY),
1554  NWidget(WWT_STICKYBOX, COLOUR_GREY),
1555  EndContainer(),
1556  NWidget(WWT_PANEL, COLOUR_GREY),
1558  EndContainer(),
1560 };
1561 
1562 static WindowDesc _performance_rating_detail_desc(
1563  WDP_AUTO, "league_details", 0, 0,
1565  0,
1566  _nested_performance_rating_detail_widgets, lengthof(_nested_performance_rating_detail_widgets)
1567 );
1568 
1569 void ShowPerformanceRatingDetail()
1570 {
1571  AllocateWindowDescFront<PerformanceRatingDetailWindow>(&_performance_rating_detail_desc, 0);
1572 }
1573 
1574 void InitializeGraphGui()
1575 {
1576  _legend_excluded_companies = 0;
1577  _legend_excluded_cargo = 0;
1578 }
Functions related to OTTD&#39;s strings.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
Base types for having sorted lists in GUIs.
List template of &#39;things&#39; T to sort in a GUI.
Definition: sortlist_type.h:47
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition of stuff that is very close to a company, like the company struct itself.
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:302
const ScoreInfo _score_info[]
Score info, values used for computing the detailed performance rating.
Definition: economy.cpp:83
static bool PerformanceSorter(const Company *const &c1, const Company *const &c2)
Sort the company league by performance history.
Definition: graph_gui.cpp:1147
static uint minu(const uint a, const uint b)
Returns the minimum of two unsigned integers.
Definition: math_func.hpp:68
Types related to the graph widgets.
Horizontally center the text.
Definition: gfx_func.h:95
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
OverflowSafeInt64 lowest
Lowest value of this interval. Must be zero or less.
Definition: graph_gui.cpp:158
Background of the window.
Definition: graph_widget.h:36
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:928
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1867
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen...
Definition: gfx.cpp:110
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:392
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3215
static NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
Definition: widget_type.h:1144
Last entry in the score list.
Definition: graph_widget.h:62
High level window description.
Definition: window_gui.h:166
void SetMinimalSize(uint min_x, uint min_y)
Set minimal size of the widget.
Definition: widget.cpp:815
int left
x position of left edge of the window
Definition: window_gui.h:317
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:602
int32 performance_history
Company score (scale 0-1000)
Definition: company_base.h:25
Functions related to dates.
static T ToggleBit(T &x, const uint8 y)
Toggles a bit in a variable.
Scrollbar data structure.
Definition: widget_type.h:587
Functions to handle different currencies.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:62
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:62
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Horizontal container.
Definition: widget_type.h:73
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
Resize button.
Definition: graph_widget.h:29
Maximal number of cargo types in a game.
Definition: cargo_type.h:64
void OnGameTick() override
Called once per (game) tick.
Definition: graph_gui.cpp:1466
NWidgetBase * MakeCompanyButtonRowsGraphGUI(int *biggest_index)
Make a number of rows with buttons for each company for the performance rating detail window...
Definition: graph_gui.cpp:1544
Specification of a cargo type.
Definition: cargotype.h:55
First company.
Definition: graph_widget.h:64
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: graph_gui.cpp:926
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
Background of the window.
Definition: graph_widget.h:56
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: graph_gui.cpp:1480
void ToggleWidgetLoweredState(byte widget_index)
Invert the lowered/raised status of a widget.
Definition: window_gui.h:463
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: graph_gui.cpp:775
Disable cargoes button.
Definition: graph_widget.h:49
Tindex index
Index of this pool item.
Definition: pool_type.hpp:189
This must always be the last entry.
Definition: economy_type.h:47
static const int DAY_TICKS
1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885.
Definition: date_type.h:28
Close box (at top-left of a window)
Definition: widget_type.h:67
void OnPaint() override
The window must be repainted.
Definition: graph_gui.cpp:1160
uint64 excluded_data
bitmask of the datasets that shouldn&#39;t be displayed.
Definition: graph_gui.cpp:174
Offset at top of a matrix cell.
Definition: window_gui.h:78
Payment rates graph; Window numbers:
Definition: window_type.h:558
Company value graph; Window numbers:
Definition: window_type.h:546
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0...
static NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition: widget_type.h:963
void OnGameTick() override
Called once per (game) tick.
Definition: graph_gui.cpp:540
uint text_width
The width of the actual text.
Definition: graph_gui.cpp:1125
uint8 graph_line_thickness
the thickness of the lines in the various graph guis
First company in the legend.
Definition: graph_widget.h:20
int32 Year
Type for the year, note: 0 based, i.e. starts at the year 0.
Definition: date_type.h:18
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: graph_gui.cpp:57
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:24
void RaiseWidget(byte widget_index)
Marks a widget as raised.
Definition: window_gui.h:483
Year _cur_year
Current year, starting at 0.
Definition: date.cpp:24
Resize button.
Definition: graph_widget.h:46
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1828
Pure simple text.
Definition: widget_type.h:56
static NWidgetBase * MakePerformanceDetailPanels(int *biggest_index)
Make a vertical list of panels for outputting score details.
Definition: graph_gui.cpp:1515
StringID name
Name of this type of cargo.
Definition: cargotype.h:70
bool NeedRebuild() const
Check if a rebuild is needed.
NWidgetBase * MakeCompanyButtonRows(int *biggest_index, int widget_first, int widget_last, int max_length, StringID button_tooltip)
Make a number of rows with button-like graphics, for enabling/disabling each company.
Definition: widget.cpp:2862
Functions, definitions and such used only by the GUI.
Graph GUI functions.
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:175
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:668
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
void ForceRebuild()
Force that a rebuild is needed.
Data structure for an opened window.
Definition: window_gui.h:276
Income graph; Window numbers:
Definition: window_type.h:522
Money expenses
The amount of expenses.
Definition: company_base.h:23
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1844
static NWidgetPart SetMatrixDataTip(uint8 cols, uint8 rows, StringID tip)
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
Definition: widget_type.h:1030
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1044
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:264
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1857
void Add(NWidgetBase *wid)
Append widget wid to container.
Definition: widget.cpp:942
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: graph_gui.cpp:1168
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: graph_gui.cpp:963
Invisible widget that takes some space.
Definition: widget_type.h:77
How many scores are there..
Definition: economy_type.h:48
byte num_valid_stat_ent
Number of valid statistical entries in old_economy.
Definition: company_base.h:98
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:173
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:63
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:1957
Graph itself.
Definition: graph_widget.h:45
void SetDataTip(uint32 widget_data, StringID tool_tip)
Set data and tool tip of the nested widget.
Definition: widget.cpp:892
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: graph_gui.cpp:903
void UpdateStatistics(bool initialize)
Update the statistics.
Definition: graph_gui.cpp:560
void OnResize() override
Called after the window got resized.
Definition: graph_gui.cpp:1004
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: graph_gui.cpp:1315
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: graph_gui.cpp:1196
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:176
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1012
Functions related to the gfx engine.
void SetFill(uint fill_x, uint fill_y)
Set the filling of the widget from initial size.
Definition: widget.cpp:837
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:78
Cargo list scrollbar.
Definition: graph_widget.h:51
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:945
Graph itself.
Definition: graph_widget.h:28
Definition of base types and functions in a cross-platform compatible way.
A number of safeguards to prevent using unsafe methods.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:245
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
Vertical container.
Definition: widget_type.h:475
Geometry functions.
Simple depressed panel.
Definition: widget_type.h:48
ValuesInterval GetValuesInterval(int num_hori_lines) const
Get the interval that contains the graph&#39;s data.
Definition: graph_gui.cpp:201
int score
How much score it will give.
Definition: economy_type.h:58
bool IsWidgetDisabled(byte widget_index) const
Gets the enabled/disabled status of a widget.
Definition: window_gui.h:421
Enable cargoes button.
Definition: graph_widget.h:48
Operating profit graph; Window numbers:
Definition: window_type.h:528
Company league window; Window numbers:
Definition: window_type.h:552
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:309
GUI Functions related to companies.
void LowerWidget(byte widget_index)
Marks a widget as lowered.
Definition: window_gui.h:474
uint icon_width
The width of the company icon.
Definition: graph_gui.cpp:1126
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: graph_gui.cpp:534
Detailed performance.
Definition: graph_widget.h:35
OverflowSafeInt64 highest
Highest value of this interval. Must be zero or greater.
Definition: graph_gui.cpp:157
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1112
void OnHundredthTick() override
Called once every 100 (game) ticks.
Definition: graph_gui.cpp:1025
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:63
Baseclass for nested widgets.
Definition: widget_type.h:124
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:498
Graph itself.
Definition: graph_widget.h:37
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
Grid of rows and columns.
Definition: widget_type.h:57
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:40
void DrawGraph(Rect r) const
Actually draw the graph.
Definition: graph_gui.cpp:284
#define FOR_ALL_SORTED_STANDARD_CARGOSPECS(var)
Loop header for iterating over &#39;real&#39; cargoes, sorted by name.
Definition: cargotype.h:171
Resize button.
Definition: graph_widget.h:38
bool Sort(SortFunction *compare)
Sort the list.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:203
The max score that can be in the performance history.
Definition: economy_type.h:50
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: graph_gui.cpp:522
uint8 FindLastBit(uint64 x)
Search the last set bit in a 64 bit variable.
int line_height
Height of the text lines.
Definition: graph_gui.cpp:1127
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: graph_gui.cpp:1246
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:700
Performance detail window; Window numbers:
Definition: window_type.h:564
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:611
Month _cur_month
Current month (0..11)
Definition: date.cpp:25
Cargo list.
Definition: graph_widget.h:50
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
Contains the interval of a graph&#39;s data.
Definition: graph_gui.cpp:156
Background of the window.
Definition: graph_widget.h:18
uint8 _sorted_standard_cargo_specs_size
Number of standard cargo specifications stored in the _sorted_cargo_specs array.
Definition: cargotype.cpp:134
An invalid company.
Definition: company_type.h:30
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: graph_gui.cpp:1373
GUISettings gui
settings related to the GUI
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:340
Scrollbar * vscroll
Cargo list scrollbar.
Definition: graph_gui.cpp:870
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
Last company.
Definition: graph_widget.h:65
Background of the window.
Definition: graph_widget.h:43
If set the frame is lowered and the background colour brighter (ie. buttons when pressed) ...
Definition: window_gui.h:29
void OnGameTick() override
Called once per (game) tick.
Definition: graph_gui.cpp:1234
uint ordinal_width
The width of the ordinal number.
Definition: graph_gui.cpp:1124
First company, same as owner.
Definition: company_type.h:22
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
byte colour
Company colour.
Definition: company_base.h:69
Functions related to the economy.
CargoArray delivered_cargo
The amount of delivered cargo.
Definition: company_base.h:24
void SetDParamMaxValue(uint n, uint64 max_value, uint min_count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition: strings.cpp:104
int UpdateCompanyRatingAndValue(Company *c, bool update)
if update is set to true, the economy is updated with this score (also the house is updated...
Definition: economy.cpp:149
Vertical container.
Definition: widget_type.h:75
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:81
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:997
CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
Definition: company_base.h:97
Maximum number of companies.
Definition: company_type.h:23
First entry in the score list.
Definition: graph_widget.h:61
uint GetYLabelWidth(ValuesInterval current_interval, int num_hori_lines) const
Get width for Y labels.
Definition: graph_gui.cpp:260
Last company in the legend.
Definition: graph_widget.h:21
Types/functions related to cargoes.
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:770
CargoID Index() const
Determines index of this cargospec.
Definition: cargotype.h:88
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:280
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:620
Index of the small font in the font tables.
Definition: gfx_type.h:203
static NWidgetBase * MakeNWidgetCompanyLines(int *biggest_index)
Construct a vertical list of buttons, one for each company.
Definition: graph_gui.cpp:110
Delivered cargo graph; Window numbers:
Definition: window_type.h:534
ScoreID
Score categories in the detailed performance rating.
Definition: economy_type.h:36
Width of a resize box widget.
Definition: window_gui.h:110
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:61
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
uint line_height
Pixel height of each cargo type row.
Definition: graph_gui.cpp:869
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:319
Background of the window.
Definition: graph_widget.h:27
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: graph_gui.cpp:550
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:981
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: graph_gui.cpp:1452
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: graph_gui.cpp:486
int needed
How much you need to get the perfect score.
Definition: economy_type.h:57
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:705
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget. ...
Definition: widget.cpp:1971
Specification of a rectangle with absolute coordinates of all edges.
Vertical scrollbar.
Definition: widget_type.h:82
Money income
The amount of income.
Definition: company_base.h:22
Text is written right-to-left by default.
Definition: strings_type.h:24
Right align the text (must be a single bit).
Definition: gfx_func.h:96
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: graph_gui.cpp:75
Window functions not directly related to making/drawing windows.
Money company_value
The value of the company.
Definition: company_base.h:26
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: graph_gui.cpp:94
Find a place automatically.
Definition: window_gui.h:154
void BuildCompanyList()
(Re)Build the company league list
Definition: graph_gui.cpp:1132
virtual void OnHundredthTick()
Called once every 100 (game) ticks.
Definition: window_gui.h:696
Legend for graphs; Window numbers:
Definition: window_type.h:510
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: graph_gui.cpp:1019
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1093
Dimensions (a width and height) of a rectangle in 2D.
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:427
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
This file contains all sprite-related enums and defines.
Nested widget with a child.
Definition: widget_type.h:543
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
Key button.
Definition: graph_widget.h:34
const T GetSum() const
Get the sum of all cargo amounts.
Definition: cargo_type.h:121
Performance history graph; Window numbers:
Definition: window_type.h:540
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3316
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:320
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:621
Key button.
Definition: graph_widget.h:26
void OnGameTick() override
Called once per (game) tick.
Definition: graph_gui.cpp:1009
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:629
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:199