OpenTTD Source  13.2.1
depot_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 "train.h"
12 #include "roadveh.h"
13 #include "ship.h"
14 #include "aircraft.h"
15 #include "gui.h"
16 #include "textbuf_gui.h"
17 #include "viewport_func.h"
18 #include "command_func.h"
19 #include "depot_base.h"
20 #include "spritecache.h"
21 #include "strings_func.h"
22 #include "vehicle_func.h"
23 #include "company_func.h"
24 #include "tilehighlight_func.h"
25 #include "window_gui.h"
26 #include "vehiclelist.h"
27 #include "vehicle_func.h"
28 #include "order_backup.h"
29 #include "zoom_func.h"
30 #include "error.h"
31 #include "depot_cmd.h"
32 #include "train_cmd.h"
33 #include "vehicle_cmd.h"
34 #include "core/geometry_func.hpp"
35 
36 #include "widgets/depot_widget.h"
37 
38 #include "table/strings.h"
39 
40 #include "safeguards.h"
41 
42 /*
43  * Since all depot window sizes aren't the same, we need to modify sizes a little.
44  * It's done with the following arrays of widget indexes. Each of them tells if a widget side should be moved and in what direction.
45  * How long they should be moved and for what window types are controlled in ShowDepotWindow()
46  */
47 
51  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
52  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_RENAME), // rename button
53  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_RENAME), SetMinimalSize(12, 14), SetDataTip(SPR_RENAME, STR_DEPOT_RENAME_TOOLTIP),
54  EndContainer(),
55  NWidget(WWT_CAPTION, COLOUR_GREY, WID_D_CAPTION), SetDataTip(STR_DEPOT_CAPTION, STR_NULL),
56  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_LOCATION), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_NULL),
57  NWidget(WWT_SHADEBOX, COLOUR_GREY),
58  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
59  NWidget(WWT_STICKYBOX, COLOUR_GREY),
60  EndContainer(),
64  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_H_SCROLL),
65  NWidget(NWID_HSCROLLBAR, COLOUR_GREY, WID_D_H_SCROLL),
66  EndContainer(),
67  EndContainer(),
69  NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL), SetDataTip(0x0, STR_NULL), SetResize(0, 1), SetFill(0, 1),
71  NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL_CHAIN), SetDataTip(SPR_SELL_CHAIN_TRAIN, STR_DEPOT_DRAG_WHOLE_TRAIN_TO_SELL_TOOLTIP), SetResize(0, 1), SetFill(0, 1),
72  EndContainer(),
73  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_SELL_ALL), SetDataTip(0x0, STR_NULL),
74  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_AUTOREPLACE), SetDataTip(0x0, STR_NULL),
75  EndContainer(),
76  NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_D_V_SCROLL),
77  EndContainer(),
79  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_BUILD), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
80  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_D_CLONE), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
81  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_VEHICLE_LIST), SetDataTip(0x0, STR_NULL), SetFill(0, 1),
82  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_STOP_ALL), SetDataTip(SPR_FLAG_VEH_STOPPED, STR_NULL), SetFill(0, 1),
83  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_START_ALL), SetDataTip(SPR_FLAG_VEH_RUNNING, STR_NULL), SetFill(0, 1),
84  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
85  EndContainer(),
86 };
87 
88 static WindowDesc _train_depot_desc(
89  WDP_AUTO, "depot_train", 362, 123,
91  0,
93 );
94 
95 static WindowDesc _road_depot_desc(
96  WDP_AUTO, "depot_roadveh", 316, 97,
98  0,
100 );
101 
102 static WindowDesc _ship_depot_desc(
103  WDP_AUTO, "depot_ship", 306, 99,
105  0,
107 );
108 
109 static WindowDesc _aircraft_depot_desc(
110  WDP_AUTO, "depot_aircraft", 332, 99,
112  0,
114 );
115 
116 extern void DepotSortList(VehicleList *list);
117 
124 void CcCloneVehicle(Commands cmd, const CommandCost &result, VehicleID veh_id)
125 {
126  if (result.Failed()) return;
127 
128  const Vehicle *v = Vehicle::Get(veh_id);
129 
131 }
132 
133 static void TrainDepotMoveVehicle(const Vehicle *wagon, VehicleID sel, const Vehicle *head)
134 {
135  const Vehicle *v = Vehicle::Get(sel);
136 
137  if (v == wagon) return;
138 
139  if (wagon == nullptr) {
140  if (head != nullptr) wagon = head->Last();
141  } else {
142  wagon = wagon->Previous();
143  if (wagon == nullptr) return;
144  }
145 
146  if (wagon == v) return;
147 
148  Command<CMD_MOVE_RAIL_VEHICLE>::Post(STR_ERROR_CAN_T_MOVE_VEHICLE, v->tile, v->index, wagon == nullptr ? INVALID_VEHICLE : wagon->index, _ctrl_pressed);
149 }
150 
154 
163 {
164  switch (image_type) {
165  case EIT_IN_DEPOT: return _base_block_sizes_depot[type];
166  case EIT_PURCHASE: return _base_block_sizes_purchase[type];
167  default: NOT_REACHED();
168  }
169 }
170 
171 static void InitBlocksizeForVehicles(VehicleType type, EngineImageType image_type)
172 {
173  int max_extend_left = 0;
174  int max_extend_right = 0;
175  uint max_height = 0;
176 
177  for (const Engine *e : Engine::IterateType(type)) {
178  if (!e->IsEnabled()) continue;
179 
180  EngineID eid = e->index;
181  uint x, y;
182  int x_offs, y_offs;
183 
184  switch (type) {
185  default: NOT_REACHED();
186  case VEH_TRAIN: GetTrainSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
187  case VEH_ROAD: GetRoadVehSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
188  case VEH_SHIP: GetShipSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
189  case VEH_AIRCRAFT: GetAircraftSpriteSize(eid, x, y, x_offs, y_offs, image_type); break;
190  }
191  if (y > max_height) max_height = y;
192  if (-x_offs > max_extend_left) max_extend_left = -x_offs;
193  if ((int)x + x_offs > max_extend_right) max_extend_right = x + x_offs;
194  }
195 
196  int min_extend = ScaleSpriteTrad(16);
197  int max_extend = ScaleSpriteTrad(98);
198 
199  switch (image_type) {
200  case EIT_IN_DEPOT:
201  _base_block_sizes_depot[type].height = std::max<uint>(ScaleSpriteTrad(GetVehicleHeight(type)), max_height);
202  _base_block_sizes_depot[type].extend_left = Clamp(max_extend_left, min_extend, max_extend);
203  _base_block_sizes_depot[type].extend_right = Clamp(max_extend_right, min_extend, max_extend);
204  break;
205  case EIT_PURCHASE:
206  _base_block_sizes_purchase[type].height = std::max<uint>(ScaleSpriteTrad(GetVehicleHeight(type)), max_height);
207  _base_block_sizes_purchase[type].extend_left = Clamp(max_extend_left, min_extend, max_extend);
208  _base_block_sizes_purchase[type].extend_right = Clamp(max_extend_right, min_extend, max_extend);
209  break;
210 
211  default: NOT_REACHED();
212  }
213 }
214 
220 {
221  for (VehicleType vt = VEH_BEGIN; vt < VEH_COMPANY_END; vt++) {
222  InitBlocksizeForVehicles(vt, EIT_IN_DEPOT);
223  InitBlocksizeForVehicles(vt, EIT_PURCHASE);
224  }
225 
226  _consistent_train_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
227  bool first = true;
228  for (const Engine *e : Engine::IterateType(VEH_TRAIN)) {
229  if (!e->IsEnabled()) continue;
230 
231  uint w = TRAININFO_DEFAULT_VEHICLE_WIDTH;
232  if (e->GetGRF() != nullptr && is_custom_sprite(e->u.rail.image_index)) {
233  w = e->GetGRF()->traininfo_vehicle_width;
234  if (w != VEHICLEINFO_FULL_VEHICLE_WIDTH) {
235  /* Hopeless.
236  * This is a NewGRF vehicle that uses TRAININFO_DEFAULT_VEHICLE_WIDTH.
237  * If the vehicles are shorter than 8/8 we have fractional lengths, which are not consistent after rounding.
238  */
240  break;
241  }
242  }
243 
244  if (first) {
246  first = false;
247  } else if (w != _consistent_train_width) {
249  break;
250  }
251  }
252 }
253 
254 static void DepotSellAllConfirmationCallback(Window *w, bool confirmed);
255 const Sprite *GetAircraftSprite(EngineID engine);
256 
257 struct DepotWindow : Window {
258  VehicleID sel;
260  VehicleType type;
261  bool generate_list;
263  VehicleList vehicle_list;
264  VehicleList wagon_list;
265  uint unitnumber_digits;
266  uint num_columns;
268  Scrollbar *vscroll;
269 
270  DepotWindow(WindowDesc *desc, TileIndex tile, VehicleType type) : Window(desc)
271  {
272  assert(IsCompanyBuildableVehicleType(type)); // ensure that we make the call with a valid type
273 
274  this->sel = INVALID_VEHICLE;
275  this->vehicle_over = INVALID_VEHICLE;
276  this->generate_list = true;
277  this->hovered_widget = -1;
278  this->type = type;
279  this->num_columns = 1; // for non-trains this gets set in FinishInitNested()
280  this->unitnumber_digits = 2;
281 
282  this->CreateNestedTree();
283  this->hscroll = (this->type == VEH_TRAIN ? this->GetScrollbar(WID_D_H_SCROLL) : nullptr);
284  this->vscroll = this->GetScrollbar(WID_D_V_SCROLL);
285  /* Don't show 'rename button' of aircraft hangar */
286  this->GetWidget<NWidgetStacked>(WID_D_SHOW_RENAME)->SetDisplayedPlane(type == VEH_AIRCRAFT ? SZSP_NONE : 0);
287  /* Only train depots have a horizontal scrollbar and a 'sell chain' button */
288  if (type == VEH_TRAIN) this->GetWidget<NWidgetCore>(WID_D_MATRIX)->widget_data = 1 << MAT_COL_START;
289  this->GetWidget<NWidgetStacked>(WID_D_SHOW_H_SCROLL)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_HORIZONTAL);
290  this->GetWidget<NWidgetStacked>(WID_D_SHOW_SELL_CHAIN)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_NONE);
291  this->SetupWidgetData(type);
292  this->FinishInitNested(tile);
293 
294  this->owner = GetTileOwner(tile);
296  }
297 
298  void Close() override
299  {
301  CloseWindowById(GetWindowClassForVehicleType(this->type), VehicleListIdentifier(VL_DEPOT_LIST, this->type, this->owner, this->GetDepotIndex()).Pack(), false);
303  this->Window::Close();
304  }
305 
311  void DrawVehicleInDepot(const Vehicle *v, const Rect &r) const
312  {
313  bool free_wagon = false;
314 
315  bool rtl = _current_text_dir == TD_RTL;
316  Rect text = r.Shrink(RectPadding::zero, WidgetDimensions::scaled.matrix); /* Ract for text elements, horizontal is already applied. */
317  Rect image = r.Indent(this->header_width, rtl).Indent(this->count_width, !rtl); /* Rect for vehicle images */
318 
319  switch (v->type) {
320  case VEH_TRAIN: {
321  const Train *u = Train::From(v);
322  free_wagon = u->IsFreeWagon();
323 
324  uint x_space = free_wagon ?
325  ScaleSpriteTrad(_consistent_train_width != 0 ? _consistent_train_width : TRAININFO_DEFAULT_VEHICLE_WIDTH) :
326  0;
327 
328  DrawTrainImage(u, image.Indent(x_space, rtl), this->sel, EIT_IN_DEPOT, free_wagon ? 0 : this->hscroll->GetPosition(), this->vehicle_over);
329 
330  /* Length of consist in tiles with 1 fractional digit (rounded up) */
332  SetDParam(1, 1);
333  Rect count = text.WithWidth(this->count_width - WidgetDimensions::scaled.hsep_normal, !rtl);
334  DrawString(count.left, count.right, count.bottom - FONT_HEIGHT_SMALL + 1, STR_TINY_BLACK_DECIMAL, TC_FROMSTRING, SA_RIGHT); // Draw the counter
335  break;
336  }
337 
338  case VEH_ROAD: DrawRoadVehImage( v, image, this->sel, EIT_IN_DEPOT); break;
339  case VEH_SHIP: DrawShipImage( v, image, this->sel, EIT_IN_DEPOT); break;
340  case VEH_AIRCRAFT: DrawAircraftImage(v, image, this->sel, EIT_IN_DEPOT); break;
341  default: NOT_REACHED();
342  }
343 
344  uint diff_x, diff_y;
345  if (v->IsGroundVehicle()) {
346  /* Arrange unitnumber and flag horizontally */
347  diff_x = this->flag_size.width + WidgetDimensions::scaled.hsep_normal;
348  diff_y = WidgetDimensions::scaled.matrix.top;
349  } else {
350  /* Arrange unitnumber and flag vertically */
351  diff_x = 0;
353  }
354 
355  text = text.WithWidth(this->header_width - WidgetDimensions::scaled.hsep_normal, rtl).WithHeight(FONT_HEIGHT_NORMAL).Indent(diff_x, rtl);
356  if (free_wagon) {
357  DrawString(text, STR_DEPOT_NO_ENGINE);
358  } else {
359  Rect flag = r.WithWidth(this->flag_size.width, rtl).WithHeight(this->flag_size.height).Translate(0, diff_y);
360  DrawSpriteIgnorePadding((v->vehstatus & VS_STOPPED) ? SPR_FLAG_VEH_STOPPED : SPR_FLAG_VEH_RUNNING, PAL_NONE, flag, false, SA_CENTER);
361 
362  SetDParam(0, v->unitnumber);
363  DrawString(text, (uint16)(v->max_age - DAYS_IN_LEAP_YEAR) >= v->age ? STR_BLACK_COMMA : STR_RED_COMMA);
364  }
365  }
366 
367  void DrawWidget(const Rect &r, int widget) const override
368  {
369  if (widget != WID_D_MATRIX) return;
370 
371  bool rtl = _current_text_dir == TD_RTL;
372 
373  /* Set the row and number of boxes in each row based on the number of boxes drawn in the matrix */
374  const NWidgetCore *wid = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
375 
376  /* Set up rect for each cell */
377  Rect ir = r.WithHeight(this->resize.step_height);
378  if (this->num_columns != 1) ir = ir.WithWidth(this->resize.step_width, rtl);
379  ir = ir.Shrink(WidgetDimensions::scaled.framerect, RectPadding::zero);
380 
381  /* Draw vertical separators at whole tiles.
382  * This only works in two cases:
383  * - All vehicles use VEHICLEINFO_FULL_VEHICLE_WIDTH as reference width.
384  * - All vehicles are 8/8. This cannot be checked for NewGRF, so instead we check for "all vehicles are original vehicles".
385  */
386  if (this->type == VEH_TRAIN && _consistent_train_width != 0) {
388  int col = _colour_gradient[wid->colour][4];
389  Rect image = ir.Indent(this->header_width, rtl).Indent(this->count_width, !rtl);
390  int first_line = w + (-this->hscroll->GetPosition()) % w;
391  if (rtl) {
392  for (int x = image.right - first_line; x >= image.left; x -= w) {
393  GfxDrawLine(x, r.top, x, r.bottom, col, ScaleGUITrad(1), ScaleGUITrad(3));
394  }
395  } else {
396  for (int x = image.left + first_line; x <= image.right; x += w) {
397  GfxDrawLine(x, r.top, x, r.bottom, col, ScaleGUITrad(1), ScaleGUITrad(3));
398  }
399  }
400  }
401 
402  uint16 rows_in_display = wid->current_y / wid->resize_y;
403 
404  uint num = this->vscroll->GetPosition() * this->num_columns;
405  uint maxval = static_cast<uint>(std::min<size_t>(this->vehicle_list.size(), num + (rows_in_display * this->num_columns)));
406  for (; num < maxval; ir = ir.Translate(0, this->resize.step_height)) { // Draw the rows
407  Rect cell = ir; /* Keep track of horizontal cells */
408  for (uint i = 0; i < this->num_columns && num < maxval; i++, num++) {
409  /* Draw all vehicles in the current row */
410  const Vehicle *v = this->vehicle_list[num];
411  this->DrawVehicleInDepot(v, cell);
412  cell = cell.Translate(rtl ? -(int)this->resize.step_width : (int)this->resize.step_width, 0);
413  }
414  }
415 
416  maxval = static_cast<uint>(std::min<size_t>(this->vehicle_list.size() + this->wagon_list.size(), (this->vscroll->GetPosition() * this->num_columns) + (rows_in_display * this->num_columns)));
417 
418  /* Draw the train wagons without an engine in front. */
419  for (; num < maxval; num++, ir = ir.Translate(0, this->resize.step_height)) {
420  const Vehicle *v = this->wagon_list[num - this->vehicle_list.size()];
421  this->DrawVehicleInDepot(v, ir);
422  }
423  }
424 
425  void SetStringParameters(int widget) const override
426  {
427  if (widget != WID_D_CAPTION) return;
428 
429  SetDParam(0, this->type);
430  SetDParam(1, this->GetDepotIndex());
431  }
432 
434  const Vehicle *head;
435  const Vehicle *wagon;
436  };
437 
438  enum DepotGUIAction {
439  MODE_ERROR,
440  MODE_DRAG_VEHICLE,
441  MODE_SHOW_VEHICLE,
442  MODE_START_STOP,
443  };
444 
445  DepotGUIAction GetVehicleFromDepotWndPt(int x, int y, const Vehicle **veh, GetDepotVehiclePtData *d) const
446  {
447  const NWidgetCore *matrix_widget = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
448  /* In case of RTL the widgets are swapped as a whole */
449  if (_current_text_dir == TD_RTL) x = matrix_widget->current_x - x;
450 
451  uint xt = 0, xm = 0, ym = 0;
452  if (this->type == VEH_TRAIN) {
453  xm = x;
454  } else {
455  xt = x / this->resize.step_width;
456  xm = x % this->resize.step_width;
457  if (xt >= this->num_columns) return MODE_ERROR;
458  }
459  ym = y % this->resize.step_height;
460 
461  uint row = y / this->resize.step_height;
462  if (row >= this->vscroll->GetCapacity()) return MODE_ERROR;
463 
464  uint pos = ((row + this->vscroll->GetPosition()) * this->num_columns) + xt;
465 
466  if (this->vehicle_list.size() + this->wagon_list.size() <= pos) {
467  /* Clicking on 'line' / 'block' without a vehicle */
468  if (this->type == VEH_TRAIN) {
469  /* End the dragging */
470  d->head = nullptr;
471  d->wagon = nullptr;
472  return MODE_DRAG_VEHICLE;
473  } else {
474  return MODE_ERROR; // empty block, so no vehicle is selected
475  }
476  }
477 
478  bool wagon = false;
479  if (this->vehicle_list.size() > pos) {
480  *veh = this->vehicle_list[pos];
481  /* Skip vehicles that are scrolled off the list */
482  if (this->type == VEH_TRAIN) x += this->hscroll->GetPosition();
483  } else {
484  pos -= (uint)this->vehicle_list.size();
485  *veh = this->wagon_list[pos];
486  /* free wagons don't have an initial loco. */
487  x -= ScaleSpriteTrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
488  wagon = true;
489  }
490 
491  const Train *v = nullptr;
492  if (this->type == VEH_TRAIN) {
493  v = Train::From(*veh);
494  d->head = d->wagon = v;
495  }
496 
497  if (xm <= this->header_width) {
498  switch (this->type) {
499  case VEH_TRAIN:
500  if (wagon) return MODE_ERROR;
501  FALLTHROUGH;
502 
503  case VEH_ROAD:
504  if (xm <= this->flag_size.width) return MODE_START_STOP;
505  break;
506 
507  case VEH_SHIP:
508  case VEH_AIRCRAFT:
509  if (xm <= this->flag_size.width && ym >= (uint)(FONT_HEIGHT_NORMAL + WidgetDimensions::scaled.vsep_normal)) return MODE_START_STOP;
510  break;
511 
512  default: NOT_REACHED();
513  }
514  return MODE_SHOW_VEHICLE;
515  }
516 
517  if (this->type != VEH_TRAIN) return MODE_DRAG_VEHICLE;
518 
519  /* Clicking on the counter */
520  if (xm >= matrix_widget->current_x - this->count_width) return wagon ? MODE_ERROR : MODE_SHOW_VEHICLE;
521 
522  /* Account for the header */
523  x -= this->header_width;
524 
525  /* find the vehicle in this row that was clicked */
526  for (; v != nullptr; v = v->Next()) {
527  x -= v->GetDisplayImageWidth();
528  if (x < 0) break;
529  }
530 
531  d->wagon = (v != nullptr ? v->GetFirstEnginePart() : nullptr);
532 
533  return MODE_DRAG_VEHICLE;
534  }
535 
541  void DepotClick(int x, int y)
542  {
543  GetDepotVehiclePtData gdvp = { nullptr, nullptr };
544  const Vehicle *v = nullptr;
545  DepotGUIAction mode = this->GetVehicleFromDepotWndPt(x, y, &v, &gdvp);
546 
547  if (this->type == VEH_TRAIN) v = gdvp.wagon;
548 
549  switch (mode) {
550  case MODE_ERROR: // invalid
551  return;
552 
553  case MODE_DRAG_VEHICLE: { // start dragging of vehicle
554  if (v != nullptr && VehicleClicked(v)) return;
555 
556  VehicleID sel = this->sel;
557 
558  if (this->type == VEH_TRAIN && sel != INVALID_VEHICLE) {
559  this->sel = INVALID_VEHICLE;
560  TrainDepotMoveVehicle(v, sel, gdvp.head);
561  } else if (v != nullptr) {
562  SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
564  _cursor.vehchain = _ctrl_pressed;
565 
566  this->sel = v->index;
567  this->SetDirty();
568  }
569  break;
570  }
571 
572  case MODE_SHOW_VEHICLE: // show info window
574  break;
575 
576  case MODE_START_STOP: // click start/stop flag
577  StartStopVehicle(v, false);
578  break;
579 
580  default: NOT_REACHED();
581  }
582  }
583 
591  {
592  this->GetWidget<NWidgetCore>(WID_D_STOP_ALL)->tool_tip = STR_DEPOT_MASS_STOP_DEPOT_TRAIN_TOOLTIP + type;
593  this->GetWidget<NWidgetCore>(WID_D_START_ALL)->tool_tip = STR_DEPOT_MASS_START_DEPOT_TRAIN_TOOLTIP + type;
594  this->GetWidget<NWidgetCore>(WID_D_SELL)->tool_tip = STR_DEPOT_TRAIN_SELL_TOOLTIP + type;
595  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->tool_tip = STR_DEPOT_SELL_ALL_BUTTON_TRAIN_TOOLTIP + type;
596 
597  this->GetWidget<NWidgetCore>(WID_D_BUILD)->SetDataTip(STR_DEPOT_TRAIN_NEW_VEHICLES_BUTTON + type, STR_DEPOT_TRAIN_NEW_VEHICLES_TOOLTIP + type);
598  this->GetWidget<NWidgetCore>(WID_D_CLONE)->SetDataTip(STR_DEPOT_CLONE_TRAIN + type, STR_DEPOT_CLONE_TRAIN_DEPOT_INFO + type);
599 
600  this->GetWidget<NWidgetCore>(WID_D_LOCATION)->tool_tip = STR_DEPOT_TRAIN_LOCATION_TOOLTIP + type;
601  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->tool_tip = STR_DEPOT_VEHICLE_ORDER_LIST_TRAIN_TOOLTIP + type;
602  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->tool_tip = STR_DEPOT_AUTOREPLACE_TRAIN_TOOLTIP + type;
603  this->GetWidget<NWidgetCore>(WID_D_MATRIX)->tool_tip = STR_DEPOT_TRAIN_LIST_TOOLTIP + this->type;
604 
605  switch (type) {
606  default: NOT_REACHED();
607 
608  case VEH_TRAIN:
609  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_TRAIN;
610 
611  /* Sprites */
612  this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_TRAIN;
613  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_TRAIN;
614  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_TRAIN;
615  break;
616 
617  case VEH_ROAD:
618  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_LORRY;
619 
620  /* Sprites */
621  this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_ROADVEH;
622  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_ROADVEH;
623  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_ROADVEH;
624  break;
625 
626  case VEH_SHIP:
627  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_SHIP;
628 
629  /* Sprites */
630  this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_SHIP;
631  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_SHIP;
632  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_SHIP;
633  break;
634 
635  case VEH_AIRCRAFT:
636  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_PLANE;
637 
638  /* Sprites */
639  this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_AIRCRAFT;
640  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_AIRCRAFT;
641  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_AIRCRAFT;
642  break;
643  }
644  }
645 
646  uint count_width;
650 
651  void OnInit() override
652  {
653  this->cell_size = GetVehicleImageCellSize(this->type, EIT_IN_DEPOT);
654  this->flag_size = maxdim(GetScaledSpriteSize(SPR_FLAG_VEH_STOPPED), GetScaledSpriteSize(SPR_FLAG_VEH_RUNNING));
655  }
656 
657  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
658  {
659  switch (widget) {
660  case WID_D_MATRIX: {
661  uint min_height = 0;
662 
663  if (this->type == VEH_TRAIN) {
664  SetDParamMaxValue(0, 1000, 0, FS_SMALL);
665  SetDParam(1, 1);
666  this->count_width = GetStringBoundingBox(STR_TINY_BLACK_DECIMAL).width + WidgetDimensions::scaled.hsep_normal;
667  } else {
668  this->count_width = 0;
669  }
670 
671  SetDParamMaxDigits(0, this->unitnumber_digits);
672  Dimension unumber = GetStringBoundingBox(STR_BLACK_COMMA);
673 
674  if (this->type == VEH_TRAIN || this->type == VEH_ROAD) {
675  min_height = std::max<uint>(unumber.height, this->flag_size.height);
676  this->header_width = unumber.width + WidgetDimensions::scaled.hsep_normal + this->flag_size.width + WidgetDimensions::scaled.hsep_normal;
677  } else {
678  min_height = unumber.height + WidgetDimensions::scaled.vsep_normal + this->flag_size.height;
679  this->header_width = std::max<uint>(unumber.width, this->flag_size.width) + WidgetDimensions::scaled.hsep_normal;
680  }
681  int base_width = this->count_width + this->header_width + padding.width;
682 
683  resize->height = std::max<uint>(this->cell_size.height, min_height + padding.height);
684  if (this->type == VEH_TRAIN) {
685  resize->width = 1;
686  size->width = base_width + 2 * ScaleSpriteTrad(29); // about 2 parts
687  size->height = resize->height * 6;
688  } else {
689  resize->width = base_width + this->cell_size.extend_left + this->cell_size.extend_right;
690  size->width = resize->width * (this->type == VEH_ROAD ? 5 : 3);
691  size->height = resize->height * (this->type == VEH_ROAD ? 5 : 3);
692  }
693  fill->width = resize->width;
694  fill->height = resize->height;
695  break;
696  }
697  }
698  }
699 
705  void OnInvalidateData(int data = 0, bool gui_scope = true) override
706  {
707  this->generate_list = true;
708  }
709 
710  void OnPaint() override
711  {
712  if (this->generate_list) {
713  /* Generate the vehicle list
714  * It's ok to use the wagon pointers for non-trains as they will be ignored */
715  BuildDepotVehicleList(this->type, this->window_number, &this->vehicle_list, &this->wagon_list);
716  this->generate_list = false;
717  DepotSortList(&this->vehicle_list);
718 
719  uint new_unitnumber_digits = GetUnitNumberDigits(this->vehicle_list);
720  /* Only increase the size; do not decrease to prevent constant changes */
721  if (this->unitnumber_digits < new_unitnumber_digits) {
722  this->unitnumber_digits = new_unitnumber_digits;
723  this->ReInit();
724  }
725  }
726 
727  /* determine amount of items for scroller */
728  if (this->type == VEH_TRAIN) {
729  uint max_width = ScaleSpriteTrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
730  for (uint num = 0; num < this->vehicle_list.size(); num++) {
731  uint width = 0;
732  for (const Train *v = Train::From(this->vehicle_list[num]); v != nullptr; v = v->Next()) {
733  width += v->GetDisplayImageWidth();
734  }
735  max_width = std::max(max_width, width);
736  }
737  /* Always have 1 empty row, so people can change the setting of the train */
738  this->vscroll->SetCount((uint)this->vehicle_list.size() + (uint)this->wagon_list.size() + 1);
739  /* Always make it longer than the longest train, so you can attach vehicles at the end, and also see the next vertical tile separator line */
740  this->hscroll->SetCount(max_width + ScaleSpriteTrad(2 * VEHICLEINFO_FULL_VEHICLE_WIDTH + 1));
741  } else {
742  this->vscroll->SetCount(CeilDiv((uint)this->vehicle_list.size(), this->num_columns));
743  }
744 
745  /* Setup disabled buttons. */
746  TileIndex tile = this->window_number;
750  WID_D_SELL,
753  WID_D_BUILD,
754  WID_D_CLONE,
755  WID_D_RENAME,
758 
759  this->DrawWidgets();
760  }
761 
762  void OnClick(Point pt, int widget, int click_count) override
763  {
764  switch (widget) {
765  case WID_D_MATRIX: { // List
766  NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
767  this->DepotClick(pt.x - nwi->pos_x, pt.y - nwi->pos_y);
768  break;
769  }
770 
771  case WID_D_BUILD: // Build vehicle
773  ShowBuildVehicleWindow(this->window_number, this->type);
774  break;
775 
776  case WID_D_CLONE: // Clone button
779 
780  if (this->IsWidgetLowered(WID_D_CLONE)) {
781  static const CursorID clone_icons[] = {
782  SPR_CURSOR_CLONE_TRAIN, SPR_CURSOR_CLONE_ROADVEH,
783  SPR_CURSOR_CLONE_SHIP, SPR_CURSOR_CLONE_AIRPLANE
784  };
785 
786  SetObjectToPlaceWnd(clone_icons[this->type], PAL_NONE, HT_VEHICLE, this);
787  } else {
789  }
790  break;
791 
792  case WID_D_LOCATION:
793  if (_ctrl_pressed) {
795  } else {
797  }
798  break;
799 
800  case WID_D_RENAME: // Rename button
801  SetDParam(0, this->type);
802  SetDParam(1, Depot::GetByTile((TileIndex)this->window_number)->index);
803  ShowQueryString(STR_DEPOT_NAME, STR_DEPOT_RENAME_DEPOT_CAPTION, MAX_LENGTH_DEPOT_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
804  break;
805 
806  case WID_D_STOP_ALL:
807  case WID_D_START_ALL: {
808  VehicleListIdentifier vli(VL_DEPOT_LIST, this->type, this->owner);
809  Command<CMD_MASS_START_STOP>::Post(this->window_number, widget == WID_D_START_ALL, false, vli);
810  break;
811  }
812 
813  case WID_D_SELL_ALL:
814  /* Only open the confirmation window if there are anything to sell */
815  if (this->vehicle_list.size() != 0 || this->wagon_list.size() != 0) {
816  SetDParam(0, this->type);
817  SetDParam(1, this->GetDepotIndex());
818  ShowQuery(
819  STR_DEPOT_CAPTION,
820  STR_DEPOT_SELL_CONFIRMATION_TEXT,
821  this,
822  DepotSellAllConfirmationCallback
823  );
824  }
825  break;
826 
827  case WID_D_VEHICLE_LIST:
828  ShowVehicleListWindow(GetTileOwner(this->window_number), this->type, (TileIndex)this->window_number);
829  break;
830 
831  case WID_D_AUTOREPLACE:
832  Command<CMD_DEPOT_MASS_AUTOREPLACE>::Post(this->window_number, this->type);
833  break;
834 
835  }
836  }
837 
838  void OnQueryTextFinished(char *str) override
839  {
840  if (str == nullptr) return;
841 
842  /* Do depot renaming */
843  Command<CMD_RENAME_DEPOT>::Post(STR_ERROR_CAN_T_RENAME_DEPOT, this->GetDepotIndex(), str);
844  }
845 
846  bool OnRightClick(Point pt, int widget) override
847  {
848  if (widget != WID_D_MATRIX) return false;
849 
850  GetDepotVehiclePtData gdvp = { nullptr, nullptr };
851  const Vehicle *v = nullptr;
852  NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
853  DepotGUIAction mode = this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp);
854 
855  if (this->type == VEH_TRAIN) v = gdvp.wagon;
856 
857  if (v == nullptr || mode != MODE_DRAG_VEHICLE) return false;
858 
859  CargoArray capacity, loaded;
860 
861  /* Display info for single (articulated) vehicle, or for whole chain starting with selected vehicle */
862  bool whole_chain = (this->type == VEH_TRAIN && _ctrl_pressed);
863 
864  /* loop through vehicle chain and collect cargoes */
865  uint num = 0;
866  for (const Vehicle *w = v; w != nullptr; w = w->Next()) {
867  if (w->cargo_cap > 0 && w->cargo_type < NUM_CARGO) {
868  capacity[w->cargo_type] += w->cargo_cap;
869  loaded [w->cargo_type] += w->cargo.StoredCount();
870  }
871 
872  if (w->type == VEH_TRAIN && !w->HasArticulatedPart()) {
873  num++;
874  if (!whole_chain) break;
875  }
876  }
877 
878  /* Build tooltipstring */
879  static char details[1024];
880  details[0] = '\0';
881  char *pos = details;
882 
883  for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
884  if (capacity[cargo_type] == 0) continue;
885 
886  SetDParam(0, cargo_type); // {CARGO} #1
887  SetDParam(1, loaded[cargo_type]); // {CARGO} #2
888  SetDParam(2, cargo_type); // {SHORTCARGO} #1
889  SetDParam(3, capacity[cargo_type]); // {SHORTCARGO} #2
890  pos = GetString(pos, STR_DEPOT_VEHICLE_TOOLTIP_CARGO, lastof(details));
891  }
892 
893  /* Show tooltip window */
894  uint64 args[2];
895  args[0] = (whole_chain ? num : v->engine_type);
896  args[1] = (uint64)(size_t)details;
897  GuiShowTooltips(this, whole_chain ? STR_DEPOT_VEHICLE_TOOLTIP_CHAIN : STR_DEPOT_VEHICLE_TOOLTIP, 2, args, TCC_RIGHT_CLICK);
898 
899  return true;
900  }
901 
907  bool OnVehicleSelect(const Vehicle *v) override
908  {
909  if (_ctrl_pressed) {
910  /* Share-clone, do not open new viewport, and keep tool active */
911  Command<CMD_CLONE_VEHICLE>::Post(STR_ERROR_CAN_T_BUY_TRAIN + v->type, this->window_number, v->index, true);
912  } else {
913  /* Copy-clone, open viewport for new vehicle, and deselect the tool (assume player wants to change things on new vehicle) */
914  if (Command<CMD_CLONE_VEHICLE>::Post(STR_ERROR_CAN_T_BUY_TRAIN + v->type, CcCloneVehicle, this->window_number, v->index, false)) {
916  }
917  }
918 
919  return true;
920  }
921 
928  bool OnVehicleSelect(VehicleList::const_iterator begin, VehicleList::const_iterator end) override
929  {
930  if (!_ctrl_pressed) {
931  /* If CTRL is not pressed: If all the vehicles in this list have the same orders, then copy orders */
932  if (AllEqual(begin, end, [](const Vehicle *v1, const Vehicle *v2) {
933  return VehiclesHaveSameEngineList(v1, v2);
934  })) {
935  if (AllEqual(begin, end, [](const Vehicle *v1, const Vehicle *v2) {
936  return VehiclesHaveSameOrderList(v1, v2);
937  })) {
938  OnVehicleSelect(*begin);
939  } else {
940  ShowErrorMessage(STR_ERROR_CAN_T_BUY_TRAIN + (*begin)->type, STR_ERROR_CAN_T_COPY_ORDER_VEHICLE_LIST, WL_INFO);
941  }
942  } else {
943  ShowErrorMessage(STR_ERROR_CAN_T_BUY_TRAIN + (*begin)->type, STR_ERROR_CAN_T_CLONE_VEHICLE_LIST, WL_INFO);
944  }
945  } else {
946  /* If CTRL is pressed: If all the vehicles in this list share orders, then copy orders */
947  if (AllEqual(begin, end, [](const Vehicle *v1, const Vehicle *v2) {
948  return VehiclesHaveSameEngineList(v1, v2);
949  })) {
950  if (AllEqual(begin, end, [](const Vehicle *v1, const Vehicle *v2) {
951  return v1->FirstShared() == v2->FirstShared();
952  })) {
953  OnVehicleSelect(*begin);
954  } else {
955  ShowErrorMessage(STR_ERROR_CAN_T_BUY_TRAIN + (*begin)->type, STR_ERROR_CAN_T_SHARE_ORDER_VEHICLE_LIST, WL_INFO);
956  }
957  } else {
958  ShowErrorMessage(STR_ERROR_CAN_T_BUY_TRAIN + (*begin)->type, STR_ERROR_CAN_T_CLONE_VEHICLE_LIST, WL_INFO);
959  }
960  }
961 
962  return true;
963  }
964 
965  void OnPlaceObjectAbort() override
966  {
967  /* abort clone */
968  this->RaiseWidget(WID_D_CLONE);
970 
971  /* abort drag & drop */
972  this->sel = INVALID_VEHICLE;
973  this->vehicle_over = INVALID_VEHICLE;
975 
976  if (this->hovered_widget != -1) {
977  this->SetWidgetLoweredState(this->hovered_widget, false);
978  this->SetWidgetDirty(this->hovered_widget);
979  this->hovered_widget = -1;
980  }
981  }
982 
983  void OnMouseDrag(Point pt, int widget) override
984  {
985  if (this->sel == INVALID_VEHICLE) return;
986  if (widget != this->hovered_widget) {
987  if (this->hovered_widget == WID_D_SELL || this->hovered_widget == WID_D_SELL_CHAIN) {
988  this->SetWidgetLoweredState(this->hovered_widget, false);
989  this->SetWidgetDirty(this->hovered_widget);
990  }
991  this->hovered_widget = widget;
992  if (this->hovered_widget == WID_D_SELL || this->hovered_widget == WID_D_SELL_CHAIN) {
993  this->SetWidgetLoweredState(this->hovered_widget, true);
994  this->SetWidgetDirty(this->hovered_widget);
995  }
996  }
997  if (this->type != VEH_TRAIN) return;
998 
999  /* A rail vehicle is dragged.. */
1000  if (widget != WID_D_MATRIX) { // ..outside of the depot matrix.
1001  if (this->vehicle_over != INVALID_VEHICLE) {
1002  this->vehicle_over = INVALID_VEHICLE;
1004  }
1005  return;
1006  }
1007 
1008  NWidgetBase *matrix = this->GetWidget<NWidgetBase>(widget);
1009  const Vehicle *v = nullptr;
1010  GetDepotVehiclePtData gdvp = {nullptr, nullptr};
1011 
1012  if (this->GetVehicleFromDepotWndPt(pt.x - matrix->pos_x, pt.y - matrix->pos_y, &v, &gdvp) != MODE_DRAG_VEHICLE) return;
1013 
1014  VehicleID new_vehicle_over = INVALID_VEHICLE;
1015  if (gdvp.head != nullptr) {
1016  if (gdvp.wagon == nullptr && gdvp.head->Last()->index != this->sel) { // ..at the end of the train.
1017  /* NOTE: As a wagon can't be moved at the begin of a train, head index isn't used to mark a drag-and-drop
1018  * destination inside a train. This head index is then used to indicate that a wagon is inserted at
1019  * the end of the train.
1020  */
1021  new_vehicle_over = gdvp.head->index;
1022  } else if (gdvp.wagon != nullptr && gdvp.head != gdvp.wagon &&
1023  gdvp.wagon->index != this->sel &&
1024  gdvp.wagon->Previous()->index != this->sel) { // ..over an existing wagon.
1025  new_vehicle_over = gdvp.wagon->index;
1026  }
1027  }
1028 
1029  if (this->vehicle_over == new_vehicle_over) return;
1030 
1031  this->vehicle_over = new_vehicle_over;
1032  this->SetWidgetDirty(widget);
1033  }
1034 
1035  void OnDragDrop(Point pt, int widget) override
1036  {
1037  switch (widget) {
1038  case WID_D_MATRIX: {
1039  const Vehicle *v = nullptr;
1040  VehicleID sel = this->sel;
1041 
1042  this->sel = INVALID_VEHICLE;
1043  this->SetDirty();
1044 
1045  NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
1046  if (this->type == VEH_TRAIN) {
1047  GetDepotVehiclePtData gdvp = { nullptr, nullptr };
1048 
1049  if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp) == MODE_DRAG_VEHICLE && sel != INVALID_VEHICLE) {
1050  if (gdvp.wagon != nullptr && gdvp.wagon->index == sel && _ctrl_pressed) {
1051  Command<CMD_REVERSE_TRAIN_DIRECTION>::Post(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE, Vehicle::Get(sel)->tile, Vehicle::Get(sel)->index, true);
1052  } else if (gdvp.wagon == nullptr || gdvp.wagon->index != sel) {
1053  this->vehicle_over = INVALID_VEHICLE;
1054  TrainDepotMoveVehicle(gdvp.wagon, sel, gdvp.head);
1055  } else if (gdvp.head != nullptr && gdvp.head->IsFrontEngine()) {
1056  ShowVehicleViewWindow(gdvp.head);
1057  }
1058  }
1059  } else if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, nullptr) == MODE_DRAG_VEHICLE && v != nullptr && sel == v->index) {
1061  }
1062  break;
1063  }
1064 
1065  case WID_D_SELL: case WID_D_SELL_CHAIN: {
1066  if (this->IsWidgetDisabled(widget)) return;
1067  if (this->sel == INVALID_VEHICLE) return;
1068 
1069  this->HandleButtonClick(widget);
1070 
1071  const Vehicle *v = Vehicle::Get(this->sel);
1072  this->sel = INVALID_VEHICLE;
1073  this->SetDirty();
1074 
1075  bool sell_cmd = (v->type == VEH_TRAIN && (widget == WID_D_SELL_CHAIN || _ctrl_pressed));
1076  Command<CMD_SELL_VEHICLE>::Post(GetCmdSellVehMsg(v->type), v->tile, v->index, sell_cmd, true, INVALID_CLIENT_ID);
1077  break;
1078  }
1079 
1080  default:
1081  this->sel = INVALID_VEHICLE;
1082  this->SetDirty();
1083  break;
1084  }
1085  this->hovered_widget = -1;
1086  _cursor.vehchain = false;
1087  }
1088 
1089  void OnTimeout() override
1090  {
1091  if (!this->IsWidgetDisabled(WID_D_SELL)) {
1092  this->RaiseWidget(WID_D_SELL);
1093  this->SetWidgetDirty(WID_D_SELL);
1094  }
1095  if (this->GetWidget<NWidgetBase>(WID_D_SELL) != nullptr && !this->IsWidgetDisabled(WID_D_SELL_CHAIN)) {
1098  }
1099  }
1100 
1101  void OnResize() override
1102  {
1103  this->vscroll->SetCapacityFromWidget(this, WID_D_MATRIX);
1104  NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
1105  if (this->type == VEH_TRAIN) {
1106  this->hscroll->SetCapacity(nwi->current_x - this->header_width - this->count_width);
1107  } else {
1108  this->num_columns = nwi->current_x / nwi->resize_x;
1109  }
1110  }
1111 
1113  {
1114  if (this->sel != INVALID_VEHICLE) {
1115  _cursor.vehchain = _ctrl_pressed;
1117  return ES_HANDLED;
1118  }
1119 
1120  return ES_NOT_HANDLED;
1121  }
1122 
1128  inline uint16 GetDepotIndex() const
1129  {
1130  return (this->type == VEH_AIRCRAFT) ? ::GetStationIndex(this->window_number) : ::GetDepotIndex(this->window_number);
1131  }
1132 };
1133 
1134 static void DepotSellAllConfirmationCallback(Window *win, bool confirmed)
1135 {
1136  if (confirmed) {
1137  DepotWindow *w = (DepotWindow*)win;
1138  TileIndex tile = w->window_number;
1139  VehicleType vehtype = w->type;
1141  }
1142 }
1143 
1150 {
1151  if (BringWindowToFrontById(WC_VEHICLE_DEPOT, tile) != nullptr) return;
1152 
1153  WindowDesc *desc;
1154  switch (type) {
1155  default: NOT_REACHED();
1156  case VEH_TRAIN: desc = &_train_depot_desc; break;
1157  case VEH_ROAD: desc = &_road_depot_desc; break;
1158  case VEH_SHIP: desc = &_ship_depot_desc; break;
1159  case VEH_AIRCRAFT: desc = &_aircraft_depot_desc; break;
1160  }
1161 
1162  new DepotWindow(desc, tile, type);
1163 }
1164 
1170 {
1171  DepotWindow *w;
1172 
1173  /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any depots either
1174  * If that is the case, we can skip looping though the windows and save time
1175  */
1176  if (_special_mouse_mode != WSM_DRAGDROP) return;
1177 
1178  w = dynamic_cast<DepotWindow*>(FindWindowById(WC_VEHICLE_DEPOT, v->tile));
1179  if (w != nullptr) {
1180  if (w->sel == v->index) ResetObjectToPlace();
1181  }
1182 }
SZSP_NONE
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
Definition: widget_type.h:428
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
Train::GetDisplayImageWidth
int GetDisplayImageWidth(Point *offset=nullptr) const
Get the width of a train vehicle image in the GUI.
Definition: train_cmd.cpp:457
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:720
DepotWindow::OnRightClick
bool OnRightClick(Point pt, int widget) override
A click with the right mouse button has been made on the window.
Definition: depot_gui.cpp:846
IsCompanyBuildableVehicleType
static bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Definition: vehicle_func.h:89
DepotWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: depot_gui.cpp:298
DepotWindow::OnTimeout
void OnTimeout() override
Called when this window's timeout has been reached.
Definition: depot_gui.cpp:1089
Engine::IterateType
static Pool::IterateWrapperFiltered< Engine, EngineTypeFilter > IterateType(VehicleType vt, size_t from=0)
Returns an iterable ensemble of all valid engines of the given type.
Definition: engine_base.h:173
VehicleCellSize::height
uint height
Vehicle cell height.
Definition: vehicle_gui.h:83
WID_D_CAPTION
@ WID_D_CAPTION
Caption of window.
Definition: depot_widget.h:15
VehicleList
std::vector< const Vehicle * > VehicleList
A list of vehicles.
Definition: vehiclelist.h:55
Pool::PoolItem<&_vehicle_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2456
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1210
INVALID_CLIENT_ID
@ INVALID_CLIENT_ID
Client is not part of anything.
Definition: network_type.h:48
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:168
train.h
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
WID_D_SHOW_SELL_CHAIN
@ WID_D_SHOW_SELL_CHAIN
Show sell chain panel.
Definition: depot_widget.h:17
Scrollbar::GetCapacity
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:669
command_func.h
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:319
Commands
Commands
List of commands.
Definition: command_type.h:176
Rect::Shrink
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Definition: geometry_type.hpp:92
VehicleListIdentifier
The information about a vehicle list.
Definition: vehiclelist.h:29
_special_mouse_mode
SpecialMouseMode _special_mouse_mode
Mode of the mouse.
Definition: window.cpp:92
Vehicle::Previous
Vehicle * Previous() const
Get the previous vehicle of this vehicle.
Definition: vehicle_base.h:617
_consistent_train_width
static uint _consistent_train_width
Whether trains of all lengths are consistently scaled. Either TRAININFO_DEFAULT_VEHICLE_WIDTH,...
Definition: depot_gui.cpp:153
Window::ReInit
void ReInit(int rx=0, int ry=0)
Re-initialize a window, and optionally change its size.
Definition: window.cpp:1019
WID_D_SHOW_H_SCROLL
@ WID_D_SHOW_H_SCROLL
Show horizontal scrollbar panel.
Definition: depot_widget.h:23
Vehicle::Next
Vehicle * Next() const
Get the next vehicle of this vehicle.
Definition: vehicle_base.h:610
SpecializedVehicle::Next
T * Next() const
Get next vehicle in the chain.
Definition: vehicle_base.h:1098
DepotWindow::OnInit
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: depot_gui.cpp:651
NWID_HSCROLLBAR
@ NWID_HSCROLLBAR
Horizontal scrollbar.
Definition: widget_type.h:81
DepotWindow::cell_size
VehicleCellSize cell_size
Vehicle sprite cell size.
Definition: depot_gui.cpp:649
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
CursorVars::vehchain
bool vehchain
vehicle chain is dragged
Definition: gfx_type.h:144
WWT_IMGBTN
@ WWT_IMGBTN
(Toggle) Button with image
Definition: widget_type.h:50
depot_cmd.h
vehiclelist.h
DepotWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: depot_gui.cpp:838
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:332
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1775
VehiclesHaveSameOrderList
bool VehiclesHaveSameOrderList(const Vehicle *v1, const Vehicle *v2)
Checks if two vehicles have the same list of orders.
Definition: vehicle.cpp:3040
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
DepotWindow::hscroll
Scrollbar * hscroll
Only for trains.
Definition: depot_gui.cpp:267
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
EIT_PURCHASE
@ EIT_PURCHASE
Vehicle drawn in purchase list, autoreplace gui, ...
Definition: vehicle_type.h:91
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:82
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
WWT_MATRIX
@ WWT_MATRIX
Grid of rows and columns.
Definition: widget_type.h:57
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1161
ship.h
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:717
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:38
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:997
zoom_func.h
aircraft.h
GetUnitNumberDigits
uint GetUnitNumberDigits(VehicleList &vehicles)
Get the number of digits the biggest unit number of a set of vehicles has.
Definition: vehicle_gui.cpp:172
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:15
WID_D_VEHICLE_LIST
@ WID_D_VEHICLE_LIST
List of vehicles.
Definition: depot_widget.h:30
DrawString
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:644
SZSP_HORIZONTAL
@ SZSP_HORIZONTAL
Display plane with zero size vertically, and filling and resizing horizontally.
Definition: widget_type.h:427
WID_D_SHOW_RENAME
@ WID_D_SHOW_RENAME
Show rename panel.
Definition: depot_widget.h:28
VehicleCellSize::extend_right
uint extend_right
Extend of the cell to the right.
Definition: vehicle_gui.h:85
Window::owner
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition: window_gui.h:253
DepotWindow
Definition: depot_gui.cpp:257
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:86
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition: gfx_type.h:336
Engine
Definition: engine_base.h:36
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:224
Vehicle::IsGroundVehicle
bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
Definition: vehicle_base.h:498
WID_D_CLONE
@ WID_D_CLONE
Clone button.
Definition: depot_widget.h:26
Window::HandleButtonClick
void HandleButtonClick(byte widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition: window.cpp:659
WID_D_V_SCROLL
@ WID_D_V_SCROLL
Vertical scrollbar.
Definition: depot_widget.h:22
ShowDepotWindow
void ShowDepotWindow(TileIndex tile, VehicleType type)
Opens a depot window.
Definition: depot_gui.cpp:1149
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:636
DepotWindow::OnVehicleSelect
bool OnVehicleSelect(VehicleList::const_iterator begin, VehicleList::const_iterator end) override
Clones a vehicle from a vehicle list.
Definition: depot_gui.cpp:928
WID_D_STOP_ALL
@ WID_D_STOP_ALL
Stop all button.
Definition: depot_widget.h:31
GetShipSpriteSize
void GetShipSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a ship sprite heading west (used for lists).
Definition: ship_cmd.cpp:114
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:55
Rect::WithHeight
Rect WithHeight(int height, bool end=false) const
Copy Rect and set its height.
Definition: geometry_type.hpp:205
SetDParam
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:196
GetVehicleImageCellSize
VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type)
Get the GUI cell size for a vehicle image.
Definition: depot_gui.cpp:162
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:975
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1111
MAT_COL_START
@ MAT_COL_START
Lowest bit of the number of columns.
Definition: widget_type.h:25
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:890
textbuf_gui.h
train_cmd.h
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:377
QSF_LEN_IN_CHARS
@ QSF_LEN_IN_CHARS
the length of the string is counted in characters
Definition: textbuf_gui.h:22
DepotWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: depot_gui.cpp:425
WindowDesc
High level window description.
Definition: window_gui.h:102
WID_D_RENAME
@ WID_D_RENAME
Rename button.
Definition: depot_widget.h:29
window_gui.h
DepotWindow::DepotClick
void DepotClick(int x, int y)
Handle click in the depot matrix.
Definition: depot_gui.cpp:541
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:469
WID_D_AUTOREPLACE
@ WID_D_AUTOREPLACE
Autoreplace button.
Definition: depot_widget.h:20
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
depot_base.h
GroundVehicleCache::cached_total_length
uint16 cached_total_length
Length of the whole vehicle (valid only for the first engine).
Definition: ground_vehicle.hpp:42
DepotWindow::SetupWidgetData
void SetupWidgetData(VehicleType type)
Function to set up vehicle specific widgets (mainly sprites and strings).
Definition: depot_gui.cpp:590
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:90
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:251
GetVehicleHeight
static uint GetVehicleHeight(VehicleType type)
Get the height of a single vehicle in the GUIs.
Definition: vehicle_gui.h:73
CommandCost
Common return value for all commands.
Definition: command_type.h:24
DepotWindow::GetDepotIndex
uint16 GetDepotIndex() const
Gets the DepotID of the current window.
Definition: depot_gui.cpp:1128
GuiShowTooltips
void GuiShowTooltips(Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition: misc_gui.cpp:773
tilehighlight_func.h
CursorID
uint32 CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:19
StartStopVehicle
void StartStopVehicle(const Vehicle *v, bool texteffect)
Executes CMD_START_STOP_VEHICLE for given vehicle.
Definition: vehicle_gui.cpp:2806
Rect::Translate
Rect Translate(int x, int y) const
Copy and translate Rect by x,y pixels.
Definition: geometry_type.hpp:168
WidgetDimensions::hsep_normal
int hsep_normal
Normal horizontal spacing.
Definition: window_gui.h:63
WID_D_START_ALL
@ WID_D_START_ALL
Start all button.
Definition: depot_widget.h:32
VEH_COMPANY_END
@ VEH_COMPANY_END
Last company-ownable type.
Definition: vehicle_type.h:29
VehicleClicked
bool VehicleClicked(const Vehicle *v)
Dispatch a "vehicle selected" event if any window waits for it.
Definition: vehicle_gui.cpp:3305
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:245
INVALID_VEHICLE
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:55
_base_block_sizes_purchase
static VehicleCellSize _base_block_sizes_purchase[VEH_COMPANY_END]
Cell size for vehicle images in the purchase list.
Definition: depot_gui.cpp:152
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:1008
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:302
WidgetDimensions::matrix
RectPadding matrix
Offsets within a matrix cell.
Definition: window_gui.h:49
FS_SMALL
@ FS_SMALL
Index of the small font in the font tables.
Definition: gfx_type.h:204
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:721
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:160
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
WID_D_MATRIX
@ WID_D_MATRIX
Matrix of vehicles.
Definition: depot_widget.h:21
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:126
DepotWindow::OnCTRLStateChange
EventState OnCTRLStateChange() override
The state of the control key has changed.
Definition: depot_gui.cpp:1112
Vehicle::max_age
Date max_age
Maximum age.
Definition: vehicle_base.h:274
GroundVehicle::gcache
GroundVehicleCache gcache
Cache of often calculated values.
Definition: ground_vehicle.hpp:80
ScaleSpriteTrad
static int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition: zoom_func.h:107
Vehicle::IsFrontEngine
bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition: vehicle_base.h:913
DepotWindow::hovered_widget
int hovered_widget
Index of the widget being hovered during drag/drop. -1 if no drag is in progress.
Definition: depot_gui.cpp:262
WID_D_H_SCROLL
@ WID_D_H_SCROLL
Horizontal scrollbar.
Definition: depot_widget.h:24
VS_STOPPED
@ VS_STOPPED
Vehicle is stopped by the player.
Definition: vehicle_base.h:35
WL_INFO
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:22
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
BuildDepotVehicleList
void BuildDepotVehicleList(VehicleType type, TileIndex tile, VehicleList *engines, VehicleList *wagons, bool individual_wagons)
Generate a list of vehicles inside a depot.
Definition: vehiclelist.cpp:69
safeguards.h
ShowQueryString
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1115
_nested_train_depot_widgets
static const NWidgetPart _nested_train_depot_widgets[]
Nested widget definition for train depots.
Definition: depot_gui.cpp:49
DepotWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: depot_gui.cpp:367
VehiclesHaveSameEngineList
bool VehiclesHaveSameEngineList(const Vehicle *v1, const Vehicle *v2)
Checks if two vehicle chains have the same list of engines.
Definition: vehicle.cpp:3023
Train
'Train' is either a loco or a wagon.
Definition: train.h:89
vehicle_cmd.h
Rect::Indent
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Definition: geometry_type.hpp:192
IsTileOwner
static bool IsTileOwner(TileIndex tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition: tile_map.h:214
SetMouseCursorVehicle
void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type)
Set the mouse cursor to look like a vehicle.
Definition: vehicle_gui.cpp:3414
DepotWindow::OnMouseDrag
void OnMouseDrag(Point pt, int widget) override
An 'object' is being dragged at the provided position, highlight the target if possible.
Definition: depot_gui.cpp:983
Rect::WithWidth
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
Definition: geometry_type.hpp:179
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
error.h
WSM_DRAGDROP
@ WSM_DRAGDROP
Drag&drop an object.
Definition: window_gui.h:923
WID_D_LOCATION
@ WID_D_LOCATION
Location button.
Definition: depot_widget.h:27
DrawRoadVehImage
void DrawRoadVehImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip)
Draws an image of a road vehicle chain.
Definition: roadveh_gui.cpp:127
DAYS_IN_LEAP_YEAR
static const int DAYS_IN_LEAP_YEAR
sometimes, you need one day more...
Definition: date_type.h:30
stdafx.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:241
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
DepotWindow::OnPlaceObjectAbort
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition: depot_gui.cpp:965
ResizeInfo::step_height
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:154
OrderBackup::Reset
static void Reset(TileIndex tile=INVALID_TILE, bool from_gui=true)
Reset the OrderBackups from GUI/game logic.
Definition: order_backup.cpp:187
CS_ALPHANUMERAL
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
viewport_func.h
NWidgetBase::current_y
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:197
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
EIT_IN_DEPOT
@ EIT_IN_DEPOT
Vehicle drawn in depot.
Definition: vehicle_type.h:88
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
GetTileOwner
static Owner GetTileOwner(TileIndex tile)
Returns the owner of a tile.
Definition: tile_map.h:178
HT_VEHICLE
@ HT_VEHICLE
vehicle is accepted as target as well (bitmask)
Definition: tilehighlight_type.h:27
FONT_HEIGHT_SMALL
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:203
HT_DRAG
@ HT_DRAG
dragging items in the depot windows
Definition: tilehighlight_type.h:24
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
GetWindowClassForVehicleType
static WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition: vehicle_gui.h:96
DepotWindow::OnDragDrop
void OnDragDrop(Point pt, int widget) override
A dragged 'object' has been released.
Definition: depot_gui.cpp:1035
Scrollbar::SetCapacity
void SetCapacity(int capacity)
Set the capacity of visible elements.
Definition: widget_type.h:733
spritecache.h
Vehicle::FirstShared
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:704
WWT_PUSHIMGBTN
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
ShowQuery
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the ce...
Definition: misc_gui.cpp:1266
vehicle_func.h
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1096
DepotWindow::GetDepotVehiclePtData
Definition: depot_gui.cpp:433
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
GetAircraftSpriteSize
void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of an aircraft sprite heading west (used for lists).
Definition: aircraft_cmd.cpp:247
ResizeInfo::step_width
uint step_width
Step-size of width resize changes.
Definition: window_gui.h:153
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:199
depot_widget.h
DepotWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: depot_gui.cpp:762
WC_BUILD_VEHICLE
@ WC_BUILD_VEHICLE
Build vehicle; Window numbers:
Definition: window_type.h:376
WIDGET_LIST_END
static const int WIDGET_LIST_END
indicate the end of widgets' list for vararg functions
Definition: widget_type.h:20
MAX_LENGTH_DEPOT_NAME_CHARS
static const uint MAX_LENGTH_DEPOT_NAME_CHARS
The maximum length of a depot name in characters including '\0'.
Definition: depot_type.h:20
SpecializedVehicle< Train, Type >::From
static Train * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1183
DepotWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: depot_gui.cpp:1101
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:206
GetTrainSpriteSize
void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a train sprite heading west, or both heads (used for lists).
Definition: train_cmd.cpp:578
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1229
WID_D_SELL
@ WID_D_SELL
Sell button.
Definition: depot_widget.h:16
geometry_func.hpp
SetDParamMaxValue
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:95
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1014
GetRoadVehSpriteSize
void GetRoadVehSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a road vehicle sprite heading west (used for lists).
Definition: roadveh_cmd.cpp:170
WID_D_SELL_CHAIN
@ WID_D_SELL_CHAIN
Sell chain button.
Definition: depot_widget.h:18
DepotWindow::header_width
uint header_width
Width of unit number and flag, including separator.
Definition: depot_gui.cpp:647
Window::SetWidgetsDisabledState
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
Definition: window.cpp:560
NWidgetBase::resize_y
uint resize_y
Vertical resize step (0 means not resizable).
Definition: widget_type.h:189
WC_VEHICLE_DEPOT
@ WC_VEHICLE_DEPOT
Depot view; Window numbers:
Definition: window_type.h:344
Window::IsWidgetLowered
bool IsWidgetLowered(byte widget_index) const
Gets the lowered state of a widget.
Definition: window_gui.h:422
Vehicle::age
Date age
Age in days.
Definition: vehicle_base.h:273
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:65
GetStationIndex
static StationID GetStationIndex(TileIndex t)
Get StationID from a tile.
Definition: station_map.h:28
_base_block_sizes_depot
static VehicleCellSize _base_block_sizes_depot[VEH_COMPANY_END]
Cell size for vehicle images in the depot view.
Definition: depot_gui.cpp:151
EventState
EventState
State of handling an event.
Definition: window_type.h:719
CcCloneVehicle
void CcCloneVehicle(Commands cmd, const CommandCost &result, VehicleID veh_id)
This is the Callback method after the cloning attempt of a vehicle.
Definition: depot_gui.cpp:124
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:678
InitDepotWindowBlockSizes
void InitDepotWindowBlockSizes()
Set the size of the blocks in the window so we can be sure that they are big enough for the vehicle s...
Definition: depot_gui.cpp:219
NWidgetCore::colour
Colours colour
Colour of this widget.
Definition: widget_type.h:338
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1791
Vehicle::unitnumber
UnitID unitnumber
unit number, for display purposes only
Definition: vehicle_base.h:305
company_func.h
VehicleCellSize
Dimensions of a cell in the purchase/depot windows.
Definition: vehicle_gui.h:82
DepotWindow::count_width
uint count_width
Width of length count, including separator.
Definition: depot_gui.cpp:646
Vehicle::Last
Vehicle * Last()
Get the last vehicle of this vehicle chain.
Definition: vehicle_base.h:629
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
CommandHelper
Definition: command_func.h:94
ShowVehicleViewWindow
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
Definition: vehicle_gui.cpp:3295
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_type.h:344
Window::ToggleWidgetLoweredState
void ToggleWidgetLoweredState(byte widget_index)
Invert the lowered/raised status of a widget.
Definition: window_gui.h:392
DrawShipImage
void DrawShipImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type)
Draws an image of a ship.
Definition: ship_gui.cpp:30
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:386
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:248
DepotWindow::UpdateWidgetSize
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: depot_gui.cpp:657
Scrollbar::SetCapacityFromWidget
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:2427
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1191
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:200
SetObjectToPlaceWnd
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
Definition: viewport.cpp:3371
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1080
DepotWindow::OnVehicleSelect
bool OnVehicleSelect(const Vehicle *v) override
Clones a vehicle.
Definition: depot_gui.cpp:907
gui.h
SPR_CURSOR_MOUSE
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1378
CeilDiv
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:280
WID_D_BUILD
@ WID_D_BUILD
Build button.
Definition: depot_widget.h:25
Window
Data structure for an opened window.
Definition: window_gui.h:213
GroundVehicle::IsFreeWagon
bool IsFreeWagon() const
Check if the vehicle is a free wagon (got no engine in front of it).
Definition: ground_vehicle.hpp:310
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
Window::RaiseWidget
void RaiseWidget(byte widget_index)
Marks a widget as raised.
Definition: window_gui.h:412
DrawAircraftImage
void DrawAircraftImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type)
Draws an image of an aircraft.
Definition: aircraft_gui.cpp:79
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:52
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:858
AllEqual
bool AllEqual(It begin, It end, Pred pred)
Generic helper function that checks if all elements of the range are equal with respect to the given ...
Definition: window_gui.h:830
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
NWID_SELECTION
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition: widget_type.h:78
order_backup.h
Window::IsWidgetDisabled
bool IsWidgetDisabled(byte widget_index) const
Gets the enabled/disabled status of a widget.
Definition: window_gui.h:350
GetScaledSpriteSize
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
Definition: widget.cpp:187
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:316
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:621
DepotWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: depot_gui.cpp:705
DeleteDepotHighlightOfVehicle
void DeleteDepotHighlightOfVehicle(const Vehicle *v)
Removes the highlight of a vehicle in a depot window.
Definition: depot_gui.cpp:1169
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:69
BringWindowToFrontById
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Definition: window.cpp:1274
NWidgetBase::resize_x
uint resize_x
Horizontal resize step (0 means not resizable).
Definition: widget_type.h:188
Sprite
Data structure describing a sprite.
Definition: spritecache.h:17
QSF_ENABLE_DEFAULT
@ QSF_ENABLE_DEFAULT
enable the 'Default' button ("\0" is returned)
Definition: textbuf_gui.h:21
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:196
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:402
WID_D_SELL_ALL
@ WID_D_SELL_ALL
Sell all button.
Definition: depot_widget.h:19
SetDParamMaxDigits
void SetDParamMaxDigits(uint n, uint count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition: strings.cpp:111
ResetObjectToPlace
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition: viewport.cpp:3434
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:382
DepotWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: depot_gui.cpp:710
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:49
DepotWindow::DrawVehicleInDepot
void DrawVehicleInDepot(const Vehicle *v, const Rect &r) const
Draw a vehicle in the depot window in the box with the top left corner at x,y.
Definition: depot_gui.cpp:311
SpecializedVehicle::GetFirstEnginePart
T * GetFirstEnginePart()
Get the first part of an articulated engine.
Definition: vehicle_base.h:1124
DepotWindow::num_columns
uint num_columns
Number of columns.
Definition: depot_gui.cpp:266
VehicleCellSize::extend_left
uint extend_left
Extend of the cell to the left.
Definition: vehicle_gui.h:84
DepotWindow::flag_size
Dimension flag_size
Size of start/stop flag.
Definition: depot_gui.cpp:648
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
ScaleGUITrad
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition: widget.cpp:168
DrawTrainImage
void DrawTrainImage(const Train *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest)
Draws an image of a whole train.
Definition: train_gui.cpp:94
DepotWindow::vehicle_over
VehicleID vehicle_over
Rail vehicle over which another one is dragged, INVALID_VEHICLE if none.
Definition: depot_gui.cpp:259
roadveh.h
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1107
WidgetDimensions::vsep_normal
int vsep_normal
Normal vertical spacing.
Definition: window_gui.h:61