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/>.
10 /** @file depot_gui.cpp The GUI for depots. */
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
),
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
),
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),
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
),
66 NWidget(NWID_VSCROLLBAR
, COLOUR_GREY
, WID_D_V_SCROLL
),
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),
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
),
82 static WindowDesc::Prefs
_train_depot_prefs ("depot_train");
84 static const WindowDesc
_train_depot_desc(
86 WC_VEHICLE_DEPOT
, WC_NONE
,
88 _nested_train_depot_widgets
, lengthof(_nested_train_depot_widgets
),
92 static WindowDesc::Prefs
_road_depot_prefs ("depot_roadveh");
94 static const WindowDesc
_road_depot_desc(
96 WC_VEHICLE_DEPOT
, WC_NONE
,
98 _nested_train_depot_widgets
, lengthof(_nested_train_depot_widgets
),
102 static WindowDesc::Prefs
_ship_depot_prefs ("depot_ship");
104 static const WindowDesc
_ship_depot_desc(
106 WC_VEHICLE_DEPOT
, WC_NONE
,
108 _nested_train_depot_widgets
, lengthof(_nested_train_depot_widgets
),
112 static WindowDesc::Prefs
_aircraft_depot_prefs ("depot_aircraft");
114 static const WindowDesc
_aircraft_depot_desc(
116 WC_VEHICLE_DEPOT
, WC_NONE
,
118 _nested_train_depot_widgets
, lengthof(_nested_train_depot_widgets
),
119 &_aircraft_depot_prefs
122 extern void DepotSortList(VehicleList
*list
);
125 * This is the Callback method after the cloning attempt of a vehicle
126 * @param result the result of the cloning command
131 void CcCloneVehicle(const CommandCost
&result
, TileIndex tile
, uint32 p1
, uint32 p2
)
133 if (result
.Failed()) return;
135 if (HasBit(p2
, 31)) return;
137 const Vehicle
*v
= Vehicle::Get(_new_vehicle_id
);
139 ShowVehicleViewWindow(v
);
142 StringID
GetErrMoveRailVehicle (TileIndex tile
, uint32 p1
, uint32 p2
, const char *text
)
144 return HasBit(p1
, 31) ? 0 : STR_ERROR_CAN_T_MOVE_VEHICLE
;
147 static void TrainDepotMoveVehicle(const Vehicle
*wagon
, VehicleID sel
, const Vehicle
*head
)
149 const Vehicle
*v
= Vehicle::Get(sel
);
151 if (v
== wagon
) return;
154 if (head
!= NULL
) wagon
= head
->Last();
156 wagon
= wagon
->Previous();
157 if (wagon
== NULL
) return;
160 if (wagon
== v
) return;
162 DoCommandP(v
->tile
, v
->index
| (_ctrl_pressed
? 1 : 0) << 20, wagon
== NULL
? INVALID_VEHICLE
: wagon
->index
, CMD_MOVE_RAIL_VEHICLE
);
165 static VehicleCellSize _base_block_sizes_depot
[VEH_COMPANY_END
]; ///< Cell size for vehicle images in the depot view.
166 static VehicleCellSize _base_block_sizes_purchase
[VEH_COMPANY_END
]; ///< Cell size for vehicle images in the purchase list.
169 * Get the GUI cell size for a vehicle image.
170 * @param type Vehicle type to get the size for.
171 * @param image_type Image type to get size for.
172 * @pre image_type == EIT_IN_DEPOT || image_type == EIT_PURCHASE
173 * @return Cell dimensions for the vehicle and image type.
175 VehicleCellSize
GetVehicleImageCellSize(VehicleType type
, EngineImageType image_type
)
177 switch (image_type
) {
178 case EIT_IN_DEPOT
: return _base_block_sizes_depot
[type
];
179 case EIT_PURCHASE
: return _base_block_sizes_purchase
[type
];
180 default: NOT_REACHED();
184 static void InitBlocksizeForVehicles(VehicleType type
, EngineImageType image_type
)
186 int max_extend_left
= 0;
187 int max_extend_right
= 0;
191 FOR_ALL_ENGINES_OF_TYPE(e
, type
) {
192 if (!e
->IsEnabled()) continue;
194 EngineID eid
= e
->index
;
199 default: NOT_REACHED();
200 case VEH_TRAIN
: GetTrainSpriteSize( eid
, x
, y
, x_offs
, y_offs
, image_type
); break;
201 case VEH_ROAD
: GetRoadVehSpriteSize( eid
, x
, y
, x_offs
, y_offs
, image_type
); break;
202 case VEH_SHIP
: GetShipSpriteSize( eid
, x
, y
, x_offs
, y_offs
, image_type
); break;
203 case VEH_AIRCRAFT
: GetAircraftSpriteSize(eid
, x
, y
, x_offs
, y_offs
, image_type
); break;
205 if (y
> max_height
) max_height
= y
;
206 if (-x_offs
> max_extend_left
) max_extend_left
= -x_offs
;
207 if ((int)x
+ x_offs
> max_extend_right
) max_extend_right
= x
+ x_offs
;
210 int min_extend
= ScaleGUITrad(16);
211 int max_extend
= ScaleGUITrad(98);
213 switch (image_type
) {
215 _base_block_sizes_depot
[type
].height
= max
<uint
>(ScaleGUITrad(GetVehicleHeight(type
)), max_height
);
216 _base_block_sizes_depot
[type
].extend_left
= Clamp(max_extend_left
, min_extend
, max_extend
);
217 _base_block_sizes_depot
[type
].extend_right
= Clamp(max_extend_right
, min_extend
, max_extend
);
220 _base_block_sizes_purchase
[type
].height
= max
<uint
>(ScaleGUITrad(GetVehicleHeight(type
)), max_height
);
221 _base_block_sizes_purchase
[type
].extend_left
= Clamp(max_extend_left
, min_extend
, max_extend
);
222 _base_block_sizes_purchase
[type
].extend_right
= Clamp(max_extend_right
, min_extend
, max_extend
);
225 default: NOT_REACHED();
230 * 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.
231 * @note Calling this function once for each game is enough.
233 void InitDepotWindowBlockSizes()
235 for (VehicleType vt
= VEH_BEGIN
; vt
< VEH_COMPANY_END
; vt
++) {
236 InitBlocksizeForVehicles(vt
, EIT_IN_DEPOT
);
237 InitBlocksizeForVehicles(vt
, EIT_PURCHASE
);
241 static void DepotSellAllConfirmationCallback(Window
*w
, bool confirmed
);
242 const Sprite
*GetAircraftSprite(EngineID engine
);
244 struct DepotWindow
: Window
{
246 VehicleID vehicle_over
; ///< Rail vehicle over which another one is dragged, \c INVALID_VEHICLE if none.
249 VehicleList vehicle_list
;
250 VehicleList wagon_list
;
251 uint unitnumber_digits
;
252 uint num_columns
; ///< Number of columns.
253 Scrollbar
*hscroll
; ///< Only for trains.
256 DepotWindow (const WindowDesc
*desc
, TileIndex tile
, VehicleType type
)
257 : Window (desc
), sel (INVALID_VEHICLE
),
258 vehicle_over (INVALID_VEHICLE
), type (type
),
259 generate_list (true), vehicle_list(), wagon_list(),
260 unitnumber_digits (2), num_columns (1),
261 hscroll (NULL
), vscroll (NULL
),
262 count_width (0), header_width (0),
263 flag_width (0), flag_height (0)
265 assert(IsCompanyBuildableVehicleType(type
)); // ensure that we make the call with a valid type
267 this->CreateNestedTree();
268 this->hscroll
= (this->type
== VEH_TRAIN
? this->GetScrollbar(WID_D_H_SCROLL
) : NULL
);
269 this->vscroll
= this->GetScrollbar(WID_D_V_SCROLL
);
270 /* Don't show 'rename button' of aircraft hangar */
271 this->GetWidget
<NWidgetStacked
>(WID_D_SHOW_RENAME
)->SetDisplayedPlane(type
== VEH_AIRCRAFT
? SZSP_NONE
: 0);
272 /* Only train depots have a horizontal scrollbar and a 'sell chain' button */
273 if (type
== VEH_TRAIN
) this->GetWidget
<NWidgetCore
>(WID_D_MATRIX
)->widget_data
= 1 << MAT_COL_START
;
274 this->GetWidget
<NWidgetStacked
>(WID_D_SHOW_H_SCROLL
)->SetDisplayedPlane(type
== VEH_TRAIN
? 0 : SZSP_HORIZONTAL
);
275 this->GetWidget
<NWidgetStacked
>(WID_D_SHOW_SELL_CHAIN
)->SetDisplayedPlane(type
== VEH_TRAIN
? 0 : SZSP_NONE
);
276 this->SetupWidgetData(type
);
277 this->FinishInitNested(tile
);
279 this->owner
= GetTileOwner(tile
);
280 OrderBackup::Reset();
283 void OnDelete (void) FINAL_OVERRIDE
285 DeleteWindowById(WC_BUILD_VEHICLE
, this->window_number
);
286 OrderBackup::Reset(this->window_number
);
290 * Draw a vehicle in the depot window in the box with the top left corner at x,y.
291 * @param v Vehicle to draw.
292 * @param left Left side of the box to draw in.
293 * @param right Right side of the box to draw in.
294 * @param y Top of the box to draw in.
296 void DrawVehicleInDepot(const Vehicle
*v
, int left
, int right
, int y
) const
298 bool free_wagon
= false;
299 int sprite_y
= y
+ (this->resize
.step_height
- ScaleGUITrad(GetVehicleHeight(v
->type
))) / 2;
301 bool rtl
= _current_text_dir
== TD_RTL
;
302 int image_left
= rtl
? left
+ this->count_width
: left
+ this->header_width
;
303 int image_right
= rtl
? right
- this->header_width
: right
- this->count_width
;
307 const Train
*u
= Train::From(v
);
308 free_wagon
= u
->IsFreeWagon();
310 uint x_space
= free_wagon
? ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH
) : 0;
311 DrawTrainImage(u
, image_left
+ (rtl
? 0 : x_space
), image_right
- (rtl
? x_space
: 0), sprite_y
- 1,
312 this->sel
, EIT_IN_DEPOT
, free_wagon
? 0 : this->hscroll
->GetPosition(), this->vehicle_over
);
314 /* Length of consist in tiles with 1 fractional digit (rounded up) */
315 SetDParam(0, CeilDiv(u
->gcache
.cached_total_length
* 10, TILE_SIZE
));
317 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
321 case VEH_ROAD
: DrawRoadVehImage( v
, image_left
, image_right
, sprite_y
, this->sel
, EIT_IN_DEPOT
); break;
322 case VEH_SHIP
: DrawShipImage( v
, image_left
, image_right
, sprite_y
, this->sel
, EIT_IN_DEPOT
); break;
323 case VEH_AIRCRAFT
: DrawAircraftImage(v
, image_left
, image_right
, sprite_y
, this->sel
, EIT_IN_DEPOT
); break;
324 default: NOT_REACHED();
328 if (v
->IsGroundVehicle()) {
329 /* Arrange unitnumber and flag horizontally */
330 diff_x
= this->flag_width
+ WD_FRAMERECT_LEFT
;
331 diff_y
= (this->resize
.step_height
- this->flag_height
) / 2 - 2;
333 /* Arrange unitnumber and flag vertically */
334 diff_x
= WD_FRAMERECT_LEFT
;
335 diff_y
= FONT_HEIGHT_NORMAL
+ WD_PAR_VSEP_NORMAL
;
337 int text_left
= rtl
? right
- this->header_width
- 1 : left
+ diff_x
;
338 int text_right
= rtl
? right
- diff_x
: left
+ this->header_width
- 1;
341 DrawString(text_left
, text_right
, y
+ 2, STR_DEPOT_NO_ENGINE
);
343 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
);
345 SetDParam(0, v
->unitnumber
);
346 DrawString(text_left
, text_right
, y
+ 2, (uint16
)(v
->max_age
- DAYS_IN_LEAP_YEAR
) >= v
->age
? STR_BLACK_COMMA
: STR_RED_COMMA
);
350 void DrawWidget(const Rect
&r
, int widget
) const
352 if (widget
!= WID_D_MATRIX
) return;
354 bool rtl
= _current_text_dir
== TD_RTL
;
356 /* Set the row and number of boxes in each row based on the number of boxes drawn in the matrix */
357 const NWidgetCore
*wid
= this->GetWidget
<NWidgetCore
>(WID_D_MATRIX
);
358 uint16 rows_in_display
= wid
->current_y
/ wid
->resize_y
;
360 uint16 num
= this->vscroll
->GetPosition() * this->num_columns
;
361 int maxval
= min(this->vehicle_list
.Length(), num
+ (rows_in_display
* this->num_columns
));
363 for (y
= r
.top
+ 1; num
< maxval
; y
+= this->resize
.step_height
) { // Draw the rows
364 for (byte i
= 0; i
< this->num_columns
&& num
< maxval
; i
++, num
++) {
365 /* Draw all vehicles in the current row */
366 const Vehicle
*v
= this->vehicle_list
[num
];
367 if (this->num_columns
== 1) {
368 this->DrawVehicleInDepot(v
, r
.left
, r
.right
, y
);
370 int x
= r
.left
+ (rtl
? (this->num_columns
- i
- 1) : i
) * this->resize
.step_width
;
371 this->DrawVehicleInDepot(v
, x
, x
+ this->resize
.step_width
- 1, y
);
376 maxval
= min(this->vehicle_list
.Length() + this->wagon_list
.Length(), (this->vscroll
->GetPosition() * this->num_columns
) + (rows_in_display
* this->num_columns
));
378 /* Draw the train wagons without an engine in front. */
379 for (; num
< maxval
; num
++, y
+= this->resize
.step_height
) {
380 const Vehicle
*v
= this->wagon_list
[num
- this->vehicle_list
.Length()];
381 this->DrawVehicleInDepot(v
, r
.left
, r
.right
, y
);
385 void SetStringParameters(int widget
) const
387 if (widget
!= WID_D_CAPTION
) return;
389 /* locate the depot struct */
390 TileIndex tile
= this->window_number
;
391 SetDParam(0, this->type
);
392 SetDParam(1, (this->type
== VEH_AIRCRAFT
) ? GetStationIndex(tile
) : GetDepotIndex(tile
));
395 struct GetDepotVehiclePtData
{
397 const Vehicle
*wagon
;
400 enum DepotGUIAction
{
407 DepotGUIAction
GetVehicleFromDepotWndPt(int x
, int y
, const Vehicle
**veh
, GetDepotVehiclePtData
*d
) const
409 const NWidgetCore
*matrix_widget
= this->GetWidget
<NWidgetCore
>(WID_D_MATRIX
);
410 /* In case of RTL the widgets are swapped as a whole */
411 if (_current_text_dir
== TD_RTL
) x
= matrix_widget
->current_x
- x
;
413 uint xt
= 0, xm
= 0, ym
= 0;
414 if (this->type
== VEH_TRAIN
) {
417 xt
= x
/ this->resize
.step_width
;
418 xm
= x
% this->resize
.step_width
;
419 if (xt
>= this->num_columns
) return MODE_ERROR
;
421 ym
= y
% this->resize
.step_height
;
423 uint row
= y
/ this->resize
.step_height
;
424 if (row
>= this->vscroll
->GetCapacity()) return MODE_ERROR
;
426 uint pos
= ((row
+ this->vscroll
->GetPosition()) * this->num_columns
) + xt
;
428 if (this->vehicle_list
.Length() + this->wagon_list
.Length() <= pos
) {
429 /* Clicking on 'line' / 'block' without a vehicle */
430 if (this->type
== VEH_TRAIN
) {
431 /* End the dragging */
434 return MODE_DRAG_VEHICLE
;
436 return MODE_ERROR
; // empty block, so no vehicle is selected
441 if (this->vehicle_list
.Length() > pos
) {
442 *veh
= this->vehicle_list
[pos
];
443 /* Skip vehicles that are scrolled off the list */
444 if (this->type
== VEH_TRAIN
) x
+= this->hscroll
->GetPosition();
446 pos
-= this->vehicle_list
.Length();
447 *veh
= this->wagon_list
[pos
];
448 /* free wagons don't have an initial loco. */
449 x
-= ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH
);
453 const Train
*v
= NULL
;
454 if (this->type
== VEH_TRAIN
) {
455 v
= Train::From(*veh
);
456 d
->head
= d
->wagon
= v
;
459 if (xm
<= this->header_width
) {
460 switch (this->type
) {
462 if (wagon
) return MODE_ERROR
;
465 if (xm
<= this->flag_width
) return MODE_START_STOP
;
470 if (xm
<= this->flag_width
&& ym
>= (uint
)(FONT_HEIGHT_NORMAL
+ WD_PAR_VSEP_NORMAL
)) return MODE_START_STOP
;
473 default: NOT_REACHED();
475 return MODE_SHOW_VEHICLE
;
478 if (this->type
!= VEH_TRAIN
) return MODE_DRAG_VEHICLE
;
480 /* Clicking on the counter */
481 if (xm
>= matrix_widget
->current_x
- this->count_width
) return wagon
? MODE_ERROR
: MODE_SHOW_VEHICLE
;
483 /* Account for the header */
484 x
-= this->header_width
;
486 /* find the vehicle in this row that was clicked */
487 for (; v
!= NULL
; v
= v
->Next()) {
488 x
-= v
->GetDisplayImageWidth();
492 d
->wagon
= (v
!= NULL
? v
->GetFirstEnginePart() : NULL
);
494 return MODE_DRAG_VEHICLE
;
498 * Handle click in the depot matrix.
499 * @param x Horizontal position in the matrix widget in pixels.
500 * @param y Vertical position in the matrix widget in pixels.
502 void DepotClick(int x
, int y
)
504 GetDepotVehiclePtData gdvp
= { NULL
, NULL
};
505 const Vehicle
*v
= NULL
;
506 DepotGUIAction mode
= this->GetVehicleFromDepotWndPt(x
, y
, &v
, &gdvp
);
508 if (this->type
== VEH_TRAIN
) v
= gdvp
.wagon
;
511 case MODE_ERROR
: // invalid
514 case MODE_DRAG_VEHICLE
: { // start dragging of vehicle
515 if (v
!= NULL
&& VehicleClicked(v
)) return;
517 VehicleID sel
= this->sel
;
519 if (this->type
== VEH_TRAIN
&& sel
!= INVALID_VEHICLE
) {
520 this->sel
= INVALID_VEHICLE
;
521 TrainDepotMoveVehicle(v
, sel
, gdvp
.head
);
522 } else if (v
!= NULL
) {
523 bool rtl
= _current_text_dir
== TD_RTL
;
524 int image
= v
->GetImage(rtl
? DIR_E
: DIR_W
, EIT_IN_DEPOT
);
525 SetPointerMode (POINTER_DRAG
, this, image
, GetVehiclePalette(v
));
527 this->sel
= v
->index
;
530 _cursor
.short_vehicle_offset
= v
->IsGroundVehicle() ? (16 - v
->GetGroundVehicleCache()->cached_veh_length
* 2) * (rtl
? -1 : 1) : 0;
531 _cursor
.vehchain
= _ctrl_pressed
;
536 case MODE_SHOW_VEHICLE
: // show info window
537 ShowVehicleViewWindow(v
);
540 case MODE_START_STOP
: // click start/stop flag
541 StartStopVehicle(v
, false);
544 default: NOT_REACHED();
549 * Function to set up vehicle specific widgets (mainly sprites and strings).
550 * Only use this function to if the widget is used for several vehicle types and each has
551 * different text/sprites. If the widget is only used for a single vehicle type, or the same
552 * text/sprites are used every time, use the nested widget array to initialize the widget.
554 void SetupWidgetData(VehicleType type
)
556 this->GetWidget
<NWidgetCore
>(WID_D_STOP_ALL
)->tool_tip
= STR_DEPOT_MASS_STOP_DEPOT_TRAIN_TOOLTIP
+ type
;
557 this->GetWidget
<NWidgetCore
>(WID_D_START_ALL
)->tool_tip
= STR_DEPOT_MASS_START_DEPOT_TRAIN_TOOLTIP
+ type
;
558 this->GetWidget
<NWidgetCore
>(WID_D_SELL
)->tool_tip
= STR_DEPOT_TRAIN_SELL_TOOLTIP
+ type
;
559 this->GetWidget
<NWidgetCore
>(WID_D_SELL_ALL
)->tool_tip
= STR_DEPOT_SELL_ALL_BUTTON_TRAIN_TOOLTIP
+ type
;
561 this->GetWidget
<NWidgetCore
>(WID_D_BUILD
)->SetDataTip(STR_DEPOT_TRAIN_NEW_VEHICLES_BUTTON
+ type
, STR_DEPOT_TRAIN_NEW_VEHICLES_TOOLTIP
+ type
);
562 this->GetWidget
<NWidgetCore
>(WID_D_CLONE
)->SetDataTip(STR_DEPOT_CLONE_TRAIN
+ type
, STR_DEPOT_CLONE_TRAIN_DEPOT_INFO
+ type
);
564 this->GetWidget
<NWidgetCore
>(WID_D_LOCATION
)->tool_tip
= STR_DEPOT_TRAIN_LOCATION_TOOLTIP
+ type
;
565 this->GetWidget
<NWidgetCore
>(WID_D_VEHICLE_LIST
)->tool_tip
= STR_DEPOT_VEHICLE_ORDER_LIST_TRAIN_TOOLTIP
+ type
;
566 this->GetWidget
<NWidgetCore
>(WID_D_AUTOREPLACE
)->tool_tip
= STR_DEPOT_AUTOREPLACE_TRAIN_TOOLTIP
+ type
;
567 this->GetWidget
<NWidgetCore
>(WID_D_MATRIX
)->tool_tip
= STR_DEPOT_TRAIN_LIST_TOOLTIP
+ this->type
;
570 default: NOT_REACHED();
573 this->GetWidget
<NWidgetCore
>(WID_D_VEHICLE_LIST
)->widget_data
= STR_TRAIN
;
576 this->GetWidget
<NWidgetCore
>(WID_D_SELL
)->widget_data
= SPR_SELL_TRAIN
;
577 this->GetWidget
<NWidgetCore
>(WID_D_SELL_ALL
)->widget_data
= SPR_SELL_ALL_TRAIN
;
578 this->GetWidget
<NWidgetCore
>(WID_D_AUTOREPLACE
)->widget_data
= SPR_REPLACE_TRAIN
;
582 this->GetWidget
<NWidgetCore
>(WID_D_VEHICLE_LIST
)->widget_data
= STR_LORRY
;
585 this->GetWidget
<NWidgetCore
>(WID_D_SELL
)->widget_data
= SPR_SELL_ROADVEH
;
586 this->GetWidget
<NWidgetCore
>(WID_D_SELL_ALL
)->widget_data
= SPR_SELL_ALL_ROADVEH
;
587 this->GetWidget
<NWidgetCore
>(WID_D_AUTOREPLACE
)->widget_data
= SPR_REPLACE_ROADVEH
;
591 this->GetWidget
<NWidgetCore
>(WID_D_VEHICLE_LIST
)->widget_data
= STR_SHIP
;
594 this->GetWidget
<NWidgetCore
>(WID_D_SELL
)->widget_data
= SPR_SELL_SHIP
;
595 this->GetWidget
<NWidgetCore
>(WID_D_SELL_ALL
)->widget_data
= SPR_SELL_ALL_SHIP
;
596 this->GetWidget
<NWidgetCore
>(WID_D_AUTOREPLACE
)->widget_data
= SPR_REPLACE_SHIP
;
600 this->GetWidget
<NWidgetCore
>(WID_D_VEHICLE_LIST
)->widget_data
= STR_PLANE
;
603 this->GetWidget
<NWidgetCore
>(WID_D_SELL
)->widget_data
= SPR_SELL_AIRCRAFT
;
604 this->GetWidget
<NWidgetCore
>(WID_D_SELL_ALL
)->widget_data
= SPR_SELL_ALL_AIRCRAFT
;
605 this->GetWidget
<NWidgetCore
>(WID_D_AUTOREPLACE
)->widget_data
= SPR_REPLACE_AIRCRAFT
;
615 virtual void UpdateWidgetSize(int widget
, Dimension
*size
, const Dimension
&padding
, Dimension
*fill
, Dimension
*resize
)
621 if (this->type
== VEH_TRAIN
) {
622 SetDParamMaxValue(0, 1000, 0, FS_SMALL
);
624 this->count_width
= GetStringBoundingBox(STR_TINY_BLACK_DECIMAL
).width
+ WD_FRAMERECT_LEFT
+ WD_FRAMERECT_RIGHT
;
626 this->count_width
= 0;
629 SetDParamMaxDigits(0, this->unitnumber_digits
);
630 Dimension unumber
= GetStringBoundingBox(STR_BLACK_COMMA
);
631 const Sprite
*spr
= GetSprite(SPR_FLAG_VEH_STOPPED
, ST_NORMAL
);
632 this->flag_width
= UnScaleGUI(spr
->width
) + WD_FRAMERECT_RIGHT
;
633 this->flag_height
= UnScaleGUI(spr
->height
);
635 if (this->type
== VEH_TRAIN
|| this->type
== VEH_ROAD
) {
636 min_height
= max
<uint
>(unumber
.height
+ WD_MATRIX_TOP
, UnScaleGUI(spr
->height
));
637 this->header_width
= unumber
.width
+ this->flag_width
+ WD_FRAMERECT_LEFT
;
639 min_height
= unumber
.height
+ UnScaleGUI(spr
->height
) + WD_MATRIX_TOP
+ WD_PAR_VSEP_NORMAL
+ WD_MATRIX_BOTTOM
;
640 this->header_width
= max
<uint
>(unumber
.width
, this->flag_width
) + WD_FRAMERECT_RIGHT
;
642 int base_width
= this->count_width
+ this->header_width
;
644 resize
->height
= max
<uint
>(GetVehicleImageCellSize(this->type
, EIT_IN_DEPOT
).height
, min_height
);
645 if (this->type
== VEH_TRAIN
) {
647 size
->width
= base_width
+ 2 * ScaleGUITrad(29); // about 2 parts
648 size
->height
= resize
->height
* 6;
650 resize
->width
= base_width
+ GetVehicleImageCellSize(this->type
, EIT_IN_DEPOT
).extend_left
+ GetVehicleImageCellSize(this->type
, EIT_IN_DEPOT
).extend_right
;
651 size
->width
= resize
->width
* (this->type
== VEH_ROAD
? 5 : 3);
652 size
->height
= resize
->height
* (this->type
== VEH_ROAD
? 5 : 3);
654 fill
->width
= resize
->width
;
655 fill
->height
= resize
->height
;
662 * Some data on this window has become invalid.
663 * @param data Information about the changed data.
664 * @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.
666 virtual void OnInvalidateData(int data
= 0, bool gui_scope
= true)
668 this->generate_list
= true;
671 virtual void OnPaint()
673 if (this->generate_list
) {
674 /* Generate the vehicle list
675 * It's ok to use the wagon pointers for non-trains as they will be ignored */
676 BuildDepotVehicleList(this->type
, this->window_number
, &this->vehicle_list
, &this->wagon_list
);
677 this->generate_list
= false;
678 DepotSortList(&this->vehicle_list
);
680 uint new_unitnumber_digits
= GetUnitNumberDigits(this->vehicle_list
);
681 if (this->unitnumber_digits
!= new_unitnumber_digits
) {
682 this->unitnumber_digits
= new_unitnumber_digits
;
687 /* determine amount of items for scroller */
688 if (this->type
== VEH_TRAIN
) {
689 uint max_width
= ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH
);
690 for (uint num
= 0; num
< this->vehicle_list
.Length(); num
++) {
692 for (const Train
*v
= Train::From(this->vehicle_list
[num
]); v
!= NULL
; v
= v
->Next()) {
693 width
+= v
->GetDisplayImageWidth();
695 max_width
= max(max_width
, width
);
697 /* Always have 1 empty row, so people can change the setting of the train */
698 this->vscroll
->SetCount(this->vehicle_list
.Length() + this->wagon_list
.Length() + 1);
699 this->hscroll
->SetCount(max_width
);
701 this->vscroll
->SetCount(CeilDiv(this->vehicle_list
.Length(), this->num_columns
));
704 /* Setup disabled buttons. */
705 TileIndex tile
= this->window_number
;
706 this->SetWidgetsDisabledState(!IsTileOwner(tile
, _local_company
),
721 virtual void OnClick(Point pt
, int widget
, int click_count
)
724 case WID_D_MATRIX
: { // List
725 NWidgetBase
*nwi
= this->GetWidget
<NWidgetBase
>(WID_D_MATRIX
);
726 this->DepotClick(pt
.x
- nwi
->pos_x
, pt
.y
- nwi
->pos_y
);
730 case WID_D_BUILD
: // Build vehicle
732 ShowBuildVehicleWindow(this->window_number
, this->type
);
735 case WID_D_CLONE
: // Clone button
736 this->SetWidgetDirty(WID_D_CLONE
);
737 this->ToggleWidgetLoweredState(WID_D_CLONE
);
739 if (this->IsWidgetLowered(WID_D_CLONE
)) {
740 static const CursorID clone_icons
[] = {
741 SPR_CURSOR_CLONE_TRAIN
, SPR_CURSOR_CLONE_ROADVEH
,
742 SPR_CURSOR_CLONE_SHIP
, SPR_CURSOR_CLONE_AIRPLANE
745 SetPointerMode (POINTER_VEHICLE
, this, clone_icons
[this->type
]);
753 ShowExtraViewPortWindow(this->window_number
);
755 ScrollMainWindowToTile(this->window_number
);
759 case WID_D_RENAME
: // Rename button
760 SetDParam(0, this->type
);
761 SetDParam(1, Depot::GetByTile((TileIndex
)this->window_number
)->index
);
762 ShowQueryString(STR_DEPOT_NAME
, STR_DEPOT_RENAME_DEPOT_CAPTION
, MAX_LENGTH_DEPOT_NAME_CHARS
, this, CS_ALPHANUMERAL
, QSF_ENABLE_DEFAULT
| QSF_LEN_IN_CHARS
);
766 case WID_D_START_ALL
: {
767 VehicleListIdentifier
vli(VL_DEPOT_LIST
, this->type
, this->owner
);
768 DoCommandP(this->window_number
, (widget
== WID_D_START_ALL
? (1 << 0) : 0), vli
.Pack(), CMD_MASS_START_STOP
);
773 /* Only open the confirmation window if there are anything to sell */
774 if (this->vehicle_list
.Length() != 0 || this->wagon_list
.Length() != 0) {
775 TileIndex tile
= this->window_number
;
776 byte vehtype
= this->type
;
778 SetDParam(0, vehtype
);
779 SetDParam(1, (vehtype
== VEH_AIRCRAFT
) ? GetStationIndex(tile
) : GetDepotIndex(tile
));
782 STR_DEPOT_SELL_CONFIRMATION_TEXT
,
784 DepotSellAllConfirmationCallback
789 case WID_D_VEHICLE_LIST
:
790 ShowVehicleListWindow(GetTileOwner(this->window_number
), this->type
, (TileIndex
)this->window_number
);
793 case WID_D_AUTOREPLACE
:
794 DoCommandP(this->window_number
, this->type
, 0, CMD_DEPOT_MASS_AUTOREPLACE
);
800 virtual void OnQueryTextFinished(char *str
)
802 if (str
== NULL
) return;
804 /* Do depot renaming */
805 DoCommandP(0, GetDepotIndex(this->window_number
), 0, CMD_RENAME_DEPOT
, str
);
808 virtual bool OnRightClick(Point pt
, int widget
)
810 if (widget
!= WID_D_MATRIX
) return false;
812 GetDepotVehiclePtData gdvp
= { NULL
, NULL
};
813 const Vehicle
*v
= NULL
;
814 NWidgetBase
*nwi
= this->GetWidget
<NWidgetBase
>(WID_D_MATRIX
);
815 DepotGUIAction mode
= this->GetVehicleFromDepotWndPt(pt
.x
- nwi
->pos_x
, pt
.y
- nwi
->pos_y
, &v
, &gdvp
);
817 if (this->type
== VEH_TRAIN
) v
= gdvp
.wagon
;
819 if (v
== NULL
|| mode
!= MODE_DRAG_VEHICLE
) return false;
821 CargoArray capacity
, loaded
;
823 /* Display info for single (articulated) vehicle, or for whole chain starting with selected vehicle */
824 bool whole_chain
= (this->type
== VEH_TRAIN
&& _ctrl_pressed
);
826 /* loop through vehicle chain and collect cargoes */
828 for (const Vehicle
*w
= v
; w
!= NULL
; w
= w
->Next()) {
829 if (w
->cargo_cap
> 0 && w
->cargo_type
< NUM_CARGO
) {
830 capacity
[w
->cargo_type
] += w
->cargo_cap
;
831 loaded
[w
->cargo_type
] += w
->cargo
.StoredCount();
834 if (w
->type
== VEH_TRAIN
&& !w
->HasArticulatedPart()) {
836 if (!whole_chain
) break;
840 /* Build tooltipstring */
841 static char details
[1024];
842 stringb
sb (details
);
844 for (CargoID cargo_type
= 0; cargo_type
< NUM_CARGO
; cargo_type
++) {
845 if (capacity
[cargo_type
] == 0) continue;
847 SetDParam(0, cargo_type
); // {CARGO} #1
848 SetDParam(1, loaded
[cargo_type
]); // {CARGO} #2
849 SetDParam(2, cargo_type
); // {SHORTCARGO} #1
850 SetDParam(3, capacity
[cargo_type
]); // {SHORTCARGO} #2
851 AppendString (&sb
, STR_DEPOT_VEHICLE_TOOLTIP_CARGO
);
854 /* Show tooltip window */
856 args
[0] = (whole_chain
? num
: v
->engine_type
);
857 args
[1] = (uint64
)(size_t)details
;
858 GuiShowTooltips(this, whole_chain
? STR_DEPOT_VEHICLE_TOOLTIP_CHAIN
: STR_DEPOT_VEHICLE_TOOLTIP
, 2, args
, TCC_RIGHT_CLICK
);
865 * @param v the original vehicle to clone
866 * @return Always true.
868 virtual bool OnVehicleSelect(const Vehicle
*v
)
870 if (DoCommandP(this->window_number
, v
->index
, _ctrl_pressed
? 1 : 0, CMD_CLONE_VEHICLE
)) {
876 virtual void OnPlaceObjectAbort()
879 this->RaiseWidget(WID_D_CLONE
);
880 this->SetWidgetDirty(WID_D_CLONE
);
882 /* abort drag & drop */
883 this->sel
= INVALID_VEHICLE
;
884 this->vehicle_over
= INVALID_VEHICLE
;
885 this->SetWidgetDirty(WID_D_MATRIX
);
888 virtual void OnMouseDrag(Point pt
, int widget
)
890 if (this->type
!= VEH_TRAIN
|| this->sel
== INVALID_VEHICLE
) return;
892 /* A rail vehicle is dragged.. */
893 if (widget
!= WID_D_MATRIX
) { // ..outside of the depot matrix.
894 if (this->vehicle_over
!= INVALID_VEHICLE
) {
895 this->vehicle_over
= INVALID_VEHICLE
;
896 this->SetWidgetDirty(WID_D_MATRIX
);
901 NWidgetBase
*matrix
= this->GetWidget
<NWidgetBase
>(widget
);
902 const Vehicle
*v
= NULL
;
903 GetDepotVehiclePtData gdvp
= {NULL
, NULL
};
905 if (this->GetVehicleFromDepotWndPt(pt
.x
- matrix
->pos_x
, pt
.y
- matrix
->pos_y
, &v
, &gdvp
) != MODE_DRAG_VEHICLE
) return;
907 VehicleID new_vehicle_over
= INVALID_VEHICLE
;
908 if (gdvp
.head
!= NULL
) {
909 if (gdvp
.wagon
== NULL
&& gdvp
.head
->Last()->index
!= this->sel
) { // ..at the end of the train.
910 /* 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
911 * destination inside a train. This head index is then used to indicate that a wagon is inserted at
912 * the end of the train.
914 new_vehicle_over
= gdvp
.head
->index
;
915 } else if (gdvp
.wagon
!= NULL
&& gdvp
.head
!= gdvp
.wagon
&&
916 gdvp
.wagon
->index
!= this->sel
&&
917 gdvp
.wagon
->Previous()->index
!= this->sel
) { // ..over an existing wagon.
918 new_vehicle_over
= gdvp
.wagon
->index
;
922 if (this->vehicle_over
== new_vehicle_over
) return;
924 this->vehicle_over
= new_vehicle_over
;
925 this->SetWidgetDirty(widget
);
928 virtual void OnDragDrop(Point pt
, int widget
)
932 const Vehicle
*v
= NULL
;
933 VehicleID sel
= this->sel
;
935 this->sel
= INVALID_VEHICLE
;
938 NWidgetBase
*nwi
= this->GetWidget
<NWidgetBase
>(WID_D_MATRIX
);
939 if (this->type
== VEH_TRAIN
) {
940 GetDepotVehiclePtData gdvp
= { NULL
, NULL
};
942 if (this->GetVehicleFromDepotWndPt(pt
.x
- nwi
->pos_x
, pt
.y
- nwi
->pos_y
, &v
, &gdvp
) == MODE_DRAG_VEHICLE
&& sel
!= INVALID_VEHICLE
) {
943 if (gdvp
.wagon
!= NULL
&& gdvp
.wagon
->index
== sel
&& _ctrl_pressed
) {
944 DoCommandP(Vehicle::Get(sel
)->tile
, Vehicle::Get(sel
)->index
, true, CMD_REVERSE_TRAIN_DIRECTION
);
945 } else if (gdvp
.wagon
== NULL
|| gdvp
.wagon
->index
!= sel
) {
946 this->vehicle_over
= INVALID_VEHICLE
;
947 TrainDepotMoveVehicle(gdvp
.wagon
, sel
, gdvp
.head
);
948 } else if (gdvp
.head
!= NULL
&& gdvp
.head
->IsFrontEngine()) {
949 ShowVehicleViewWindow(gdvp
.head
);
952 } else if (this->GetVehicleFromDepotWndPt(pt
.x
- nwi
->pos_x
, pt
.y
- nwi
->pos_y
, &v
, NULL
) == MODE_DRAG_VEHICLE
&& v
!= NULL
&& sel
== v
->index
) {
953 ShowVehicleViewWindow(v
);
958 case WID_D_SELL
: case WID_D_SELL_CHAIN
: {
959 if (this->IsWidgetDisabled(widget
)) return;
960 if (this->sel
== INVALID_VEHICLE
) return;
962 this->HandleButtonClick(widget
);
964 const Vehicle
*v
= Vehicle::Get(this->sel
);
965 this->sel
= INVALID_VEHICLE
;
968 int sell_cmd
= (v
->type
== VEH_TRAIN
&& (widget
== WID_D_SELL_CHAIN
|| _ctrl_pressed
)) ? 1 : 0;
969 DoCommandP(v
->tile
, v
->index
| sell_cmd
<< 20 | MAKE_ORDER_BACKUP_FLAG
, 0, CMD_SELL_VEHICLE
);
974 this->sel
= INVALID_VEHICLE
;
977 _cursor
.vehchain
= false;
980 virtual void OnTimeout()
982 if (!this->IsWidgetDisabled(WID_D_SELL
)) {
983 this->RaiseWidget(WID_D_SELL
);
984 this->SetWidgetDirty(WID_D_SELL
);
986 if (this->nested_array
[WID_D_SELL
] != NULL
&& !this->IsWidgetDisabled(WID_D_SELL_CHAIN
)) {
987 this->RaiseWidget(WID_D_SELL_CHAIN
);
988 this->SetWidgetDirty(WID_D_SELL_CHAIN
);
992 virtual void OnResize()
994 this->vscroll
->SetCapacityFromWidget(this, WID_D_MATRIX
);
995 NWidgetCore
*nwi
= this->GetWidget
<NWidgetCore
>(WID_D_MATRIX
);
996 if (this->type
== VEH_TRAIN
) {
997 this->hscroll
->SetCapacity(nwi
->current_x
- this->header_width
- this->count_width
);
999 this->num_columns
= nwi
->current_x
/ nwi
->resize_x
;
1003 virtual EventState
OnCTRLStateChange()
1005 if (this->sel
!= INVALID_VEHICLE
) {
1006 _cursor
.vehchain
= _ctrl_pressed
;
1007 this->SetWidgetDirty(WID_D_MATRIX
);
1011 return ES_NOT_HANDLED
;
1015 static void DepotSellAllConfirmationCallback(Window
*win
, bool confirmed
)
1018 DepotWindow
*w
= (DepotWindow
*)win
;
1019 TileIndex tile
= w
->window_number
;
1020 byte vehtype
= w
->type
;
1021 DoCommandP(tile
, vehtype
, 0, CMD_DEPOT_SELL_ALL_VEHICLES
);
1026 * Opens a depot window
1027 * @param tile The tile where the depot/hangar is located
1028 * @param type The type of vehicles in the depot
1030 void ShowDepotWindow(TileIndex tile
, VehicleType type
)
1032 if (BringWindowToFrontById(WC_VEHICLE_DEPOT
, tile
) != NULL
) return;
1034 const WindowDesc
*desc
;
1036 default: NOT_REACHED();
1037 case VEH_TRAIN
: desc
= &_train_depot_desc
; break;
1038 case VEH_ROAD
: desc
= &_road_depot_desc
; break;
1039 case VEH_SHIP
: desc
= &_ship_depot_desc
; break;
1040 case VEH_AIRCRAFT
: desc
= &_aircraft_depot_desc
; break;
1043 new DepotWindow(desc
, tile
, type
);
1047 * Removes the highlight of a vehicle in a depot window
1048 * @param *v Vehicle to remove all highlights from
1050 void DeleteDepotHighlightOfVehicle(const Vehicle
*v
)
1054 /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any depots either
1055 * If that is the case, we can skip looping though the windows and save time
1057 if (_pointer_mode
!= POINTER_DRAG
) return;
1059 w
= dynamic_cast<DepotWindow
*>(FindWindowById(WC_VEHICLE_DEPOT
, v
->tile
));
1061 if (w
->sel
== v
->index
) ResetPointerMode();