OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

depot_gui.cpp
Go to the documentation of this file.
1 /* $Id: depot_gui.cpp 27134 2015-02-01 20:54:24Z frosch $ */
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
45 static const NWidgetPart _nested_train_depot_widgets[] = {
46 NWidget(NWID_HORIZONTAL),
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(),
53 NWidget(NWID_HORIZONTAL),
54 NWidget(NWID_VERTICAL),
55 NWidget(WWT_MATRIX, COLOUR_GREY, WID_D_MATRIX), SetResize(1, 1), SetScrollbar(WID_D_V_SCROLL),
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(),
60 NWidget(NWID_VERTICAL),
61 NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL), SetDataTip(0x0, STR_NULL), SetResize(0, 1), SetFill(0, 1),
62 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_SELL_CHAIN),
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(),
70 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
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,
86 WC_VEHICLE_DEPOT, WC_NONE,
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,
93 WC_VEHICLE_DEPOT, WC_NONE,
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,
100 WC_VEHICLE_DEPOT, WC_NONE,
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,
107 WC_VEHICLE_DEPOT, WC_NONE,
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
127 ShowVehicleViewWindow(v);
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
148 static VehicleCellSize _base_block_sizes_depot[VEH_COMPANY_END];
149 static VehicleCellSize _base_block_sizes_purchase[VEH_COMPANY_END];
150
158 VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type)
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
216 void InitDepotWindowBlockSizes()
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;
229 VehicleID vehicle_over;
230 VehicleType type;
231 bool generate_list;
232 VehicleList vehicle_list;
233 VehicleList wagon_list;
234 uint unitnumber_digits;
235 uint num_columns;
236 Scrollbar *hscroll;
237 Scrollbar *vscroll;
238
239 DepotWindow(WindowDesc *desc, TileIndex tile, VehicleType type) : Window(desc)
240 {
241 assert(IsCompanyBuildableVehicleType(type)); // ensure that we make the call with a valid type
242
243 this->sel = INVALID_VEHICLE;
244 this->vehicle_over = INVALID_VEHICLE;
245 this->generate_list = true;
246 this->type = type;
247 this->num_columns = 1; // for non-trains this gets set in FinishInitNested()
248 this->unitnumber_digits = 2;
249
250 this->CreateNestedTree();
251 this->hscroll = (this->type == VEH_TRAIN ? this->GetScrollbar(WID_D_H_SCROLL) : NULL);
252 this->vscroll = this->GetScrollbar(WID_D_V_SCROLL);
253 /* Don't show 'rename button' of aircraft hangar */
254 this->GetWidget<NWidgetStacked>(WID_D_SHOW_RENAME)->SetDisplayedPlane(type == VEH_AIRCRAFT ? SZSP_NONE : 0);
255 /* Only train depots have a horizontal scrollbar and a 'sell chain' button */
256 if (type == VEH_TRAIN) this->GetWidget<NWidgetCore>(WID_D_MATRIX)->widget_data = 1 << MAT_COL_START;
257 this->GetWidget<NWidgetStacked>(WID_D_SHOW_H_SCROLL)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_HORIZONTAL);
258 this->GetWidget<NWidgetStacked>(WID_D_SHOW_SELL_CHAIN)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_NONE);
259 this->SetupWidgetData(type);
260 this->FinishInitNested(tile);
261
262 this->owner = GetTileOwner(tile);
263 OrderBackup::Reset();
264 }
265
266 ~DepotWindow()
267 {
268 DeleteWindowById(WC_BUILD_VEHICLE, this->window_number);
269 OrderBackup::Reset(this->window_number);
270 }
271
279 void DrawVehicleInDepot(const Vehicle *v, int left, int right, int y) const
280 {
281 bool free_wagon = false;
282 int sprite_y = y + (this->resize.step_height - ScaleGUITrad(GetVehicleHeight(v->type))) / 2;
283
284 bool rtl = _current_text_dir == TD_RTL;
285 int image_left = rtl ? left + this->count_width : left + this->header_width;
286 int image_right = rtl ? right - this->header_width : right - this->count_width;
287
288 switch (v->type) {
289 case VEH_TRAIN: {
290 const Train *u = Train::From(v);
291 free_wagon = u->IsFreeWagon();
292
293 uint x_space = free_wagon ? ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) : 0;
294 DrawTrainImage(u, image_left + (rtl ? 0 : x_space), image_right - (rtl ? x_space : 0), sprite_y - 1,
295 this->sel, EIT_IN_DEPOT, free_wagon ? 0 : this->hscroll->GetPosition(), this->vehicle_over);
296
297 /* Length of consist in tiles with 1 fractional digit (rounded up) */
298 SetDParam(0, CeilDiv(u->gcache.cached_total_length * 10, TILE_SIZE));
299 SetDParam(1, 1);
300 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
301 break;
302 }
303
304 case VEH_ROAD: DrawRoadVehImage( v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
305 case VEH_SHIP: DrawShipImage( v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
306 case VEH_AIRCRAFT: DrawAircraftImage(v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
307 default: NOT_REACHED();
308 }
309
310 uint diff_x, diff_y;
311 if (v->IsGroundVehicle()) {
312 /* Arrange unitnumber and flag horizontally */
313 diff_x = this->flag_width + WD_FRAMERECT_LEFT;
314 diff_y = (this->resize.step_height - this->flag_height) / 2 - 2;
315 } else {
316 /* Arrange unitnumber and flag vertically */
317 diff_x = WD_FRAMERECT_LEFT;
318 diff_y = FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
319 }
320 int text_left = rtl ? right - this->header_width - 1 : left + diff_x;
321 int text_right = rtl ? right - diff_x : left + this->header_width - 1;
322
323 if (free_wagon) {
324 DrawString(text_left, text_right, y + 2, STR_DEPOT_NO_ENGINE);
325 } else {
326 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);
327
328 SetDParam(0, v->unitnumber);
329 DrawString(text_left, text_right, y + 2, (uint16)(v->max_age - DAYS_IN_LEAP_YEAR) >= v->age ? STR_BLACK_COMMA : STR_RED_COMMA);
330 }
331 }
332
333 void DrawWidget(const Rect &r, int widget) const
334 {
335 if (widget != WID_D_MATRIX) return;
336
337 bool rtl = _current_text_dir == TD_RTL;
338
339 /* Set the row and number of boxes in each row based on the number of boxes drawn in the matrix */
340 const NWidgetCore *wid = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
341 uint16 rows_in_display = wid->current_y / wid->resize_y;
342
343 uint16 num = this->vscroll->GetPosition() * this->num_columns;
344 int maxval = min(this->vehicle_list.Length(), num + (rows_in_display * this->num_columns));
345 int y;
346 for (y = r.top + 1; num < maxval; y += this->resize.step_height) { // Draw the rows
347 for (byte i = 0; i < this->num_columns && num < maxval; i++, num++) {
348 /* Draw all vehicles in the current row */
349 const Vehicle *v = this->vehicle_list[num];
350 if (this->num_columns == 1) {
351 this->DrawVehicleInDepot(v, r.left, r.right, y);
352 } else {
353 int x = r.left + (rtl ? (this->num_columns - i - 1) : i) * this->resize.step_width;
354 this->DrawVehicleInDepot(v, x, x + this->resize.step_width - 1, y);
355 }
356 }
357 }
358
359 maxval = min(this->vehicle_list.Length() + this->wagon_list.Length(), (this->vscroll->GetPosition() * this->num_columns) + (rows_in_display * this->num_columns));
360
361 /* Draw the train wagons without an engine in front. */
362 for (; num < maxval; num++, y += this->resize.step_height) {
363 const Vehicle *v = this->wagon_list[num - this->vehicle_list.Length()];
364 this->DrawVehicleInDepot(v, r.left, r.right, y);
365 }
366 }
367
368 void SetStringParameters(int widget) const
369 {
370 if (widget != WID_D_CAPTION) return;
371
372 /* locate the depot struct */
373 TileIndex tile = this->window_number;
374 SetDParam(0, this->type);
375 SetDParam(1, (this->type == VEH_AIRCRAFT) ? GetStationIndex(tile) : GetDepotIndex(tile));
376 }
377
378 struct GetDepotVehiclePtData {
379 const Vehicle *head;
380 const Vehicle *wagon;
381 };
382
383 enum DepotGUIAction {
384 MODE_ERROR,
385 MODE_DRAG_VEHICLE,
386 MODE_SHOW_VEHICLE,
387 MODE_START_STOP,
388 };
389
390 DepotGUIAction GetVehicleFromDepotWndPt(int x, int y, const Vehicle **veh, GetDepotVehiclePtData *d) const
391 {
392 const NWidgetCore *matrix_widget = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
393 /* In case of RTL the widgets are swapped as a whole */
394 if (_current_text_dir == TD_RTL) x = matrix_widget->current_x - x;
395
396 uint xt = 0, xm = 0, ym = 0;
397 if (this->type == VEH_TRAIN) {
398 xm = x;
399 } else {
400 xt = x / this->resize.step_width;
401 xm = x % this->resize.step_width;
402 if (xt >= this->num_columns) return MODE_ERROR;
403 }
404 ym = y % this->resize.step_height;
405
406 uint row = y / this->resize.step_height;
407 if (row >= this->vscroll->GetCapacity()) return MODE_ERROR;
408
409 uint pos = ((row + this->vscroll->GetPosition()) * this->num_columns) + xt;
410
411 if (this->vehicle_list.Length() + this->wagon_list.Length() <= pos) {
412 /* Clicking on 'line' / 'block' without a vehicle */
413 if (this->type == VEH_TRAIN) {
414 /* End the dragging */
415 d->head = NULL;
416 d->wagon = NULL;
417 return MODE_DRAG_VEHICLE;
418 } else {
419 return MODE_ERROR; // empty block, so no vehicle is selected
420 }
421 }
422
423 bool wagon = false;
424 if (this->vehicle_list.Length() > pos) {
425 *veh = this->vehicle_list[pos];
426 /* Skip vehicles that are scrolled off the list */
427 if (this->type == VEH_TRAIN) x += this->hscroll->GetPosition();
428 } else {
429 pos -= this->vehicle_list.Length();
430 *veh = this->wagon_list[pos];
431 /* free wagons don't have an initial loco. */
432 x -= ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
433 wagon = true;
434 }
435
436 const Train *v = NULL;
437 if (this->type == VEH_TRAIN) {
438 v = Train::From(*veh);
439 d->head = d->wagon = v;
440 }
441
442 if (xm <= this->header_width) {
443 switch (this->type) {
444 case VEH_TRAIN:
445 if (wagon) return MODE_ERROR;
446 /* FALL THROUGH */
447 case VEH_ROAD:
448 if (xm <= this->flag_width) return MODE_START_STOP;
449 break;
450
451 case VEH_SHIP:
452 case VEH_AIRCRAFT:
453 if (xm <= this->flag_width && ym >= (uint)(FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL)) return MODE_START_STOP;
454 break;
455
456 default: NOT_REACHED();
457 }
458 return MODE_SHOW_VEHICLE;
459 }
460
461 if (this->type != VEH_TRAIN) return MODE_DRAG_VEHICLE;
462
463 /* Clicking on the counter */
464 if (xm >= matrix_widget->current_x - this->count_width) return wagon ? MODE_ERROR : MODE_SHOW_VEHICLE;
465
466 /* Account for the header */
467 x -= this->header_width;
468
469 /* find the vehicle in this row that was clicked */
470 for (; v != NULL; v = v->Next()) {
471 x -= v->GetDisplayImageWidth();
472 if (x < 0) break;
473 }
474
475 d->wagon = (v != NULL ? v->GetFirstEnginePart() : NULL);
476
477 return MODE_DRAG_VEHICLE;
478 }
479
485 void DepotClick(int x, int y)
486 {
487 GetDepotVehiclePtData gdvp = { NULL, NULL };
488 const Vehicle *v = NULL;
489 DepotGUIAction mode = this->GetVehicleFromDepotWndPt(x, y, &v, &gdvp);
490
491 if (this->type == VEH_TRAIN) v = gdvp.wagon;
492
493 switch (mode) {
494 case MODE_ERROR: // invalid
495 return;
496
497 case MODE_DRAG_VEHICLE: { // start dragging of vehicle
498 if (v != NULL && VehicleClicked(v)) return;
499
500 VehicleID sel = this->sel;
501
502 if (this->type == VEH_TRAIN && sel != INVALID_VEHICLE) {
503 this->sel = INVALID_VEHICLE;
504 TrainDepotMoveVehicle(v, sel, gdvp.head);
505 } else if (v != NULL) {
506 bool rtl = _current_text_dir == TD_RTL;
507 int image = v->GetImage(rtl ? DIR_E : DIR_W, EIT_IN_DEPOT);
508 SetObjectToPlaceWnd(image, GetVehiclePalette(v), HT_DRAG, this);
509
510 this->sel = v->index;
511 this->SetDirty();
512
513 _cursor.short_vehicle_offset = v->IsGroundVehicle() ? (16 - v->GetGroundVehicleCache()->cached_veh_length * 2) * (rtl ? -1 : 1) : 0;
514 _cursor.vehchain = _ctrl_pressed;
515 }
516 break;
517 }
518
519 case MODE_SHOW_VEHICLE: // show info window
520 ShowVehicleViewWindow(v);
521 break;
522
523 case MODE_START_STOP: // click start/stop flag
524 StartStopVehicle(v, false);
525 break;
526
527 default: NOT_REACHED();
528 }
529 }
530
537 void SetupWidgetData(VehicleType type)
538 {
539 this->GetWidget<NWidgetCore>(WID_D_STOP_ALL)->tool_tip = STR_DEPOT_MASS_STOP_DEPOT_TRAIN_TOOLTIP + type;
540 this->GetWidget<NWidgetCore>(WID_D_START_ALL)->tool_tip = STR_DEPOT_MASS_START_DEPOT_TRAIN_TOOLTIP + type;
541 this->GetWidget<NWidgetCore>(WID_D_SELL)->tool_tip = STR_DEPOT_TRAIN_SELL_TOOLTIP + type;
542 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->tool_tip = STR_DEPOT_SELL_ALL_BUTTON_TRAIN_TOOLTIP + type;
543
544 this->GetWidget<NWidgetCore>(WID_D_BUILD)->SetDataTip(STR_DEPOT_TRAIN_NEW_VEHICLES_BUTTON + type, STR_DEPOT_TRAIN_NEW_VEHICLES_TOOLTIP + type);
545 this->GetWidget<NWidgetCore>(WID_D_CLONE)->SetDataTip(STR_DEPOT_CLONE_TRAIN + type, STR_DEPOT_CLONE_TRAIN_DEPOT_INFO + type);
546
547 this->GetWidget<NWidgetCore>(WID_D_LOCATION)->tool_tip = STR_DEPOT_TRAIN_LOCATION_TOOLTIP + type;
548 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->tool_tip = STR_DEPOT_VEHICLE_ORDER_LIST_TRAIN_TOOLTIP + type;
549 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->tool_tip = STR_DEPOT_AUTOREPLACE_TRAIN_TOOLTIP + type;
550 this->GetWidget<NWidgetCore>(WID_D_MATRIX)->tool_tip = STR_DEPOT_TRAIN_LIST_TOOLTIP + this->type;
551
552 switch (type) {
553 default: NOT_REACHED();
554
555 case VEH_TRAIN:
556 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_TRAIN;
557
558 /* Sprites */
559 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_TRAIN;
560 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_TRAIN;
561 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_TRAIN;
562 break;
563
564 case VEH_ROAD:
565 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_LORRY;
566
567 /* Sprites */
568 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_ROADVEH;
569 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_ROADVEH;
570 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_ROADVEH;
571 break;
572
573 case VEH_SHIP:
574 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_SHIP;
575
576 /* Sprites */
577 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_SHIP;
578 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_SHIP;
579 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_SHIP;
580 break;
581
582 case VEH_AIRCRAFT:
583 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_PLANE;
584
585 /* Sprites */
586 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_AIRCRAFT;
587 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_AIRCRAFT;
588 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_AIRCRAFT;
589 break;
590 }
591 }
592
593 uint count_width;
594 uint header_width;
595 uint flag_width;
596 uint flag_height;
597
598 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
599 {
600 switch (widget) {
601 case WID_D_MATRIX: {
602 uint min_height = 0;
603
604 if (this->type == VEH_TRAIN) {
605 SetDParamMaxValue(0, 1000, 0, FS_SMALL);
606 SetDParam(1, 1);
607 this->count_width = GetStringBoundingBox(STR_TINY_BLACK_DECIMAL).width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
608 } else {
609 this->count_width = 0;
610 }
611
612 SetDParamMaxDigits(0, this->unitnumber_digits);
613 Dimension unumber = GetStringBoundingBox(STR_BLACK_COMMA);
614 const Sprite *spr = GetSprite(SPR_FLAG_VEH_STOPPED, ST_NORMAL);
615 this->flag_width = UnScaleGUI(spr->width) + WD_FRAMERECT_RIGHT;
616 this->flag_height = UnScaleGUI(spr->height);
617
618 if (this->type == VEH_TRAIN || this->type == VEH_ROAD) {
619 min_height = max<uint>(unumber.height + WD_MATRIX_TOP, UnScaleGUI(spr->height));
620 this->header_width = unumber.width + this->flag_width + WD_FRAMERECT_LEFT;
621 } else {
622 min_height = unumber.height + UnScaleGUI(spr->height) + WD_MATRIX_TOP + WD_PAR_VSEP_NORMAL + WD_MATRIX_BOTTOM;
623 this->header_width = max<uint>(unumber.width, this->flag_width) + WD_FRAMERECT_RIGHT;
624 }
625 int base_width = this->count_width + this->header_width;
626
627 resize->height = max<uint>(GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).height, min_height);
628 if (this->type == VEH_TRAIN) {
629 resize->width = 1;
630 size->width = base_width + 2 * ScaleGUITrad(29); // about 2 parts
631 size->height = resize->height * 6;
632 } else {
633 resize->width = base_width + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_left + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_right;
634 size->width = resize->width * (this->type == VEH_ROAD ? 5 : 3);
635 size->height = resize->height * (this->type == VEH_ROAD ? 5 : 3);
636 }
637 fill->width = resize->width;
638 fill->height = resize->height;
639 break;
640 }
641 }
642 }
643
649 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
650 {
651 this->generate_list = true;
652 }
653
654 virtual void OnPaint()
655 {
656 if (this->generate_list) {
657 /* Generate the vehicle list
658 * It's ok to use the wagon pointers for non-trains as they will be ignored */
659 BuildDepotVehicleList(this->type, this->window_number, &this->vehicle_list, &this->wagon_list);
660 this->generate_list = false;
661 DepotSortList(&this->vehicle_list);
662
663 uint new_unitnumber_digits = GetUnitNumberDigits(this->vehicle_list);
664 if (this->unitnumber_digits != new_unitnumber_digits) {
665 this->unitnumber_digits = new_unitnumber_digits;
666 this->ReInit();
667 }
668 }
669
670 /* determine amount of items for scroller */
671 if (this->type == VEH_TRAIN) {
672 uint max_width = ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
673 for (uint num = 0; num < this->vehicle_list.Length(); num++) {
674 uint width = 0;
675 for (const Train *v = Train::From(this->vehicle_list[num]); v != NULL; v = v->Next()) {
676 width += v->GetDisplayImageWidth();
677 }
678 max_width = max(max_width, width);
679 }
680 /* Always have 1 empty row, so people can change the setting of the train */
681 this->vscroll->SetCount(this->vehicle_list.Length() + this->wagon_list.Length() + 1);
682 this->hscroll->SetCount(max_width);
683 } else {
684 this->vscroll->SetCount(CeilDiv(this->vehicle_list.Length(), this->num_columns));
685 }
686
687 /* Setup disabled buttons. */
688 TileIndex tile = this->window_number;
689 this->SetWidgetsDisabledState(!IsTileOwner(tile, _local_company),
690 WID_D_STOP_ALL,
691 WID_D_START_ALL,
692 WID_D_SELL,
693 WID_D_SELL_CHAIN,
694 WID_D_SELL_ALL,
695 WID_D_BUILD,
696 WID_D_CLONE,
697 WID_D_RENAME,
698 WID_D_AUTOREPLACE,
699 WIDGET_LIST_END);
700
701 this->DrawWidgets();
702 }
703
704 virtual void OnClick(Point pt, int widget, int click_count)
705 {
706 switch (widget) {
707 case WID_D_MATRIX: { // List
708 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
709 this->DepotClick(pt.x - nwi->pos_x, pt.y - nwi->pos_y);
710 break;
711 }
712
713 case WID_D_BUILD: // Build vehicle
714 ResetObjectToPlace();
715 ShowBuildVehicleWindow(this->window_number, this->type);
716 break;
717
718 case WID_D_CLONE: // Clone button
719 this->SetWidgetDirty(WID_D_CLONE);
720 this->ToggleWidgetLoweredState(WID_D_CLONE);
721
722 if (this->IsWidgetLowered(WID_D_CLONE)) {
723 static const CursorID clone_icons[] = {
724 SPR_CURSOR_CLONE_TRAIN, SPR_CURSOR_CLONE_ROADVEH,
725 SPR_CURSOR_CLONE_SHIP, SPR_CURSOR_CLONE_AIRPLANE
726 };
727
728 SetObjectToPlaceWnd(clone_icons[this->type], PAL_NONE, HT_VEHICLE, this);
729 } else {
730 ResetObjectToPlace();
731 }
732 break;
733
734 case WID_D_LOCATION:
735 if (_ctrl_pressed) {
736 ShowExtraViewPortWindow(this->window_number);
737 } else {
738 ScrollMainWindowToTile(this->window_number);
739 }
740 break;
741
742 case WID_D_RENAME: // Rename button
743 SetDParam(0, this->type);
744 SetDParam(1, Depot::GetByTile((TileIndex)this->window_number)->index);
745 ShowQueryString(STR_DEPOT_NAME, STR_DEPOT_RENAME_DEPOT_CAPTION, MAX_LENGTH_DEPOT_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
746 break;
747
748 case WID_D_STOP_ALL:
749 case WID_D_START_ALL: {
750 VehicleListIdentifier vli(VL_DEPOT_LIST, this->type, this->owner);
751 DoCommandP(this->window_number, (widget == WID_D_START_ALL ? (1 << 0) : 0), vli.Pack(), CMD_MASS_START_STOP);
752 break;
753 }
754
755 case WID_D_SELL_ALL:
756 /* Only open the confirmation window if there are anything to sell */
757 if (this->vehicle_list.Length() != 0 || this->wagon_list.Length() != 0) {
758 TileIndex tile = this->window_number;
759 byte vehtype = this->type;
760
761 SetDParam(0, vehtype);
762 SetDParam(1, (vehtype == VEH_AIRCRAFT) ? GetStationIndex(tile) : GetDepotIndex(tile));
763 ShowQuery(
764 STR_DEPOT_CAPTION,
765 STR_DEPOT_SELL_CONFIRMATION_TEXT,
766 this,
767 DepotSellAllConfirmationCallback
768 );
769 }
770 break;
771
772 case WID_D_VEHICLE_LIST:
773 ShowVehicleListWindow(GetTileOwner(this->window_number), this->type, (TileIndex)this->window_number);
774 break;
775
776 case WID_D_AUTOREPLACE:
777 DoCommandP(this->window_number, this->type, 0, CMD_DEPOT_MASS_AUTOREPLACE);
778 break;
779
780 }
781 }
782
783 virtual void OnQueryTextFinished(char *str)
784 {
785 if (str == NULL) return;
786
787 /* Do depot renaming */
788 DoCommandP(0, GetDepotIndex(this->window_number), 0, CMD_RENAME_DEPOT | CMD_MSG(STR_ERROR_CAN_T_RENAME_DEPOT), NULL, str);
789 }
790
791 virtual bool OnRightClick(Point pt, int widget)
792 {
793 if (widget != WID_D_MATRIX) return false;
794
795 GetDepotVehiclePtData gdvp = { NULL, NULL };
796 const Vehicle *v = NULL;
797 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
798 DepotGUIAction mode = this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp);
799
800 if (this->type == VEH_TRAIN) v = gdvp.wagon;
801
802 if (v == NULL || mode != MODE_DRAG_VEHICLE) return false;
803
804 CargoArray capacity, loaded;
805
806 /* Display info for single (articulated) vehicle, or for whole chain starting with selected vehicle */
807 bool whole_chain = (this->type == VEH_TRAIN && _ctrl_pressed);
808
809 /* loop through vehicle chain and collect cargoes */
810 uint num = 0;
811 for (const Vehicle *w = v; w != NULL; w = w->Next()) {
812 if (w->cargo_cap > 0 && w->cargo_type < NUM_CARGO) {
813 capacity[w->cargo_type] += w->cargo_cap;
814 loaded [w->cargo_type] += w->cargo.StoredCount();
815 }
816
817 if (w->type == VEH_TRAIN && !w->HasArticulatedPart()) {
818 num++;
819 if (!whole_chain) break;
820 }
821 }
822
823 /* Build tooltipstring */
824 static char details[1024];
825 details[0] = '\0';
826 char *pos = details;
827
828 for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
829 if (capacity[cargo_type] == 0) continue;
830
831 SetDParam(0, cargo_type); // {CARGO} #1
832 SetDParam(1, loaded[cargo_type]); // {CARGO} #2
833 SetDParam(2, cargo_type); // {SHORTCARGO} #1
834 SetDParam(3, capacity[cargo_type]); // {SHORTCARGO} #2
835 pos = GetString(pos, STR_DEPOT_VEHICLE_TOOLTIP_CARGO, lastof(details));
836 }
837
838 /* Show tooltip window */
839 uint64 args[2];
840 args[0] = (whole_chain ? num : v->engine_type);
841 args[1] = (uint64)(size_t)details;
842 GuiShowTooltips(this, whole_chain ? STR_DEPOT_VEHICLE_TOOLTIP_CHAIN : STR_DEPOT_VEHICLE_TOOLTIP, 2, args, TCC_RIGHT_CLICK);
843
844 return true;
845 }
846
852 virtual bool OnVehicleSelect(const Vehicle *v)
853 {
854 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)) {
855 ResetObjectToPlace();
856 }
857 return true;
858 }
859
860 virtual void OnPlaceObjectAbort()
861 {
862 /* abort clone */
863 this->RaiseWidget(WID_D_CLONE);
864 this->SetWidgetDirty(WID_D_CLONE);
865
866 /* abort drag & drop */
867 this->sel = INVALID_VEHICLE;
868 this->vehicle_over = INVALID_VEHICLE;
869 this->SetWidgetDirty(WID_D_MATRIX);
870 }
871
872 virtual void OnMouseDrag(Point pt, int widget)
873 {
874 if (this->type != VEH_TRAIN || this->sel == INVALID_VEHICLE) return;
875
876 /* A rail vehicle is dragged.. */
877 if (widget != WID_D_MATRIX) { // ..outside of the depot matrix.
878 if (this->vehicle_over != INVALID_VEHICLE) {
879 this->vehicle_over = INVALID_VEHICLE;
880 this->SetWidgetDirty(WID_D_MATRIX);
881 }
882 return;
883 }
884
885 NWidgetBase *matrix = this->GetWidget<NWidgetBase>(widget);
886 const Vehicle *v = NULL;
887 GetDepotVehiclePtData gdvp = {NULL, NULL};
888
889 if (this->GetVehicleFromDepotWndPt(pt.x - matrix->pos_x, pt.y - matrix->pos_y, &v, &gdvp) != MODE_DRAG_VEHICLE) return;
890
891 VehicleID new_vehicle_over = INVALID_VEHICLE;
892 if (gdvp.head != NULL) {
893 if (gdvp.wagon == NULL && gdvp.head->Last()->index != this->sel) { // ..at the end of the train.
894 /* 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
895 * destination inside a train. This head index is then used to indicate that a wagon is inserted at
896 * the end of the train.
897 */
898 new_vehicle_over = gdvp.head->index;
899 } else if (gdvp.wagon != NULL && gdvp.head != gdvp.wagon &&
900 gdvp.wagon->index != this->sel &&
901 gdvp.wagon->Previous()->index != this->sel) { // ..over an existing wagon.
902 new_vehicle_over = gdvp.wagon->index;
903 }
904 }
905
906 if (this->vehicle_over == new_vehicle_over) return;
907
908 this->vehicle_over = new_vehicle_over;
909 this->SetWidgetDirty(widget);
910 }
911
912 virtual void OnDragDrop(Point pt, int widget)
913 {
914 switch (widget) {
915 case WID_D_MATRIX: {
916 const Vehicle *v = NULL;
917 VehicleID sel = this->sel;
918
919 this->sel = INVALID_VEHICLE;
920 this->SetDirty();
921
922 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
923 if (this->type == VEH_TRAIN) {
924 GetDepotVehiclePtData gdvp = { NULL, NULL };
925
926 if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp) == MODE_DRAG_VEHICLE && sel != INVALID_VEHICLE) {
927 if (gdvp.wagon != NULL && gdvp.wagon->index == sel && _ctrl_pressed) {
928 DoCommandP(Vehicle::Get(sel)->tile, Vehicle::Get(sel)->index, true,
929 CMD_REVERSE_TRAIN_DIRECTION | CMD_MSG(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE));
930 } else if (gdvp.wagon == NULL || gdvp.wagon->index != sel) {
931 this->vehicle_over = INVALID_VEHICLE;
932 TrainDepotMoveVehicle(gdvp.wagon, sel, gdvp.head);
933 } else if (gdvp.head != NULL && gdvp.head->IsFrontEngine()) {
934 ShowVehicleViewWindow(gdvp.head);
935 }
936 }
937 } else if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, NULL) == MODE_DRAG_VEHICLE && v != NULL && sel == v->index) {
938 ShowVehicleViewWindow(v);
939 }
940 break;
941 }
942
943 case WID_D_SELL: case WID_D_SELL_CHAIN: {
944 if (this->IsWidgetDisabled(widget)) return;
945 if (this->sel == INVALID_VEHICLE) return;
946
947 this->HandleButtonClick(widget);
948
949 const Vehicle *v = Vehicle::Get(this->sel);
950 this->sel = INVALID_VEHICLE;
951 this->SetDirty();
952
953 int sell_cmd = (v->type == VEH_TRAIN && (widget == WID_D_SELL_CHAIN || _ctrl_pressed)) ? 1 : 0;
954 DoCommandP(v->tile, v->index | sell_cmd << 20 | MAKE_ORDER_BACKUP_FLAG, 0, GetCmdSellVeh(v->type));
955 break;
956 }
957
958 default:
959 this->sel = INVALID_VEHICLE;
960 this->SetDirty();
961 }
962 _cursor.vehchain = false;
963 }
964
965 virtual void OnTimeout()
966 {
967 if (!this->IsWidgetDisabled(WID_D_SELL)) {
968 this->RaiseWidget(WID_D_SELL);
969 this->SetWidgetDirty(WID_D_SELL);
970 }
971 if (this->nested_array[WID_D_SELL] != NULL && !this->IsWidgetDisabled(WID_D_SELL_CHAIN)) {
972 this->RaiseWidget(WID_D_SELL_CHAIN);
973 this->SetWidgetDirty(WID_D_SELL_CHAIN);
974 }
975 }
976
977 virtual void OnResize()
978 {
979 this->vscroll->SetCapacityFromWidget(this, WID_D_MATRIX);
980 NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
981 if (this->type == VEH_TRAIN) {
982 this->hscroll->SetCapacity(nwi->current_x - this->header_width - this->count_width);
983 } else {
984 this->num_columns = nwi->current_x / nwi->resize_x;
985 }
986 }
987
988 virtual EventState OnCTRLStateChange()
989 {
990 if (this->sel != INVALID_VEHICLE) {
991 _cursor.vehchain = _ctrl_pressed;
992 this->SetWidgetDirty(WID_D_MATRIX);
993 return ES_HANDLED;
994 }
995
996 return ES_NOT_HANDLED;
997 }
998 };
999
1000 static void DepotSellAllConfirmationCallback(Window *win, bool confirmed)
1001 {
1002 if (confirmed) {
1003 DepotWindow *w = (DepotWindow*)win;
1004 TileIndex tile = w->window_number;
1005 byte vehtype = w->type;
1006 DoCommandP(tile, vehtype, 0, CMD_DEPOT_SELL_ALL_VEHICLES);
1007 }
1008 }
1009
1015 void ShowDepotWindow(TileIndex tile, VehicleType type)
1016 {
1017 if (BringWindowToFrontById(WC_VEHICLE_DEPOT, tile) != NULL) return;
1018
1019 WindowDesc *desc;
1020 switch (type) {
1021 default: NOT_REACHED();
1022 case VEH_TRAIN: desc = &_train_depot_desc; break;
1023 case VEH_ROAD: desc = &_road_depot_desc; break;
1024 case VEH_SHIP: desc = &_ship_depot_desc; break;
1025 case VEH_AIRCRAFT: desc = &_aircraft_depot_desc; break;
1026 }
1027
1028 new DepotWindow(desc, tile, type);
1029 }
1030
1035 void DeleteDepotHighlightOfVehicle(const Vehicle *v)
1036 {
1037 DepotWindow *w;
1038
1039 /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any depots either
1040 * If that is the case, we can skip looping though the windows and save time
1041 */
1042 if (_special_mouse_mode != WSM_DRAGDROP) return;
1043
1044 w = dynamic_cast<DepotWindow*>(FindWindowById(WC_VEHICLE_DEPOT, v->tile));
1045 if (w != NULL) {
1046 if (w->sel == v->index) ResetObjectToPlace();
1047 }
1048 }