Add non-animated SSSE3 blitter
[openttd/fttd.git] / src / depot_gui.cpp
blobc677d039d9fa638b8a12e27fa7729a4423c7fd60
1 /* $Id$ */
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 */
10 /** @file depot_gui.cpp The GUI for depots. */
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"
32 #include "widgets/depot_widget.h"
34 #include "table/strings.h"
37 * Since all depot window sizes aren't the same, we need to modify sizes a little.
38 * 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.
39 * How long they should be moved and for what window types are controlled in ShowDepotWindow()
42 /** Nested widget definition for train depots. */
43 static const NWidgetPart _nested_train_depot_widgets[] = {
44 NWidget(NWID_HORIZONTAL),
45 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
46 NWidget(WWT_CAPTION, COLOUR_GREY, WID_D_CAPTION), SetDataTip(STR_DEPOT_CAPTION, STR_NULL),
47 NWidget(WWT_SHADEBOX, COLOUR_GREY),
48 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
49 NWidget(WWT_STICKYBOX, COLOUR_GREY),
50 EndContainer(),
51 NWidget(NWID_HORIZONTAL),
52 NWidget(NWID_VERTICAL),
53 NWidget(WWT_MATRIX, COLOUR_GREY, WID_D_MATRIX), SetResize(1, 1), SetScrollbar(WID_D_V_SCROLL),
54 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_H_SCROLL),
55 NWidget(NWID_HSCROLLBAR, COLOUR_GREY, WID_D_H_SCROLL),
56 EndContainer(),
57 EndContainer(),
58 NWidget(NWID_VERTICAL),
59 NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL), SetDataTip(0x0, STR_NULL), SetResize(0, 1), SetFill(0, 1),
60 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_SELL_CHAIN),
61 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),
62 EndContainer(),
63 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_SELL_ALL), SetDataTip(0x0, STR_NULL),
64 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_AUTOREPLACE), SetDataTip(0x0, STR_NULL),
65 EndContainer(),
66 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_D_V_SCROLL),
67 EndContainer(),
68 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
69 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_BUILD), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
70 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_D_CLONE), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
71 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_LOCATION), SetDataTip(STR_BUTTON_LOCATION, STR_NULL), SetFill(1, 1), SetResize(1, 0),
72 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_RENAME), // rename button
73 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_RENAME), SetDataTip(STR_BUTTON_RENAME, STR_DEPOT_RENAME_TOOLTIP), SetFill(1, 1), SetResize(1, 0),
74 EndContainer(),
75 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_VEHICLE_LIST), SetDataTip(0x0, STR_NULL), SetFill(0, 1),
76 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_STOP_ALL), SetDataTip(SPR_FLAG_VEH_STOPPED, STR_NULL), SetFill(0, 1),
77 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_START_ALL), SetDataTip(SPR_FLAG_VEH_RUNNING, STR_NULL), SetFill(0, 1),
78 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
79 EndContainer(),
82 static WindowDesc _train_depot_desc(
83 WDP_AUTO, "depot_train", 362, 123,
84 WC_VEHICLE_DEPOT, WC_NONE,
86 _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
89 static WindowDesc _road_depot_desc(
90 WDP_AUTO, "depot_roadveh", 316, 97,
91 WC_VEHICLE_DEPOT, WC_NONE,
93 _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
96 static WindowDesc _ship_depot_desc(
97 WDP_AUTO, "depot_ship", 306, 99,
98 WC_VEHICLE_DEPOT, WC_NONE,
100 _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
103 static WindowDesc _aircraft_depot_desc(
104 WDP_AUTO, "depot_aircraft", 332, 99,
105 WC_VEHICLE_DEPOT, WC_NONE,
107 _nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
110 extern void DepotSortList(VehicleList *list);
113 * This is the Callback method after the cloning attempt of a vehicle
114 * @param result the result of the cloning command
115 * @param tile unused
116 * @param p1 unused
117 * @param p2 unused
119 void CcCloneVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
121 if (result.Failed()) return;
123 const Vehicle *v = Vehicle::Get(_new_vehicle_id);
125 ShowVehicleViewWindow(v);
128 static void TrainDepotMoveVehicle(const Vehicle *wagon, VehicleID sel, const Vehicle *head)
130 const Vehicle *v = Vehicle::Get(sel);
132 if (v == wagon) return;
134 if (wagon == NULL) {
135 if (head != NULL) wagon = head->Last();
136 } else {
137 wagon = wagon->Previous();
138 if (wagon == NULL) return;
141 if (wagon == v) return;
143 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 static VehicleCellSize _base_block_sizes_depot[VEH_COMPANY_END]; ///< Cell size for vehicle images in the depot view.
147 static VehicleCellSize _base_block_sizes_purchase[VEH_COMPANY_END]; ///< Cell size for vehicle images in the purchase list.
150 * Get the GUI cell size for a vehicle image.
151 * @param type Vehicle type to get the size for.
152 * @param image_type Image type to get size for.
153 * @pre image_type == EIT_IN_DEPOT || image_type == EIT_PURCHASE
154 * @return Cell dimensions for the vehicle and image type.
156 VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type)
158 switch (image_type) {
159 case EIT_IN_DEPOT: return _base_block_sizes_depot[type];
160 case EIT_PURCHASE: return _base_block_sizes_purchase[type];
161 default: NOT_REACHED();
165 static void InitBlocksizeForVehicles(VehicleType type, EngineImageType image_type)
167 int max_extend_left = 0;
168 int max_extend_right = 0;
169 uint max_height = 0;
171 const Engine *e;
172 FOR_ALL_ENGINES_OF_TYPE(e, type) {
173 if (!e->IsEnabled()) continue;
175 EngineID eid = e->index;
176 uint x, y;
177 int x_offs, y_offs;
179 switch (type) {
180 default: NOT_REACHED();
181 case VEH_TRAIN: GetTrainSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
182 case VEH_ROAD: GetRoadVehSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
183 case VEH_SHIP: GetShipSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
184 case VEH_AIRCRAFT: GetAircraftSpriteSize(eid, x, y, x_offs, y_offs, image_type); break;
186 if (y > max_height) max_height = y;
187 if (-x_offs > max_extend_left) max_extend_left = -x_offs;
188 if ((int)x + x_offs > max_extend_right) max_extend_right = x + x_offs;
191 switch (image_type) {
192 case EIT_IN_DEPOT:
193 _base_block_sizes_depot[type].height = max(GetVehicleHeight(type), max_height);
194 _base_block_sizes_depot[type].extend_left = Clamp(max_extend_left, 16, 98);
195 _base_block_sizes_depot[type].extend_right = Clamp(max_extend_right, 16, 98);
196 break;
197 case EIT_PURCHASE:
198 _base_block_sizes_purchase[type].height = max(GetVehicleHeight(type), max_height);
199 _base_block_sizes_purchase[type].extend_left = Clamp(max_extend_left, 16, 98);
200 _base_block_sizes_purchase[type].extend_right = Clamp(max_extend_right, 16, 98);
201 break;
203 default: NOT_REACHED();
208 * Set the size of the blocks in the window so we can be sure that they are big enough for the vehicle sprites in the current game.
209 * @note Calling this function once for each game is enough.
211 void InitDepotWindowBlockSizes()
213 for (VehicleType vt = VEH_BEGIN; vt < VEH_COMPANY_END; vt++) {
214 InitBlocksizeForVehicles(vt, EIT_IN_DEPOT);
215 InitBlocksizeForVehicles(vt, EIT_PURCHASE);
219 static void DepotSellAllConfirmationCallback(Window *w, bool confirmed);
220 const Sprite *GetAircraftSprite(EngineID engine);
222 struct DepotWindow : Window {
223 VehicleID sel;
224 VehicleID vehicle_over; ///< Rail vehicle over which another one is dragged, \c INVALID_VEHICLE if none.
225 VehicleType type;
226 bool generate_list;
227 VehicleList vehicle_list;
228 VehicleList wagon_list;
229 uint num_columns; ///< Number of columns.
230 Scrollbar *hscroll; ///< Only for trains.
231 Scrollbar *vscroll;
233 DepotWindow(WindowDesc *desc, TileIndex tile, VehicleType type) : Window(desc)
235 assert(IsCompanyBuildableVehicleType(type)); // ensure that we make the call with a valid type
237 this->sel = INVALID_VEHICLE;
238 this->vehicle_over = INVALID_VEHICLE;
239 this->generate_list = true;
240 this->type = type;
241 this->num_columns = 1; // for non-trains this gets set in FinishInitNested()
243 this->CreateNestedTree();
244 this->hscroll = (this->type == VEH_TRAIN ? this->GetScrollbar(WID_D_H_SCROLL) : NULL);
245 this->vscroll = this->GetScrollbar(WID_D_V_SCROLL);
246 /* Don't show 'rename button' of aircraft hangar */
247 this->GetWidget<NWidgetStacked>(WID_D_SHOW_RENAME)->SetDisplayedPlane(type == VEH_AIRCRAFT ? SZSP_NONE : 0);
248 /* Only train depots have a horizontal scrollbar and a 'sell chain' button */
249 if (type == VEH_TRAIN) this->GetWidget<NWidgetCore>(WID_D_MATRIX)->widget_data = 1 << MAT_COL_START;
250 this->GetWidget<NWidgetStacked>(WID_D_SHOW_H_SCROLL)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_HORIZONTAL);
251 this->GetWidget<NWidgetStacked>(WID_D_SHOW_SELL_CHAIN)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_NONE);
252 this->SetupWidgetData(type);
253 this->FinishInitNested(tile);
255 this->owner = GetTileOwner(tile);
256 OrderBackup::Reset();
259 ~DepotWindow()
261 DeleteWindowById(WC_BUILD_VEHICLE, this->window_number);
262 OrderBackup::Reset(this->window_number);
266 * Draw a vehicle in the depot window in the box with the top left corner at x,y.
267 * @param v Vehicle to draw.
268 * @param left Left side of the box to draw in.
269 * @param right Right side of the box to draw in.
270 * @param y Top of the box to draw in.
272 void DrawVehicleInDepot(const Vehicle *v, int left, int right, int y) const
274 bool free_wagon = false;
275 int sprite_y = y + (this->resize.step_height - GetVehicleHeight(v->type)) / 2;
277 bool rtl = _current_text_dir == TD_RTL;
278 int image_left = rtl ? left + this->count_width : left + this->header_width;
279 int image_right = rtl ? right - this->header_width : right - this->count_width;
281 switch (v->type) {
282 case VEH_TRAIN: {
283 const Train *u = Train::From(v);
284 free_wagon = u->IsFreeWagon();
286 uint x_space = free_wagon ? TRAININFO_DEFAULT_VEHICLE_WIDTH : 0;
287 DrawTrainImage(u, image_left + (rtl ? 0 : x_space), image_right - (rtl ? x_space : 0), sprite_y - 1,
288 this->sel, EIT_IN_DEPOT, free_wagon ? 0 : this->hscroll->GetPosition(), this->vehicle_over);
290 /* Length of consist in tiles with 1 fractional digit (rounded up) */
291 SetDParam(0, CeilDiv(u->gcache.cached_total_length * 10, TILE_SIZE));
292 SetDParam(1, 1);
293 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
294 break;
297 case VEH_ROAD: DrawRoadVehImage( v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
298 case VEH_SHIP: DrawShipImage( v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
299 case VEH_AIRCRAFT: {
300 const Sprite *spr = GetSprite(v->GetImage(DIR_W, EIT_IN_DEPOT), ST_NORMAL);
301 DrawAircraftImage(v, image_left, image_right,
302 y + max(UnScaleByZoom(spr->height, ZOOM_LVL_GUI) + UnScaleByZoom(spr->y_offs, ZOOM_LVL_GUI) - 14, 0), // tall sprites needs an y offset
303 this->sel, EIT_IN_DEPOT);
304 break;
306 default: NOT_REACHED();
309 uint diff_x, diff_y;
310 if (v->IsGroundVehicle()) {
311 /* Arrange unitnumber and flag horizontally */
312 diff_x = this->flag_width + WD_FRAMERECT_LEFT;
313 diff_y = (this->resize.step_height - this->flag_height) / 2 - 2;
314 } else {
315 /* Arrange unitnumber and flag vertically */
316 diff_x = WD_FRAMERECT_LEFT;
317 diff_y = FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
319 int text_left = rtl ? right - this->header_width - 1 : left + diff_x;
320 int text_right = rtl ? right - diff_x : left + this->header_width - 1;
322 if (free_wagon) {
323 DrawString(text_left, text_right, y + 2, STR_DEPOT_NO_ENGINE);
324 } else {
325 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 SetDParam(0, v->unitnumber);
328 DrawString(text_left, text_right, y + 2, (uint16)(v->max_age - DAYS_IN_LEAP_YEAR) >= v->age ? STR_BLACK_COMMA : STR_RED_COMMA);
332 void DrawWidget(const Rect &r, int widget) const
334 if (widget != WID_D_MATRIX) return;
336 bool rtl = _current_text_dir == TD_RTL;
338 /* Set the row and number of boxes in each row based on the number of boxes drawn in the matrix */
339 const NWidgetCore *wid = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
340 uint16 rows_in_display = wid->current_y / wid->resize_y;
342 uint16 num = this->vscroll->GetPosition() * this->num_columns;
343 int maxval = min(this->vehicle_list.Length(), num + (rows_in_display * this->num_columns));
344 int y;
345 for (y = r.top + 1; num < maxval; y += this->resize.step_height) { // Draw the rows
346 for (byte i = 0; i < this->num_columns && num < maxval; i++, num++) {
347 /* Draw all vehicles in the current row */
348 const Vehicle *v = this->vehicle_list[num];
349 if (this->num_columns == 1) {
350 this->DrawVehicleInDepot(v, r.left, r.right, y);
351 } else {
352 int x = r.left + (rtl ? (this->num_columns - i - 1) : i) * this->resize.step_width;
353 this->DrawVehicleInDepot(v, x, x + this->resize.step_width - 1, y);
358 maxval = min(this->vehicle_list.Length() + this->wagon_list.Length(), (this->vscroll->GetPosition() * this->num_columns) + (rows_in_display * this->num_columns));
360 /* Draw the train wagons without an engine in front. */
361 for (; num < maxval; num++, y += this->resize.step_height) {
362 const Vehicle *v = this->wagon_list[num - this->vehicle_list.Length()];
363 this->DrawVehicleInDepot(v, r.left, r.right, y);
367 void SetStringParameters(int widget) const
369 if (widget != WID_D_CAPTION) return;
371 /* locate the depot struct */
372 TileIndex tile = this->window_number;
373 SetDParam(0, this->type);
374 SetDParam(1, (this->type == VEH_AIRCRAFT) ? GetStationIndex(tile) : GetDepotIndex(tile));
377 struct GetDepotVehiclePtData {
378 const Vehicle *head;
379 const Vehicle *wagon;
382 enum DepotGUIAction {
383 MODE_ERROR,
384 MODE_DRAG_VEHICLE,
385 MODE_SHOW_VEHICLE,
386 MODE_START_STOP,
389 DepotGUIAction GetVehicleFromDepotWndPt(int x, int y, const Vehicle **veh, GetDepotVehiclePtData *d) const
391 const NWidgetCore *matrix_widget = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
392 /* In case of RTL the widgets are swapped as a whole */
393 if (_current_text_dir == TD_RTL) x = matrix_widget->current_x - x;
395 uint xt = 0, xm = 0, ym = 0;
396 if (this->type == VEH_TRAIN) {
397 xm = x;
398 } else {
399 xt = x / this->resize.step_width;
400 xm = x % this->resize.step_width;
401 if (xt >= this->num_columns) return MODE_ERROR;
403 ym = y % this->resize.step_height;
405 uint row = y / this->resize.step_height;
406 if (row >= this->vscroll->GetCapacity()) return MODE_ERROR;
408 uint pos = ((row + this->vscroll->GetPosition()) * this->num_columns) + xt;
410 if (this->vehicle_list.Length() + this->wagon_list.Length() <= pos) {
411 /* Clicking on 'line' / 'block' without a vehicle */
412 if (this->type == VEH_TRAIN) {
413 /* End the dragging */
414 d->head = NULL;
415 d->wagon = NULL;
416 return MODE_DRAG_VEHICLE;
417 } else {
418 return MODE_ERROR; // empty block, so no vehicle is selected
422 bool wagon = false;
423 if (this->vehicle_list.Length() > pos) {
424 *veh = this->vehicle_list[pos];
425 /* Skip vehicles that are scrolled off the list */
426 if (this->type == VEH_TRAIN) x += this->hscroll->GetPosition();
427 } else {
428 pos -= this->vehicle_list.Length();
429 *veh = this->wagon_list[pos];
430 /* free wagons don't have an initial loco. */
431 x -= VEHICLEINFO_FULL_VEHICLE_WIDTH;
432 wagon = true;
435 const Train *v = NULL;
436 if (this->type == VEH_TRAIN) {
437 v = Train::From(*veh);
438 d->head = d->wagon = v;
441 if (xm <= this->header_width) {
442 switch (this->type) {
443 case VEH_TRAIN:
444 if (wagon) return MODE_ERROR;
445 /* FALL THROUGH */
446 case VEH_ROAD:
447 if (xm <= this->flag_width) return MODE_START_STOP;
448 break;
450 case VEH_SHIP:
451 case VEH_AIRCRAFT:
452 if (xm <= this->flag_width && ym >= (uint)(FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL)) return MODE_START_STOP;
453 break;
455 default: NOT_REACHED();
457 return MODE_SHOW_VEHICLE;
460 if (this->type != VEH_TRAIN) return MODE_DRAG_VEHICLE;
462 /* Clicking on the counter */
463 if (xm >= matrix_widget->current_x - this->count_width) return wagon ? MODE_ERROR : MODE_SHOW_VEHICLE;
465 /* Account for the header */
466 x -= this->header_width;
468 /* find the vehicle in this row that was clicked */
469 for (; v != NULL; v = v->Next()) {
470 x -= v->GetDisplayImageWidth();
471 if (x < 0) break;
474 d->wagon = (v != NULL ? v->GetFirstEnginePart() : NULL);
476 return MODE_DRAG_VEHICLE;
480 * Handle click in the depot matrix.
481 * @param x Horizontal position in the matrix widget in pixels.
482 * @param y Vertical position in the matrix widget in pixels.
484 void DepotClick(int x, int y)
486 GetDepotVehiclePtData gdvp = { NULL, NULL };
487 const Vehicle *v = NULL;
488 DepotGUIAction mode = this->GetVehicleFromDepotWndPt(x, y, &v, &gdvp);
490 if (this->type == VEH_TRAIN) v = gdvp.wagon;
492 switch (mode) {
493 case MODE_ERROR: // invalid
494 return;
496 case MODE_DRAG_VEHICLE: { // start dragging of vehicle
497 if (v != NULL && VehicleClicked(v)) return;
499 VehicleID sel = this->sel;
501 if (this->type == VEH_TRAIN && sel != INVALID_VEHICLE) {
502 this->sel = INVALID_VEHICLE;
503 TrainDepotMoveVehicle(v, sel, gdvp.head);
504 } else if (v != NULL) {
505 bool rtl = _current_text_dir == TD_RTL;
506 int image = v->GetImage(rtl ? DIR_E : DIR_W, EIT_IN_DEPOT);
507 SetObjectToPlaceWnd(image, GetVehiclePalette(v), HT_DRAG, this);
509 this->sel = v->index;
510 this->SetDirty();
512 _cursor.short_vehicle_offset = v->IsGroundVehicle() ? (16 - v->GetGroundVehicleCache()->cached_veh_length * 2) * (rtl ? -1 : 1) : 0;
513 _cursor.vehchain = _ctrl_pressed;
515 break;
518 case MODE_SHOW_VEHICLE: // show info window
519 ShowVehicleViewWindow(v);
520 break;
522 case MODE_START_STOP: // click start/stop flag
523 StartStopVehicle(v, false);
524 break;
526 default: NOT_REACHED();
531 * Function to set up vehicle specific widgets (mainly sprites and strings).
532 * Only use this function to if the widget is used for several vehicle types and each has
533 * different text/sprites. If the widget is only used for a single vehicle type, or the same
534 * text/sprites are used every time, use the nested widget array to initialize the widget.
536 void SetupWidgetData(VehicleType type)
538 this->GetWidget<NWidgetCore>(WID_D_STOP_ALL)->tool_tip = STR_DEPOT_MASS_STOP_DEPOT_TRAIN_TOOLTIP + type;
539 this->GetWidget<NWidgetCore>(WID_D_START_ALL)->tool_tip = STR_DEPOT_MASS_START_DEPOT_TRAIN_TOOLTIP + type;
540 this->GetWidget<NWidgetCore>(WID_D_SELL)->tool_tip = STR_DEPOT_TRAIN_SELL_TOOLTIP + type;
541 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->tool_tip = STR_DEPOT_SELL_ALL_BUTTON_TRAIN_TOOLTIP + type;
543 this->GetWidget<NWidgetCore>(WID_D_BUILD)->SetDataTip(STR_DEPOT_TRAIN_NEW_VEHICLES_BUTTON + type, STR_DEPOT_TRAIN_NEW_VEHICLES_TOOLTIP + type);
544 this->GetWidget<NWidgetCore>(WID_D_CLONE)->SetDataTip(STR_DEPOT_CLONE_TRAIN + type, STR_DEPOT_CLONE_TRAIN_DEPOT_INFO + type);
546 this->GetWidget<NWidgetCore>(WID_D_LOCATION)->tool_tip = STR_DEPOT_TRAIN_LOCATION_TOOLTIP + type;
547 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->tool_tip = STR_DEPOT_VEHICLE_ORDER_LIST_TRAIN_TOOLTIP + type;
548 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->tool_tip = STR_DEPOT_AUTOREPLACE_TRAIN_TOOLTIP + type;
549 this->GetWidget<NWidgetCore>(WID_D_MATRIX)->tool_tip = STR_DEPOT_TRAIN_LIST_TOOLTIP + this->type;
551 switch (type) {
552 default: NOT_REACHED();
554 case VEH_TRAIN:
555 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_TRAIN;
557 /* Sprites */
558 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_TRAIN;
559 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_TRAIN;
560 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_TRAIN;
561 break;
563 case VEH_ROAD:
564 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_LORRY;
566 /* Sprites */
567 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_ROADVEH;
568 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_ROADVEH;
569 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_ROADVEH;
570 break;
572 case VEH_SHIP:
573 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_SHIP;
575 /* Sprites */
576 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_SHIP;
577 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_SHIP;
578 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_SHIP;
579 break;
581 case VEH_AIRCRAFT:
582 this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_PLANE;
584 /* Sprites */
585 this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data = SPR_SELL_AIRCRAFT;
586 this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data = SPR_SELL_ALL_AIRCRAFT;
587 this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_AIRCRAFT;
588 break;
592 uint count_width;
593 uint header_width;
594 uint flag_width;
595 uint flag_height;
597 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
599 switch (widget) {
600 case WID_D_MATRIX: {
601 uint min_height = 0;
603 if (this->type == VEH_TRAIN) {
604 SetDParamMaxValue(0, 1000, 0, FS_SMALL);
605 SetDParam(1, 1);
606 this->count_width = GetStringBoundingBox(STR_TINY_BLACK_DECIMAL).width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
607 } else {
608 this->count_width = 0;
611 Dimension unumber = { GetDigitWidth() * 4, FONT_HEIGHT_NORMAL };
612 const Sprite *spr = GetSprite(SPR_FLAG_VEH_STOPPED, ST_NORMAL);
613 this->flag_width = UnScaleByZoom(spr->width, ZOOM_LVL_GUI) + WD_FRAMERECT_RIGHT;
614 this->flag_height = UnScaleByZoom(spr->height, ZOOM_LVL_GUI);
616 if (this->type == VEH_TRAIN || this->type == VEH_ROAD) {
617 min_height = max<uint>(unumber.height + WD_MATRIX_TOP, UnScaleByZoom(spr->height, ZOOM_LVL_GUI));
618 this->header_width = unumber.width + this->flag_width + WD_FRAMERECT_LEFT;
619 } else {
620 min_height = unumber.height + UnScaleByZoom(spr->height, ZOOM_LVL_GUI) + WD_MATRIX_TOP + WD_PAR_VSEP_NORMAL + WD_MATRIX_BOTTOM;
621 this->header_width = max<uint>(unumber.width, this->flag_width) + WD_FRAMERECT_RIGHT;
623 int base_width = this->count_width + this->header_width;
625 resize->height = max<uint>(GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).height, min_height);
626 if (this->type == VEH_TRAIN) {
627 resize->width = 1;
628 size->width = base_width + 2 * 29; // about 2 parts
629 size->height = resize->height * 6;
630 } else {
631 resize->width = base_width + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_left + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_right;
632 size->width = resize->width * (this->type == VEH_ROAD ? 5 : 3);
633 size->height = resize->height * (this->type == VEH_ROAD ? 5 : 3);
635 fill->width = resize->width;
636 fill->height = resize->height;
637 break;
643 * Some data on this window has become invalid.
644 * @param data Information about the changed data.
645 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
647 virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
649 this->generate_list = true;
652 virtual void OnPaint()
654 if (this->generate_list) {
655 /* Generate the vehicle list
656 * It's ok to use the wagon pointers for non-trains as they will be ignored */
657 BuildDepotVehicleList(this->type, this->window_number, &this->vehicle_list, &this->wagon_list);
658 this->generate_list = false;
659 DepotSortList(&this->vehicle_list);
662 /* determine amount of items for scroller */
663 if (this->type == VEH_TRAIN) {
664 uint max_width = VEHICLEINFO_FULL_VEHICLE_WIDTH;
665 for (uint num = 0; num < this->vehicle_list.Length(); num++) {
666 uint width = 0;
667 for (const Train *v = Train::From(this->vehicle_list[num]); v != NULL; v = v->Next()) {
668 width += v->GetDisplayImageWidth();
670 max_width = max(max_width, width);
672 /* Always have 1 empty row, so people can change the setting of the train */
673 this->vscroll->SetCount(this->vehicle_list.Length() + this->wagon_list.Length() + 1);
674 this->hscroll->SetCount(max_width);
675 } else {
676 this->vscroll->SetCount(CeilDiv(this->vehicle_list.Length(), this->num_columns));
679 /* Setup disabled buttons. */
680 TileIndex tile = this->window_number;
681 this->SetWidgetsDisabledState(!IsTileOwner(tile, _local_company),
682 WID_D_STOP_ALL,
683 WID_D_START_ALL,
684 WID_D_SELL,
685 WID_D_SELL_CHAIN,
686 WID_D_SELL_ALL,
687 WID_D_BUILD,
688 WID_D_CLONE,
689 WID_D_RENAME,
690 WID_D_AUTOREPLACE,
691 WIDGET_LIST_END);
693 this->DrawWidgets();
696 virtual void OnClick(Point pt, int widget, int click_count)
698 switch (widget) {
699 case WID_D_MATRIX: { // List
700 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
701 this->DepotClick(pt.x - nwi->pos_x, pt.y - nwi->pos_y);
702 break;
705 case WID_D_BUILD: // Build vehicle
706 ResetObjectToPlace();
707 ShowBuildVehicleWindow(this->window_number, this->type);
708 break;
710 case WID_D_CLONE: // Clone button
711 this->SetWidgetDirty(WID_D_CLONE);
712 this->ToggleWidgetLoweredState(WID_D_CLONE);
714 if (this->IsWidgetLowered(WID_D_CLONE)) {
715 static const CursorID clone_icons[] = {
716 SPR_CURSOR_CLONE_TRAIN, SPR_CURSOR_CLONE_ROADVEH,
717 SPR_CURSOR_CLONE_SHIP, SPR_CURSOR_CLONE_AIRPLANE
720 SetObjectToPlaceWnd(clone_icons[this->type], PAL_NONE, HT_VEHICLE, this);
721 } else {
722 ResetObjectToPlace();
724 break;
726 case WID_D_LOCATION:
727 if (_ctrl_pressed) {
728 ShowExtraViewPortWindow(this->window_number);
729 } else {
730 ScrollMainWindowToTile(this->window_number);
732 break;
734 case WID_D_RENAME: // Rename button
735 SetDParam(0, this->type);
736 SetDParam(1, Depot::GetByTile((TileIndex)this->window_number)->index);
737 ShowQueryString(STR_DEPOT_NAME, STR_DEPOT_RENAME_DEPOT_CAPTION, MAX_LENGTH_DEPOT_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
738 break;
740 case WID_D_STOP_ALL:
741 case WID_D_START_ALL: {
742 VehicleListIdentifier vli(VL_DEPOT_LIST, this->type, this->owner);
743 DoCommandP(this->window_number, (widget == WID_D_START_ALL ? (1 << 0) : 0), vli.Pack(), CMD_MASS_START_STOP);
744 break;
747 case WID_D_SELL_ALL:
748 /* Only open the confirmation window if there are anything to sell */
749 if (this->vehicle_list.Length() != 0 || this->wagon_list.Length() != 0) {
750 TileIndex tile = this->window_number;
751 byte vehtype = this->type;
753 SetDParam(0, vehtype);
754 SetDParam(1, (vehtype == VEH_AIRCRAFT) ? GetStationIndex(tile) : GetDepotIndex(tile));
755 ShowQuery(
756 STR_DEPOT_CAPTION,
757 STR_DEPOT_SELL_CONFIRMATION_TEXT,
758 this,
759 DepotSellAllConfirmationCallback
762 break;
764 case WID_D_VEHICLE_LIST:
765 ShowVehicleListWindow(GetTileOwner(this->window_number), this->type, (TileIndex)this->window_number);
766 break;
768 case WID_D_AUTOREPLACE:
769 DoCommandP(this->window_number, this->type, 0, CMD_DEPOT_MASS_AUTOREPLACE);
770 break;
775 virtual void OnQueryTextFinished(char *str)
777 if (str == NULL) return;
779 /* Do depot renaming */
780 DoCommandP(0, GetDepotIndex(this->window_number), 0, CMD_RENAME_DEPOT | CMD_MSG(STR_ERROR_CAN_T_RENAME_DEPOT), NULL, str);
783 virtual bool OnRightClick(Point pt, int widget)
785 if (widget != WID_D_MATRIX) return false;
787 GetDepotVehiclePtData gdvp = { NULL, NULL };
788 const Vehicle *v = NULL;
789 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
790 DepotGUIAction mode = this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp);
792 if (this->type == VEH_TRAIN) v = gdvp.wagon;
794 if (v == NULL || mode != MODE_DRAG_VEHICLE) return false;
796 CargoArray capacity, loaded;
798 /* Display info for single (articulated) vehicle, or for whole chain starting with selected vehicle */
799 bool whole_chain = (this->type == VEH_TRAIN && _ctrl_pressed);
801 /* loop through vehicle chain and collect cargoes */
802 uint num = 0;
803 for (const Vehicle *w = v; w != NULL; w = w->Next()) {
804 if (w->cargo_cap > 0 && w->cargo_type < NUM_CARGO) {
805 capacity[w->cargo_type] += w->cargo_cap;
806 loaded [w->cargo_type] += w->cargo.StoredCount();
809 if (w->type == VEH_TRAIN && !w->HasArticulatedPart()) {
810 num++;
811 if (!whole_chain) break;
815 /* Build tooltipstring */
816 static char details[1024];
817 details[0] = '\0';
818 char *pos = details;
820 for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
821 if (capacity[cargo_type] == 0) continue;
823 SetDParam(0, cargo_type); // {CARGO} #1
824 SetDParam(1, loaded[cargo_type]); // {CARGO} #2
825 SetDParam(2, cargo_type); // {SHORTCARGO} #1
826 SetDParam(3, capacity[cargo_type]); // {SHORTCARGO} #2
827 pos = GetString(pos, STR_DEPOT_VEHICLE_TOOLTIP_CARGO, lastof(details));
830 /* Show tooltip window */
831 uint64 args[2];
832 args[0] = (whole_chain ? num : v->engine_type);
833 args[1] = (uint64)(size_t)details;
834 GuiShowTooltips(this, whole_chain ? STR_DEPOT_VEHICLE_TOOLTIP_CHAIN : STR_DEPOT_VEHICLE_TOOLTIP, 2, args, TCC_RIGHT_CLICK);
836 return true;
840 * Clones a vehicle
841 * @param v the original vehicle to clone
842 * @return Always true.
844 virtual bool OnVehicleSelect(const Vehicle *v)
846 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)) {
847 ResetObjectToPlace();
849 return true;
852 virtual void OnPlaceObjectAbort()
854 /* abort clone */
855 this->RaiseWidget(WID_D_CLONE);
856 this->SetWidgetDirty(WID_D_CLONE);
858 /* abort drag & drop */
859 this->sel = INVALID_VEHICLE;
860 this->vehicle_over = INVALID_VEHICLE;
861 this->SetWidgetDirty(WID_D_MATRIX);
864 virtual void OnMouseDrag(Point pt, int widget)
866 if (this->type != VEH_TRAIN || this->sel == INVALID_VEHICLE) return;
868 /* A rail vehicle is dragged.. */
869 if (widget != WID_D_MATRIX) { // ..outside of the depot matrix.
870 if (this->vehicle_over != INVALID_VEHICLE) {
871 this->vehicle_over = INVALID_VEHICLE;
872 this->SetWidgetDirty(WID_D_MATRIX);
874 return;
877 NWidgetBase *matrix = this->GetWidget<NWidgetBase>(widget);
878 const Vehicle *v = NULL;
879 GetDepotVehiclePtData gdvp = {NULL, NULL};
881 if (this->GetVehicleFromDepotWndPt(pt.x - matrix->pos_x, pt.y - matrix->pos_y, &v, &gdvp) != MODE_DRAG_VEHICLE) return;
883 VehicleID new_vehicle_over = INVALID_VEHICLE;
884 if (gdvp.head != NULL) {
885 if (gdvp.wagon == NULL && gdvp.head->Last()->index != this->sel) { // ..at the end of the train.
886 /* 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
887 * destination inside a train. This head index is then used to indicate that a wagon is inserted at
888 * the end of the train.
890 new_vehicle_over = gdvp.head->index;
891 } else if (gdvp.wagon != NULL && gdvp.head != gdvp.wagon &&
892 gdvp.wagon->index != this->sel &&
893 gdvp.wagon->Previous()->index != this->sel) { // ..over an existing wagon.
894 new_vehicle_over = gdvp.wagon->index;
898 if (this->vehicle_over == new_vehicle_over) return;
900 this->vehicle_over = new_vehicle_over;
901 this->SetWidgetDirty(widget);
904 virtual void OnDragDrop(Point pt, int widget)
906 switch (widget) {
907 case WID_D_MATRIX: {
908 const Vehicle *v = NULL;
909 VehicleID sel = this->sel;
911 this->sel = INVALID_VEHICLE;
912 this->SetDirty();
914 NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
915 if (this->type == VEH_TRAIN) {
916 GetDepotVehiclePtData gdvp = { NULL, NULL };
918 if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp) == MODE_DRAG_VEHICLE && sel != INVALID_VEHICLE) {
919 if (gdvp.wagon != NULL && gdvp.wagon->index == sel && _ctrl_pressed) {
920 DoCommandP(Vehicle::Get(sel)->tile, Vehicle::Get(sel)->index, true,
921 CMD_REVERSE_TRAIN_DIRECTION | CMD_MSG(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE));
922 } else if (gdvp.wagon == NULL || gdvp.wagon->index != sel) {
923 this->vehicle_over = INVALID_VEHICLE;
924 TrainDepotMoveVehicle(gdvp.wagon, sel, gdvp.head);
925 } else if (gdvp.head != NULL && gdvp.head->IsFrontEngine()) {
926 ShowVehicleViewWindow(gdvp.head);
929 } else if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, NULL) == MODE_DRAG_VEHICLE && v != NULL && sel == v->index) {
930 ShowVehicleViewWindow(v);
932 break;
935 case WID_D_SELL: case WID_D_SELL_CHAIN: {
936 if (this->IsWidgetDisabled(widget)) return;
937 if (this->sel == INVALID_VEHICLE) return;
939 this->HandleButtonClick(widget);
941 const Vehicle *v = Vehicle::Get(this->sel);
942 this->sel = INVALID_VEHICLE;
943 this->SetDirty();
945 int sell_cmd = (v->type == VEH_TRAIN && (widget == WID_D_SELL_CHAIN || _ctrl_pressed)) ? 1 : 0;
946 DoCommandP(v->tile, v->index | sell_cmd << 20 | MAKE_ORDER_BACKUP_FLAG, 0, GetCmdSellVeh(v->type));
947 break;
950 default:
951 this->sel = INVALID_VEHICLE;
952 this->SetDirty();
954 _cursor.vehchain = false;
957 virtual void OnTimeout()
959 if (!this->IsWidgetDisabled(WID_D_SELL)) {
960 this->RaiseWidget(WID_D_SELL);
961 this->SetWidgetDirty(WID_D_SELL);
963 if (this->nested_array[WID_D_SELL] != NULL && !this->IsWidgetDisabled(WID_D_SELL_CHAIN)) {
964 this->RaiseWidget(WID_D_SELL_CHAIN);
965 this->SetWidgetDirty(WID_D_SELL_CHAIN);
969 virtual void OnResize()
971 this->vscroll->SetCapacityFromWidget(this, WID_D_MATRIX);
972 NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
973 if (this->type == VEH_TRAIN) {
974 this->hscroll->SetCapacity(nwi->current_x - this->header_width - this->count_width);
975 } else {
976 this->num_columns = nwi->current_x / nwi->resize_x;
980 virtual EventState OnCTRLStateChange()
982 if (this->sel != INVALID_VEHICLE) {
983 _cursor.vehchain = _ctrl_pressed;
984 this->SetWidgetDirty(WID_D_MATRIX);
985 return ES_HANDLED;
988 return ES_NOT_HANDLED;
992 static void DepotSellAllConfirmationCallback(Window *win, bool confirmed)
994 if (confirmed) {
995 DepotWindow *w = (DepotWindow*)win;
996 TileIndex tile = w->window_number;
997 byte vehtype = w->type;
998 DoCommandP(tile, vehtype, 0, CMD_DEPOT_SELL_ALL_VEHICLES);
1003 * Opens a depot window
1004 * @param tile The tile where the depot/hangar is located
1005 * @param type The type of vehicles in the depot
1007 void ShowDepotWindow(TileIndex tile, VehicleType type)
1009 if (BringWindowToFrontById(WC_VEHICLE_DEPOT, tile) != NULL) return;
1011 WindowDesc *desc;
1012 switch (type) {
1013 default: NOT_REACHED();
1014 case VEH_TRAIN: desc = &_train_depot_desc; break;
1015 case VEH_ROAD: desc = &_road_depot_desc; break;
1016 case VEH_SHIP: desc = &_ship_depot_desc; break;
1017 case VEH_AIRCRAFT: desc = &_aircraft_depot_desc; break;
1020 new DepotWindow(desc, tile, type);
1024 * Removes the highlight of a vehicle in a depot window
1025 * @param *v Vehicle to remove all highlights from
1027 void DeleteDepotHighlightOfVehicle(const Vehicle *v)
1029 DepotWindow *w;
1031 /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any depots either
1032 * If that is the case, we can skip looping though the windows and save time
1034 if (_special_mouse_mode != WSM_DRAGDROP) return;
1036 w = dynamic_cast<DepotWindow*>(FindWindowById(WC_VEHICLE_DEPOT, v->tile));
1037 if (w != NULL) {
1038 if (w->sel == v->index) ResetObjectToPlace();