OpenTTD
depot_gui.cpp
Go to the documentation of this file.
1 /* $Id: depot_gui.cpp 27450 2015-11-20 09:25:27Z alberth $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "stdafx.h"
13 #include "train.h"
14 #include "roadveh.h"
15 #include "ship.h"
16 #include "aircraft.h"
17 #include "gui.h"
18 #include "textbuf_gui.h"
19 #include "viewport_func.h"
20 #include "command_func.h"
21 #include "depot_base.h"
22 #include "spritecache.h"
23 #include "strings_func.h"
24 #include "vehicle_func.h"
25 #include "company_func.h"
26 #include "tilehighlight_func.h"
27 #include "window_gui.h"
28 #include "vehiclelist.h"
29 #include "order_backup.h"
30 #include "zoom_func.h"
31 
32 #include "widgets/depot_widget.h"
33 
34 #include "table/strings.h"
35 
36 #include "safeguards.h"
37 
38 /*
39  * Since all depot window sizes aren't the same, we need to modify sizes a little.
40  * 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.
41  * How long they should be moved and for what window types are controlled in ShowDepotWindow()
42  */
43 
47  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
48  NWidget(WWT_CAPTION, COLOUR_GREY, WID_D_CAPTION), SetDataTip(STR_DEPOT_CAPTION, STR_NULL),
49  NWidget(WWT_SHADEBOX, COLOUR_GREY),
50  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
51  NWidget(WWT_STICKYBOX, COLOUR_GREY),
52  EndContainer(),
56  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_H_SCROLL),
57  NWidget(NWID_HSCROLLBAR, COLOUR_GREY, WID_D_H_SCROLL),
58  EndContainer(),
59  EndContainer(),
61  NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL), SetDataTip(0x0, STR_NULL), SetResize(0, 1), SetFill(0, 1),
63  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),
64  EndContainer(),
65  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_SELL_ALL), SetDataTip(0x0, STR_NULL),
66  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_AUTOREPLACE), SetDataTip(0x0, STR_NULL),
67  EndContainer(),
68  NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_D_V_SCROLL),
69  EndContainer(),
71  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_BUILD), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
72  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_D_CLONE), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
73  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_LOCATION), SetDataTip(STR_BUTTON_LOCATION, STR_NULL), SetFill(1, 1), SetResize(1, 0),
74  NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_RENAME), // rename button
75  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_RENAME), SetDataTip(STR_BUTTON_RENAME, STR_DEPOT_RENAME_TOOLTIP), SetFill(1, 1), SetResize(1, 0),
76  EndContainer(),
77  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_VEHICLE_LIST), SetDataTip(0x0, STR_NULL), SetFill(0, 1),
78  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_STOP_ALL), SetDataTip(SPR_FLAG_VEH_STOPPED, STR_NULL), SetFill(0, 1),
79  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_START_ALL), SetDataTip(SPR_FLAG_VEH_RUNNING, STR_NULL), SetFill(0, 1),
80  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
81  EndContainer(),
82 };
83 
84 static WindowDesc _train_depot_desc(
85  WDP_AUTO, "depot_train", 362, 123,
87  0,
88  _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
89 );
90 
91 static WindowDesc _road_depot_desc(
92  WDP_AUTO, "depot_roadveh", 316, 97,
94  0,
95  _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
96 );
97 
98 static WindowDesc _ship_depot_desc(
99  WDP_AUTO, "depot_ship", 306, 99,
101  0,
102  _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
103 );
104 
105 static WindowDesc _aircraft_depot_desc(
106  WDP_AUTO, "depot_aircraft", 332, 99,
108  0,
109  _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
110 );
111 
112 extern void DepotSortList(VehicleList *list);
113 
121 void CcCloneVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
122 {
123  if (result.Failed()) return;
124 
125  const Vehicle *v = Vehicle::Get(_new_vehicle_id);
126 
128 }
129 
130 static void TrainDepotMoveVehicle(const Vehicle *wagon, VehicleID sel, const Vehicle *head)
131 {
132  const Vehicle *v = Vehicle::Get(sel);
133 
134  if (v == wagon) return;
135 
136  if (wagon == NULL) {
137  if (head != NULL) wagon = head->Last();
138  } else {
139  wagon = wagon->Previous();
140  if (wagon == NULL) return;
141  }
142 
143  if (wagon == v) return;
144 
145  DoCommandP(v->tile, v->index | (_ctrl_pressed ? 1 : 0) << 20, wagon == NULL ? INVALID_VEHICLE : wagon->index, CMD_MOVE_RAIL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_MOVE_VEHICLE));
146 }
147 
150 
159 {
160  switch (image_type) {
161  case EIT_IN_DEPOT: return _base_block_sizes_depot[type];
162  case EIT_PURCHASE: return _base_block_sizes_purchase[type];
163  default: NOT_REACHED();
164  }
165 }
166 
167 static void InitBlocksizeForVehicles(VehicleType type, EngineImageType image_type)
168 {
169  int max_extend_left = 0;
170  int max_extend_right = 0;
171  uint max_height = 0;
172 
173  const Engine *e;
174  FOR_ALL_ENGINES_OF_TYPE(e, type) {
175  if (!e->IsEnabled()) continue;
176 
177  EngineID eid = e->index;
178  uint x, y;
179  int x_offs, y_offs;
180 
181  switch (type) {
182  default: NOT_REACHED();
183  case VEH_TRAIN: GetTrainSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
184  case VEH_ROAD: GetRoadVehSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
185  case VEH_SHIP: GetShipSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
186  case VEH_AIRCRAFT: GetAircraftSpriteSize(eid, x, y, x_offs, y_offs, image_type); break;
187  }
188  if (y > max_height) max_height = y;
189  if (-x_offs > max_extend_left) max_extend_left = -x_offs;
190  if ((int)x + x_offs > max_extend_right) max_extend_right = x + x_offs;
191  }
192 
193  int min_extend = ScaleGUITrad(16);
194  int max_extend = ScaleGUITrad(98);
195 
196  switch (image_type) {
197  case EIT_IN_DEPOT:
198  _base_block_sizes_depot[type].height = max<uint>(ScaleGUITrad(GetVehicleHeight(type)), max_height);
199  _base_block_sizes_depot[type].extend_left = Clamp(max_extend_left, min_extend, max_extend);
200  _base_block_sizes_depot[type].extend_right = Clamp(max_extend_right, min_extend, max_extend);
201  break;
202  case EIT_PURCHASE:
203  _base_block_sizes_purchase[type].height = max<uint>(ScaleGUITrad(GetVehicleHeight(type)), max_height);
204  _base_block_sizes_purchase[type].extend_left = Clamp(max_extend_left, min_extend, max_extend);
205  _base_block_sizes_purchase[type].extend_right = Clamp(max_extend_right, min_extend, max_extend);
206  break;
207 
208  default: NOT_REACHED();
209  }
210 }
211 
217 {
218  for (VehicleType vt = VEH_BEGIN; vt < VEH_COMPANY_END; vt++) {
219  InitBlocksizeForVehicles(vt, EIT_IN_DEPOT);
220  InitBlocksizeForVehicles(vt, EIT_PURCHASE);
221  }
222 }
223 
224 static void DepotSellAllConfirmationCallback(Window *w, bool confirmed);
225 const Sprite *GetAircraftSprite(EngineID engine);
226 
227 struct DepotWindow : Window {
228  VehicleID sel;
230  VehicleType type;
231  bool generate_list;
233  VehicleList vehicle_list;
234  VehicleList wagon_list;
235  uint unitnumber_digits;
236  uint num_columns;
238  Scrollbar *vscroll;
239 
240  DepotWindow(WindowDesc *desc, TileIndex tile, VehicleType type) : Window(desc)
241  {
242  assert(IsCompanyBuildableVehicleType(type)); // ensure that we make the call with a valid type
243 
244  this->sel = INVALID_VEHICLE;
246  this->generate_list = true;
247  this->hovered_widget = -1;
248  this->type = type;
249  this->num_columns = 1; // for non-trains this gets set in FinishInitNested()
250  this->unitnumber_digits = 2;
251 
252  this->CreateNestedTree();
253  this->hscroll = (this->type == VEH_TRAIN ? this->GetScrollbar(WID_D_H_SCROLL) : NULL);
254  this->vscroll = this->GetScrollbar(WID_D_V_SCROLL);
255  /* Don't show 'rename button' of aircraft hangar */
256  this->GetWidget<NWidgetStacked>(WID_D_SHOW_RENAME)->SetDisplayedPlane(type == VEH_AIRCRAFT ? SZSP_NONE : 0);
257  /* Only train depots have a horizontal scrollbar and a 'sell chain' button */
258  if (type == VEH_TRAIN) this->GetWidget<NWidgetCore>(WID_D_MATRIX)->widget_data = 1 << MAT_COL_START;
259  this->GetWidget<NWidgetStacked>(WID_D_SHOW_H_SCROLL)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_HORIZONTAL);
260  this->GetWidget<NWidgetStacked>(WID_D_SHOW_SELL_CHAIN)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_NONE);
261  this->SetupWidgetData(type);
262  this->FinishInitNested(tile);
263 
264  this->owner = GetTileOwner(tile);
266  }
267 
268  ~DepotWindow()
269  {
272  }
273 
281  void DrawVehicleInDepot(const Vehicle *v, int left, int right, int y) const
282  {
283  bool free_wagon = false;
284  int sprite_y = y + (this->resize.step_height - ScaleGUITrad(GetVehicleHeight(v->type))) / 2;
285 
286  bool rtl = _current_text_dir == TD_RTL;
287  int image_left = rtl ? left + this->count_width : left + this->header_width;
288  int image_right = rtl ? right - this->header_width : right - this->count_width;
289 
290  switch (v->type) {
291  case VEH_TRAIN: {
292  const Train *u = Train::From(v);
293  free_wagon = u->IsFreeWagon();
294 
295  uint x_space = free_wagon ? ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) : 0;
296  DrawTrainImage(u, image_left + (rtl ? 0 : x_space), image_right - (rtl ? x_space : 0), sprite_y - 1,
297  this->sel, EIT_IN_DEPOT, free_wagon ? 0 : this->hscroll->GetPosition(), this->vehicle_over);
298 
299  /* Length of consist in tiles with 1 fractional digit (rounded up) */
301  SetDParam(1, 1);
302  DrawString(rtl ? left + WD_FRAMERECT_LEFT : right - this->count_width, rtl ? left + this->count_width : right - WD_FRAMERECT_RIGHT, y + (this->resize.step_height - FONT_HEIGHT_SMALL) / 2, STR_TINY_BLACK_DECIMAL, TC_FROMSTRING, SA_RIGHT); // Draw the counter
303  break;
304  }
305 
306  case VEH_ROAD: DrawRoadVehImage( v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
307  case VEH_SHIP: DrawShipImage( v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
308  case VEH_AIRCRAFT: DrawAircraftImage(v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
309  default: NOT_REACHED();
310  }
311 
312  uint diff_x, diff_y;
313  if (v->IsGroundVehicle()) {
314  /* Arrange unitnumber and flag horizontally */
315  diff_x = this->flag_width + WD_FRAMERECT_LEFT;
316  diff_y = (this->resize.step_height - this->flag_height) / 2 - 2;
317  } else {
318  /* Arrange unitnumber and flag vertically */
319  diff_x = WD_FRAMERECT_LEFT;
321  }
322  int text_left = rtl ? right - this->header_width - 1 : left + diff_x;
323  int text_right = rtl ? right - diff_x : left + this->header_width - 1;
324 
325  if (free_wagon) {
326  DrawString(text_left, text_right, y + 2, STR_DEPOT_NO_ENGINE);
327  } else {
328  DrawSprite((v->vehstatus & VS_STOPPED) ? SPR_FLAG_VEH_STOPPED : SPR_FLAG_VEH_RUNNING, PAL_NONE, rtl ? right - this->flag_width : left + WD_FRAMERECT_LEFT, y + diff_y);
329 
330  SetDParam(0, v->unitnumber);
331  DrawString(text_left, text_right, y + 2, (uint16)(v->max_age - DAYS_IN_LEAP_YEAR) >= v->age ? STR_BLACK_COMMA : STR_RED_COMMA);
332  }
333  }
334 
335  void DrawWidget(const Rect &r, int widget) const
336  {
337  if (widget != WID_D_MATRIX) return;
338 
339  bool rtl = _current_text_dir == TD_RTL;
340 
341  /* Set the row and number of boxes in each row based on the number of boxes drawn in the matrix */
342  const NWidgetCore *wid = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
343  uint16 rows_in_display = wid->current_y / wid->resize_y;
344 
345  uint16 num = this->vscroll->GetPosition() * this->num_columns;
346  int maxval = min(this->vehicle_list.Length(), num + (rows_in_display * this->num_columns));
347  int y;
348  for (y = r.top + 1; num < maxval; y += this->resize.step_height) { // Draw the rows
349  for (byte i = 0; i < this->num_columns && num < maxval; i++, num++) {
350  /* Draw all vehicles in the current row */
351  const Vehicle *v = this->vehicle_list[num];
352  if (this->num_columns == 1) {
353  this->DrawVehicleInDepot(v, r.left, r.right, y);
354  } else {
355  int x = r.left + (rtl ? (this->num_columns - i - 1) : i) * this->resize.step_width;
356  this->DrawVehicleInDepot(v, x, x + this->resize.step_width - 1, y);
357  }
358  }
359  }
360 
361  maxval = min(this->vehicle_list.Length() + this->wagon_list.Length(), (this->vscroll->GetPosition() * this->num_columns) + (rows_in_display * this->num_columns));
362 
363  /* Draw the train wagons without an engine in front. */
364  for (; num < maxval; num++, y += this->resize.step_height) {
365  const Vehicle *v = this->wagon_list[num - this->vehicle_list.Length()];
366  this->DrawVehicleInDepot(v, r.left, r.right, y);
367  }
368  }
369 
370  void SetStringParameters(int widget) const
371  {
372  if (widget != WID_D_CAPTION) return;
373 
374  /* locate the depot struct */
375  TileIndex tile = this->window_number;
376  SetDParam(0, this->type);
377  SetDParam(1, (this->type == VEH_AIRCRAFT) ? GetStationIndex(tile) : GetDepotIndex(tile));
378  }
379 
381  const Vehicle *head;
382  const Vehicle *wagon;
383  };
384 
385  enum DepotGUIAction {
386  MODE_ERROR,
387  MODE_DRAG_VEHICLE,
388  MODE_SHOW_VEHICLE,
389  MODE_START_STOP,
390  };
391 
392  DepotGUIAction GetVehicleFromDepotWndPt(int x, int y, const Vehicle **veh, GetDepotVehiclePtData *d) const
393  {
394  const NWidgetCore *matrix_widget = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
395  /* In case of RTL the widgets are swapped as a whole */
396  if (_current_text_dir == TD_RTL) x = matrix_widget->current_x - x;
397 
398  uint xt = 0, xm = 0, ym = 0;
399  if (this->type == VEH_TRAIN) {
400  xm = x;
401  } else {
402  xt = x / this->resize.step_width;
403  xm = x % this->resize.step_width;
404  if (xt >= this->num_columns) return MODE_ERROR;
405  }
406  ym = y % this->resize.step_height;
407 
408  uint row = y / this->resize.step_height;
409  if (row >= this->vscroll->GetCapacity()) return MODE_ERROR;
410 
411  uint pos = ((row + this->vscroll->GetPosition()) * this->num_columns) + xt;
412 
413  if (this->vehicle_list.Length() + this->wagon_list.Length() <= pos) {
414  /* Clicking on 'line' / 'block' without a vehicle */
415  if (this->type == VEH_TRAIN) {
416  /* End the dragging */
417  d->head = NULL;
418  d->wagon = NULL;
419  return MODE_DRAG_VEHICLE;
420  } else {
421  return MODE_ERROR; // empty block, so no vehicle is selected
422  }
423  }
424 
425  bool wagon = false;
426  if (this->vehicle_list.Length() > pos) {
427  *veh = this->vehicle_list[pos];
428  /* Skip vehicles that are scrolled off the list */
429  if (this->type == VEH_TRAIN) x += this->hscroll->GetPosition();
430  } else {
431  pos -= this->vehicle_list.Length();
432  *veh = this->wagon_list[pos];
433  /* free wagons don't have an initial loco. */
434  x -= ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
435  wagon = true;
436  }
437 
438  const Train *v = NULL;
439  if (this->type == VEH_TRAIN) {
440  v = Train::From(*veh);
441  d->head = d->wagon = v;
442  }
443 
444  if (xm <= this->header_width) {
445  switch (this->type) {
446  case VEH_TRAIN:
447  if (wagon) return MODE_ERROR;
448  /* FALL THROUGH */
449  case VEH_ROAD:
450  if (xm <= this->flag_width) return MODE_START_STOP;
451  break;
452 
453  case VEH_SHIP:
454  case VEH_AIRCRAFT:
455  if (xm <= this->flag_width && ym >= (uint)(FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL)) return MODE_START_STOP;
456  break;
457 
458  default: NOT_REACHED();
459  }
460  return MODE_SHOW_VEHICLE;
461  }
462 
463  if (this->type != VEH_TRAIN) return MODE_DRAG_VEHICLE;
464 
465  /* Clicking on the counter */
466  if (xm >= matrix_widget->current_x - this->count_width) return wagon ? MODE_ERROR : MODE_SHOW_VEHICLE;
467 
468  /* Account for the header */
469  x -= this->header_width;
470 
471  /* find the vehicle in this row that was clicked */
472  for (; v != NULL; v = v->Next()) {
473  x -= v->GetDisplayImageWidth();
474  if (x < 0) break;
475  }
476 
477  d->wagon = (v != NULL ? v->GetFirstEnginePart() : NULL);
478 
479  return MODE_DRAG_VEHICLE;
480  }
481 
487  void DepotClick(int x, int y)
488  {
489  GetDepotVehiclePtData gdvp = { NULL, NULL };
490  const Vehicle *v = NULL;
491  DepotGUIAction mode = this->GetVehicleFromDepotWndPt(x, y, &v, &gdvp);
492 
493  if (this->type == VEH_TRAIN) v = gdvp.wagon;
494 
495  switch (mode) {
496  case MODE_ERROR: // invalid
497  return;
498 
499  case MODE_DRAG_VEHICLE: { // start dragging of vehicle
500  if (v != NULL && VehicleClicked(v)) return;
501 
502  VehicleID sel = this->sel;
503 
504  if (this->type == VEH_TRAIN && sel != INVALID_VEHICLE) {
505  this->sel = INVALID_VEHICLE;
506  TrainDepotMoveVehicle(v, sel, gdvp.head);
507  } else if (v != NULL) {
508  bool rtl = _current_text_dir == TD_RTL;
509  int image = v->GetImage(rtl ? DIR_E : DIR_W, EIT_IN_DEPOT);
511 
512  this->sel = v->index;
513  this->SetDirty();
514 
515  _cursor.short_vehicle_offset = v->IsGroundVehicle() ? (16 - v->GetGroundVehicleCache()->cached_veh_length * 2) * (rtl ? -1 : 1) : 0;
516  _cursor.vehchain = _ctrl_pressed;
517  }
518  break;
519  }
520 
521  case MODE_SHOW_VEHICLE: // show info window
523  break;
524 
525  case MODE_START_STOP: // click start/stop flag
526  StartStopVehicle(v, false);
527  break;
528 
529  default: NOT_REACHED();
530  }
531  }
532 
540  {
541  this->GetWidget<NWidgetCore>(WID_D_STOP_ALL)->tool_tip = STR_DEPOT_MASS_STOP_DEPOT_TRAIN_TOOLTIP + type;
542  this->GetWidget<NWidgetCore>(WID_D_START_ALL)->tool_tip = STR_DEPOT_MASS_START_DEPOT_TRAIN_TOOLTIP + type;
543  this->GetWidget<NWidgetCore>(WID_D_SELL)->tool_tip = STR_DEPOT_TRAIN_SELL_TOOLTIP + type;
544  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->tool_tip = STR_DEPOT_SELL_ALL_BUTTON_TRAIN_TOOLTIP + type;
545 
546  this->GetWidget<NWidgetCore>(WID_D_BUILD)->SetDataTip(STR_DEPOT_TRAIN_NEW_VEHICLES_BUTTON + type, STR_DEPOT_TRAIN_NEW_VEHICLES_TOOLTIP + type);
547  this->GetWidget<NWidgetCore>(WID_D_CLONE)->SetDataTip(STR_DEPOT_CLONE_TRAIN + type, STR_DEPOT_CLONE_TRAIN_DEPOT_INFO + type);
548 
549  this->GetWidget<NWidgetCore>(WID_D_LOCATION)->tool_tip = STR_DEPOT_TRAIN_LOCATION_TOOLTIP + type;
550  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->tool_tip = STR_DEPOT_VEHICLE_ORDER_LIST_TRAIN_TOOLTIP + type;
551  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->tool_tip = STR_DEPOT_AUTOREPLACE_TRAIN_TOOLTIP + type;
552  this->GetWidget<NWidgetCore>(WID_D_MATRIX)->tool_tip = STR_DEPOT_TRAIN_LIST_TOOLTIP + this->type;
553 
554  switch (type) {
555  default: NOT_REACHED();
556 
557  case VEH_TRAIN:
558  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_TRAIN;
559 
560  /* Sprites */
561  this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_TRAIN;
562  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_TRAIN;
563  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_TRAIN;
564  break;
565 
566  case VEH_ROAD:
567  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_LORRY;
568 
569  /* Sprites */
570  this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_ROADVEH;
571  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_ROADVEH;
572  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_ROADVEH;
573  break;
574 
575  case VEH_SHIP:
576  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_SHIP;
577 
578  /* Sprites */
579  this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_SHIP;
580  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_SHIP;
581  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_SHIP;
582  break;
583 
584  case VEH_AIRCRAFT:
585  this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_PLANE;
586 
587  /* Sprites */
588  this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_AIRCRAFT;
589  this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_AIRCRAFT;
590  this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_AIRCRAFT;
591  break;
592  }
593  }
594 
595  uint count_width;
596  uint header_width;
597  uint flag_width;
598  uint flag_height;
599 
600  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
601  {
602  switch (widget) {
603  case WID_D_MATRIX: {
604  uint min_height = 0;
605 
606  if (this->type == VEH_TRAIN) {
607  SetDParamMaxValue(0, 1000, 0, FS_SMALL);
608  SetDParam(1, 1);
609  this->count_width = GetStringBoundingBox(STR_TINY_BLACK_DECIMAL).width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
610  } else {
611  this->count_width = 0;
612  }
613 
614  SetDParamMaxDigits(0, this->unitnumber_digits);
615  Dimension unumber = GetStringBoundingBox(STR_BLACK_COMMA);
616  const Sprite *spr = GetSprite(SPR_FLAG_VEH_STOPPED, ST_NORMAL);
617  this->flag_width = UnScaleGUI(spr->width) + WD_FRAMERECT_RIGHT;
618  this->flag_height = UnScaleGUI(spr->height);
619 
620  if (this->type == VEH_TRAIN || this->type == VEH_ROAD) {
621  min_height = max<uint>(unumber.height + WD_MATRIX_TOP, UnScaleGUI(spr->height));
622  this->header_width = unumber.width + this->flag_width + WD_FRAMERECT_LEFT;
623  } else {
624  min_height = unumber.height + UnScaleGUI(spr->height) + WD_MATRIX_TOP + WD_PAR_VSEP_NORMAL + WD_MATRIX_BOTTOM;
625  this->header_width = max<uint>(unumber.width, this->flag_width) + WD_FRAMERECT_RIGHT;
626  }
627  int base_width = this->count_width + this->header_width;
628 
629  resize->height = max<uint>(GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).height, min_height);
630  if (this->type == VEH_TRAIN) {
631  resize->width = 1;
632  size->width = base_width + 2 * ScaleGUITrad(29); // about 2 parts
633  size->height = resize->height * 6;
634  } else {
635  resize->width = base_width + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_left + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_right;
636  size->width = resize->width * (this->type == VEH_ROAD ? 5 : 3);
637  size->height = resize->height * (this->type == VEH_ROAD ? 5 : 3);
638  }
639  fill->width = resize->width;
640  fill->height = resize->height;
641  break;
642  }
643  }
644  }
645 
651  virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
652  {
653  this->generate_list = true;
654  }
655 
656  virtual void OnPaint()
657  {
658  if (this->generate_list) {
659  /* Generate the vehicle list
660  * It's ok to use the wagon pointers for non-trains as they will be ignored */
661  BuildDepotVehicleList(this->type, this->window_number, &this->vehicle_list, &this->wagon_list);
662  this->generate_list = false;
663  DepotSortList(&this->vehicle_list);
664 
665  uint new_unitnumber_digits = GetUnitNumberDigits(this->vehicle_list);
666  if (this->unitnumber_digits != new_unitnumber_digits) {
667  this->unitnumber_digits = new_unitnumber_digits;
668  this->ReInit();
669  }
670  }
671 
672  /* determine amount of items for scroller */
673  if (this->type == VEH_TRAIN) {
674  uint max_width = ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
675  for (uint num = 0; num < this->vehicle_list.Length(); num++) {
676  uint width = 0;
677  for (const Train *v = Train::From(this->vehicle_list[num]); v != NULL; v = v->Next()) {
678  width += v->GetDisplayImageWidth();
679  }
680  max_width = max(max_width, width);
681  }
682  /* Always have 1 empty row, so people can change the setting of the train */
683  this->vscroll->SetCount(this->vehicle_list.Length() + this->wagon_list.Length() + 1);
684  this->hscroll->SetCount(max_width);
685  } else {
686  this->vscroll->SetCount(CeilDiv(this->vehicle_list.Length(), this->num_columns));
687  }
688 
689  /* Setup disabled buttons. */
690  TileIndex tile = this->window_number;
694  WID_D_SELL,
697  WID_D_BUILD,
698  WID_D_CLONE,
699  WID_D_RENAME,
702 
703  this->DrawWidgets();
704  }
705 
706  virtual void OnClick(Point pt, int widget, int click_count)
707  {
708  switch (widget) {
709  case WID_D_MATRIX: { // List
710  NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
711  this->DepotClick(pt.x - nwi->pos_x, pt.y - nwi->pos_y);
712  break;
713  }
714 
715  case WID_D_BUILD: // Build vehicle
717  ShowBuildVehicleWindow(this->window_number, this->type);
718  break;
719 
720  case WID_D_CLONE: // Clone button
723 
724  if (this->IsWidgetLowered(WID_D_CLONE)) {
725  static const CursorID clone_icons[] = {
726  SPR_CURSOR_CLONE_TRAIN, SPR_CURSOR_CLONE_ROADVEH,
727  SPR_CURSOR_CLONE_SHIP, SPR_CURSOR_CLONE_AIRPLANE
728  };
729 
730  SetObjectToPlaceWnd(clone_icons[this->type], PAL_NONE, HT_VEHICLE, this);
731  } else {
733  }
734  break;
735 
736  case WID_D_LOCATION:
737  if (_ctrl_pressed) {
739  } else {
741  }
742  break;
743 
744  case WID_D_RENAME: // Rename button
745  SetDParam(0, this->type);
746  SetDParam(1, Depot::GetByTile((TileIndex)this->window_number)->index);
747  ShowQueryString(STR_DEPOT_NAME, STR_DEPOT_RENAME_DEPOT_CAPTION, MAX_LENGTH_DEPOT_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
748  break;
749 
750  case WID_D_STOP_ALL:
751  case WID_D_START_ALL: {
752  VehicleListIdentifier vli(VL_DEPOT_LIST, this->type, this->owner);
753  DoCommandP(this->window_number, (widget == WID_D_START_ALL ? (1 << 0) : 0), vli.Pack(), CMD_MASS_START_STOP);
754  break;
755  }
756 
757  case WID_D_SELL_ALL:
758  /* Only open the confirmation window if there are anything to sell */
759  if (this->vehicle_list.Length() != 0 || this->wagon_list.Length() != 0) {
760  TileIndex tile = this->window_number;
761  byte vehtype = this->type;
762 
763  SetDParam(0, vehtype);
764  SetDParam(1, (vehtype == VEH_AIRCRAFT) ? GetStationIndex(tile) : GetDepotIndex(tile));
765  ShowQuery(
766  STR_DEPOT_CAPTION,
767  STR_DEPOT_SELL_CONFIRMATION_TEXT,
768  this,
769  DepotSellAllConfirmationCallback
770  );
771  }
772  break;
773 
774  case WID_D_VEHICLE_LIST:
775  ShowVehicleListWindow(GetTileOwner(this->window_number), this->type, (TileIndex)this->window_number);
776  break;
777 
778  case WID_D_AUTOREPLACE:
779  DoCommandP(this->window_number, this->type, 0, CMD_DEPOT_MASS_AUTOREPLACE);
780  break;
781 
782  }
783  }
784 
785  virtual void OnQueryTextFinished(char *str)
786  {
787  if (str == NULL) return;
788 
789  /* Do depot renaming */
790  DoCommandP(0, GetDepotIndex(this->window_number), 0, CMD_RENAME_DEPOT | CMD_MSG(STR_ERROR_CAN_T_RENAME_DEPOT), NULL, str);
791  }
792 
793  virtual bool OnRightClick(Point pt, int widget)
794  {
795  if (widget != WID_D_MATRIX) return false;
796 
797  GetDepotVehiclePtData gdvp = { NULL, NULL };
798  const Vehicle *v = NULL;
799  NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
800  DepotGUIAction mode = this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp);
801 
802  if (this->type == VEH_TRAIN) v = gdvp.wagon;
803 
804  if (v == NULL || mode != MODE_DRAG_VEHICLE) return false;
805 
806  CargoArray capacity, loaded;
807 
808  /* Display info for single (articulated) vehicle, or for whole chain starting with selected vehicle */
809  bool whole_chain = (this->type == VEH_TRAIN && _ctrl_pressed);
810 
811  /* loop through vehicle chain and collect cargoes */
812  uint num = 0;
813  for (const Vehicle *w = v; w != NULL; w = w->Next()) {
814  if (w->cargo_cap > 0 && w->cargo_type < NUM_CARGO) {
815  capacity[w->cargo_type] += w->cargo_cap;
816  loaded [w->cargo_type] += w->cargo.StoredCount();
817  }
818 
819  if (w->type == VEH_TRAIN && !w->HasArticulatedPart()) {
820  num++;
821  if (!whole_chain) break;
822  }
823  }
824 
825  /* Build tooltipstring */
826  static char details[1024];
827  details[0] = '\0';
828  char *pos = details;
829 
830  for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
831  if (capacity[cargo_type] == 0) continue;
832 
833  SetDParam(0, cargo_type); // {CARGO} #1
834  SetDParam(1, loaded[cargo_type]); // {CARGO} #2
835  SetDParam(2, cargo_type); // {SHORTCARGO} #1
836  SetDParam(3, capacity[cargo_type]); // {SHORTCARGO} #2
837  pos = GetString(pos, STR_DEPOT_VEHICLE_TOOLTIP_CARGO, lastof(details));
838  }
839 
840  /* Show tooltip window */
841  uint64 args[2];
842  args[0] = (whole_chain ? num : v->engine_type);
843  args[1] = (uint64)(size_t)details;
844  GuiShowTooltips(this, whole_chain ? STR_DEPOT_VEHICLE_TOOLTIP_CHAIN : STR_DEPOT_VEHICLE_TOOLTIP, 2, args, TCC_RIGHT_CLICK);
845 
846  return true;
847  }
848 
854  virtual bool OnVehicleSelect(const Vehicle *v)
855  {
856  if (DoCommandP(this->window_number, v->index, _ctrl_pressed ? 1 : 0, CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN + v->type), CcCloneVehicle)) {
858  }
859  return true;
860  }
861 
862  virtual void OnPlaceObjectAbort()
863  {
864  /* abort clone */
865  this->RaiseWidget(WID_D_CLONE);
867 
868  /* abort drag & drop */
869  this->sel = INVALID_VEHICLE;
872 
873  if (this->hovered_widget != -1) {
874  this->SetWidgetLoweredState(this->hovered_widget, false);
875  this->SetWidgetDirty(this->hovered_widget);
876  this->hovered_widget = -1;
877  }
878  }
879 
880  virtual void OnMouseDrag(Point pt, int widget)
881  {
882  if (this->sel == INVALID_VEHICLE) return;
883  if (widget != this->hovered_widget) {
884  if (this->hovered_widget == WID_D_SELL || this->hovered_widget == WID_D_SELL_CHAIN) {
885  this->SetWidgetLoweredState(this->hovered_widget, false);
886  this->SetWidgetDirty(this->hovered_widget);
887  }
888  this->hovered_widget = widget;
889  if (this->hovered_widget == WID_D_SELL || this->hovered_widget == WID_D_SELL_CHAIN) {
890  this->SetWidgetLoweredState(this->hovered_widget, true);
891  this->SetWidgetDirty(this->hovered_widget);
892  }
893  }
894  if (this->type != VEH_TRAIN) return;
895 
896  /* A rail vehicle is dragged.. */
897  if (widget != WID_D_MATRIX) { // ..outside of the depot matrix.
898  if (this->vehicle_over != INVALID_VEHICLE) {
901  }
902  return;
903  }
904 
905  NWidgetBase *matrix = this->GetWidget<NWidgetBase>(widget);
906  const Vehicle *v = NULL;
907  GetDepotVehiclePtData gdvp = {NULL, NULL};
908 
909  if (this->GetVehicleFromDepotWndPt(pt.x - matrix->pos_x, pt.y - matrix->pos_y, &v, &gdvp) != MODE_DRAG_VEHICLE) return;
910 
911  VehicleID new_vehicle_over = INVALID_VEHICLE;
912  if (gdvp.head != NULL) {
913  if (gdvp.wagon == NULL && gdvp.head->Last()->index != this->sel) { // ..at the end of the train.
914  /* 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
915  * destination inside a train. This head index is then used to indicate that a wagon is inserted at
916  * the end of the train.
917  */
918  new_vehicle_over = gdvp.head->index;
919  } else if (gdvp.wagon != NULL && gdvp.head != gdvp.wagon &&
920  gdvp.wagon->index != this->sel &&
921  gdvp.wagon->Previous()->index != this->sel) { // ..over an existing wagon.
922  new_vehicle_over = gdvp.wagon->index;
923  }
924  }
925 
926  if (this->vehicle_over == new_vehicle_over) return;
927 
928  this->vehicle_over = new_vehicle_over;
929  this->SetWidgetDirty(widget);
930  }
931 
932  virtual void OnDragDrop(Point pt, int widget)
933  {
934  switch (widget) {
935  case WID_D_MATRIX: {
936  const Vehicle *v = NULL;
937  VehicleID sel = this->sel;
938 
939  this->sel = INVALID_VEHICLE;
940  this->SetDirty();
941 
942  NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
943  if (this->type == VEH_TRAIN) {
944  GetDepotVehiclePtData gdvp = { NULL, NULL };
945 
946  if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp) == MODE_DRAG_VEHICLE && sel != INVALID_VEHICLE) {
947  if (gdvp.wagon != NULL && gdvp.wagon->index == sel && _ctrl_pressed) {
948  DoCommandP(Vehicle::Get(sel)->tile, Vehicle::Get(sel)->index, true,
949  CMD_REVERSE_TRAIN_DIRECTION | CMD_MSG(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE));
950  } else if (gdvp.wagon == NULL || gdvp.wagon->index != sel) {
952  TrainDepotMoveVehicle(gdvp.wagon, sel, gdvp.head);
953  } else if (gdvp.head != NULL && gdvp.head->IsFrontEngine()) {
954  ShowVehicleViewWindow(gdvp.head);
955  }
956  }
957  } else if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, NULL) == MODE_DRAG_VEHICLE && v != NULL && sel == v->index) {
959  }
960  break;
961  }
962 
963  case WID_D_SELL: case WID_D_SELL_CHAIN: {
964  if (this->IsWidgetDisabled(widget)) return;
965  if (this->sel == INVALID_VEHICLE) return;
966 
967  this->HandleButtonClick(widget);
968 
969  const Vehicle *v = Vehicle::Get(this->sel);
970  this->sel = INVALID_VEHICLE;
971  this->SetDirty();
972 
973  int sell_cmd = (v->type == VEH_TRAIN && (widget == WID_D_SELL_CHAIN || _ctrl_pressed)) ? 1 : 0;
974  DoCommandP(v->tile, v->index | sell_cmd << 20 | MAKE_ORDER_BACKUP_FLAG, 0, GetCmdSellVeh(v->type));
975  break;
976  }
977 
978  default:
979  this->sel = INVALID_VEHICLE;
980  this->SetDirty();
981  break;
982  }
983  this->hovered_widget = -1;
984  _cursor.vehchain = false;
985  }
986 
987  virtual void OnTimeout()
988  {
989  if (!this->IsWidgetDisabled(WID_D_SELL)) {
990  this->RaiseWidget(WID_D_SELL);
991  this->SetWidgetDirty(WID_D_SELL);
992  }
993  if (this->nested_array[WID_D_SELL] != NULL && !this->IsWidgetDisabled(WID_D_SELL_CHAIN)) {
996  }
997  }
998 
999  virtual void OnResize()
1000  {
1001  this->vscroll->SetCapacityFromWidget(this, WID_D_MATRIX);
1002  NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
1003  if (this->type == VEH_TRAIN) {
1004  this->hscroll->SetCapacity(nwi->current_x - this->header_width - this->count_width);
1005  } else {
1006  this->num_columns = nwi->current_x / nwi->resize_x;
1007  }
1008  }
1009 
1011  {
1012  if (this->sel != INVALID_VEHICLE) {
1013  _cursor.vehchain = _ctrl_pressed;
1015  return ES_HANDLED;
1016  }
1017 
1018  return ES_NOT_HANDLED;
1019  }
1020 };
1021 
1022 static void DepotSellAllConfirmationCallback(Window *win, bool confirmed)
1023 {
1024  if (confirmed) {
1025  DepotWindow *w = (DepotWindow*)win;
1026  TileIndex tile = w->window_number;
1027  byte vehtype = w->type;
1028  DoCommandP(tile, vehtype, 0, CMD_DEPOT_SELL_ALL_VEHICLES);
1029  }
1030 }
1031 
1038 {
1039  if (BringWindowToFrontById(WC_VEHICLE_DEPOT, tile) != NULL) return;
1040 
1041  WindowDesc *desc;
1042  switch (type) {
1043  default: NOT_REACHED();
1044  case VEH_TRAIN: desc = &_train_depot_desc; break;
1045  case VEH_ROAD: desc = &_road_depot_desc; break;
1046  case VEH_SHIP: desc = &_ship_depot_desc; break;
1047  case VEH_AIRCRAFT: desc = &_aircraft_depot_desc; break;
1048  }
1049 
1050  new DepotWindow(desc, tile, type);
1051 }
1052 
1058 {
1059  DepotWindow *w;
1060 
1061  /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any depots either
1062  * If that is the case, we can skip looping though the windows and save time
1063  */
1064  if (_special_mouse_mode != WSM_DRAGDROP) return;
1065 
1066  w = dynamic_cast<DepotWindow*>(FindWindowById(WC_VEHICLE_DEPOT, v->tile));
1067  if (w != NULL) {
1068  if (w->sel == v->index) ResetObjectToPlace();
1069  }
1070 }