Rework the trip history window layout.
[openttd-joker.git] / src / train_gui.cpp
blob42a4dabc60a0927d1be9b5a515f8c8e12349b7c5
1 /* $Id: train_gui.cpp 25454 2013-06-24 18:39:19Z rubidium $ */
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 train_gui.cpp GUI for trains. */
12 #include "stdafx.h"
13 #include "window_gui.h"
14 #include "command_func.h"
15 #include "train.h"
16 #include "strings_func.h"
17 #include "vehicle_func.h"
18 #include "zoom_func.h"
20 #include "table/strings.h"
22 #include "safeguards.h"
24 /**
25 * Callback for building wagons.
26 * @param result The result of the command.
27 * @param tile The tile the command was executed on.
28 * @param p1 Additional data for the command (for the #CommandProc)
29 * @param p2 Additional data for the command (for the #CommandProc)
31 void CcBuildWagon(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
33 if (result.Failed()) return;
35 /* find a locomotive in the depot. */
36 const Vehicle *found = NULL;
37 const Train *t;
38 FOR_ALL_TRAINS(t) {
39 if (t->IsFrontEngine() && t->tile == tile && t->IsStoppedInDepot()) {
40 if (found != NULL) return; // must be exactly one.
41 found = t;
45 /* if we found a loco, */
46 if (found != NULL) {
47 found = found->Last();
48 /* put the new wagon at the end of the loco. */
49 DoCommandP(0, _new_vehicle_id, found->index, CMD_MOVE_RAIL_VEHICLE);
50 InvalidateWindowClassesData(WC_TRAINS_LIST, 0);
54 /**
55 * Highlight the position where a rail vehicle is dragged over by drawing a light gray background.
56 * @param px The current x position to draw from.
57 * @param max_width The maximum space available to draw.
58 * @param selection Selected vehicle that is dragged.
59 * @param chain Whether a whole chain is dragged.
60 * @return The width of the highlight mark.
62 static int HighlightDragPosition(int px, int max_width, VehicleID selection, bool chain)
64 bool rtl = _current_text_dir == TD_RTL;
66 assert(selection != INVALID_VEHICLE);
67 int dragged_width = 0;
68 for (Train *t = Train::Get(selection); t != NULL; t = chain ? t->Next() : (t->HasArticulatedPart() ? t->GetNextArticulatedPart() : NULL)) {
69 dragged_width += t->GetDisplayImageWidth(NULL);
72 int drag_hlight_left = rtl ? max(px - dragged_width + 1, 0) : px;
73 int drag_hlight_right = rtl ? px : min(px + dragged_width, max_width) - 1;
74 int drag_hlight_width = max(drag_hlight_right - drag_hlight_left + 1, 0);
76 if (drag_hlight_width > 0) {
77 GfxFillRect(drag_hlight_left + WD_FRAMERECT_LEFT, WD_FRAMERECT_TOP + 1,
78 drag_hlight_right - WD_FRAMERECT_RIGHT, ScaleGUITrad(13) - WD_FRAMERECT_BOTTOM, _colour_gradient[COLOUR_GREY][7]);
81 return drag_hlight_width;
84 /**
85 * Draws an image of a whole train
86 * @param v Front vehicle
87 * @param left The minimum horizontal position
88 * @param right The maximum horizontal position
89 * @param y Vertical position to draw at
90 * @param selection Selected vehicle to draw a frame around
91 * @param skip Number of pixels to skip at the front (for scrolling)
92 * @param drag_dest The vehicle another one is dragged over, \c INVALID_VEHICLE if none.
94 void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest)
96 bool rtl = _current_text_dir == TD_RTL;
97 Direction dir = rtl ? DIR_E : DIR_W;
99 DrawPixelInfo tmp_dpi, *old_dpi;
100 /* Position of highlight box */
101 int highlight_l = 0;
102 int highlight_r = 0;
103 int max_width = right - left + 1;
104 int height = ScaleGUITrad(14);
106 if (!FillDrawPixelInfo(&tmp_dpi, left, y, max_width, height)) return;
108 old_dpi = _cur_dpi;
109 _cur_dpi = &tmp_dpi;
111 int px = rtl ? max_width + skip : -skip;
112 bool sel_articulated = false;
113 bool dragging = (drag_dest != INVALID_VEHICLE);
114 bool drag_at_end_of_train = (drag_dest == v->index); // Head index is used to mark dragging at end of train.
115 for (; v != NULL && (rtl ? px > 0 : px < max_width); v = v->Next()) {
116 if (dragging && !drag_at_end_of_train && drag_dest == v->index) {
117 /* Highlight the drag-and-drop destination inside the train. */
118 int drag_hlight_width = HighlightDragPosition(px, max_width, selection, _cursor.vehchain);
119 px += rtl ? -drag_hlight_width : drag_hlight_width;
122 Point offset;
123 int width = Train::From(v)->GetDisplayImageWidth(&offset);
125 if (rtl ? px + width > 0 : px - width < max_width) {
126 PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
127 VehicleSpriteSeq seq;
128 v->GetImage(dir, image_type, &seq);
129 seq.Draw(px + (rtl ? -offset.x : offset.x), height / 2 + offset.y, pal, (v->vehstatus & VS_CRASHED) != 0);
132 if (!v->IsArticulatedPart()) sel_articulated = false;
134 if (v->index == selection) {
135 /* Set the highlight position */
136 highlight_l = rtl ? px - width : px;
137 highlight_r = rtl ? px - 1 : px + width - 1;
138 sel_articulated = true;
139 } else if ((_cursor.vehchain && highlight_r != 0) || sel_articulated) {
140 if (rtl) {
141 highlight_l -= width;
142 } else {
143 highlight_r += width;
147 px += rtl ? -width : width;
150 if (dragging && drag_at_end_of_train) {
151 /* Highlight the drag-and-drop destination at the end of the train. */
152 HighlightDragPosition(px, max_width, selection, _cursor.vehchain);
155 if (highlight_l != highlight_r) {
156 /* Draw the highlight. Now done after drawing all the engines, as
157 * the next engine after the highlight could overlap it. */
158 DrawFrameRect(highlight_l, 0, highlight_r, height - 1, COLOUR_WHITE, FR_BORDERONLY);
161 _cur_dpi = old_dpi;
164 /** Helper struct for the cargo details information */
165 struct CargoSummaryItem {
166 CargoID cargo; ///< The cargo that is carried
167 StringID subtype; ///< STR_EMPTY if none
168 uint capacity; ///< Amount that can be carried
169 uint amount; ///< Amount that is carried
170 StationID source; ///< One of the source stations
172 /** Used by CargoSummary::Find() and similar functions */
173 inline bool operator != (const CargoSummaryItem &other) const
175 return this->cargo != other.cargo || this->subtype != other.subtype;
179 static const uint TRAIN_DETAILS_MIN_INDENT = 32; ///< Minimum indent level in the train details window
180 static const uint TRAIN_DETAILS_MAX_INDENT = 72; ///< Maximum indent level in the train details window; wider than this and we start on a new line
182 /** Container for the cargo summary information. */
183 typedef SmallVector<CargoSummaryItem, 2> CargoSummary;
184 /** Reused container of cargo details */
185 static CargoSummary _cargo_summary;
188 * Draw the details cargo tab for the given vehicle at the given position
190 * @param item Data to draw
191 * @param left The left most coordinate to draw
192 * @param right The right most coordinate to draw
193 * @param y The y coordinate
195 static void TrainDetailsCargoTab(const CargoSummaryItem *item, int left, int right, int y)
197 StringID str;
198 if (item->amount > 0) {
199 SetDParam(0, item->cargo);
200 SetDParam(1, item->amount);
201 SetDParam(2, item->source);
202 SetDParam(3, _settings_game.vehicle.freight_trains);
203 str = FreightWagonMult(item->cargo) > 1 ? STR_VEHICLE_DETAILS_CARGO_FROM_MULT : STR_VEHICLE_DETAILS_CARGO_FROM;
204 } else {
205 SetDParam(0, STR_QUANTITY_N_A);
206 str = item->cargo == INVALID_CARGO ? STR_LTBLUE_STRING : STR_VEHICLE_DETAILS_CARGO_EMPTY;
209 DrawString(left, right, y, str);
213 * Draw the details info tab for the given vehicle at the given position
215 * @param v current vehicle
216 * @param left The left most coordinate to draw
217 * @param right The right most coordinate to draw
218 * @param y The y coordinate
220 static void TrainDetailsInfoTab(const Vehicle *v, int left, int right, int y)
222 if (RailVehInfo(v->engine_type)->railveh_type == RAILVEH_WAGON) {
223 SetDParam(0, v->engine_type);
224 SetDParam(1, v->value);
225 SetDParam(2, Train::From(v)->GetEmptyWeight());
226 SetDParam(3, Train::From(v)->GetLoadedWeight());
227 SetDParam(4, CeilDiv(Train::From(v)->gcache.cached_veh_length * 100, TILE_SIZE));
228 SetDParam(5, 2);
229 DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_WAGON_VALUE_EXT);
230 } else {
231 SetDParam(0, v->engine_type);
232 SetDParam(1, v->build_year);
233 SetDParam(2, v->value);
234 SetDParam(3, Train::From(v)->GetEmptyWeight());
235 SetDParam(4, Train::From(v)->GetLoadedWeight());
237 const Vehicle* u = v;
238 uint16 length = 0;
240 do {
241 length += CeilDiv(Train::From(u)->gcache.cached_veh_length * 100, TILE_SIZE);
242 } while ((u = u->Next()) != NULL && u->IsArticulatedPart());
244 SetDParam(5, length);
245 SetDParam(6, 2);
246 DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_ENGINE_BUILT_AND_VALUE_EXT);
251 * Draw the details capacity tab for the given vehicle at the given position
253 * @param item Data to draw
254 * @param left The left most coordinate to draw
255 * @param right The right most coordinate to draw
256 * @param y The y coordinate
258 static void TrainDetailsCapacityTab(const CargoSummaryItem *item, int left, int right, int y)
260 StringID str;
261 if (item->cargo != INVALID_CARGO) {
262 SetDParam(0, item->cargo);
263 SetDParam(1, item->capacity);
264 SetDParam(4, item->subtype);
265 SetDParam(5, _settings_game.vehicle.freight_trains);
266 str = FreightWagonMult(item->cargo) > 1 ? STR_VEHICLE_INFO_CAPACITY_MULT : STR_VEHICLE_INFO_CAPACITY;
267 } else {
268 /* Draw subtype only */
269 SetDParam(0, item->subtype);
270 str = STR_VEHICLE_INFO_NO_CAPACITY;
272 DrawString(left, right, y, str);
276 * Collects the cargo transported
277 * @param v Vehicle to process
278 * @param summary Space for the result
280 static void GetCargoSummaryOfArticulatedVehicle(const Train *v, CargoSummary *summary)
282 summary->Clear();
283 do {
284 if (!v->GetEngine()->CanCarryCargo()) continue;
286 CargoSummaryItem new_item;
287 new_item.cargo = v->cargo_cap > 0 ? v->cargo_type : INVALID_CARGO;
288 new_item.subtype = GetCargoSubtypeText(v);
289 if (new_item.cargo == INVALID_CARGO && new_item.subtype == STR_EMPTY) continue;
291 CargoSummaryItem *item = summary->Find(new_item);
292 if (item == summary->End()) {
293 item = summary->Append();
294 item->cargo = new_item.cargo;
295 item->subtype = new_item.subtype;
296 item->capacity = 0;
297 item->amount = 0;
298 item->source = INVALID_STATION;
301 item->capacity += v->cargo_cap;
302 item->amount += v->cargo.StoredCount();
303 if (item->source == INVALID_STATION) item->source = v->cargo.Source();
304 } while ((v = v->Next()) != NULL && v->IsArticulatedPart());
308 * Get the length of an articulated vehicle.
309 * @param v the vehicle to get the length of.
310 * @return the length in pixels.
312 static uint GetLengthOfArticulatedVehicle(const Train *v)
314 uint length = 0;
316 do {
317 length += v->GetDisplayImageWidth();
318 } while ((v = v->Next()) != NULL && v->IsArticulatedPart());
320 return length;
324 * Determines the number of lines in the train details window
325 * @param veh_id Train
326 * @param det_tab Selected details tab
327 * @return Number of line
329 int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab)
331 int num = 0;
333 if (det_tab == TDW_TAB_TOTALS) { // Total cargo tab
334 CargoArray act_cargo;
335 CargoArray max_cargo;
336 for (const Vehicle *v = Vehicle::Get(veh_id); v != NULL; v = v->Next()) {
337 act_cargo[v->cargo_type] += v->cargo.StoredCount();
338 max_cargo[v->cargo_type] += v->cargo_cap;
341 /* Set scroll-amount separately from counting, as to not compute num double
342 * for more carriages of the same type
344 for (CargoID i = 0; i < NUM_CARGO; i++) {
345 if (max_cargo[i] > 0) num++; // only count carriages that the train has
347 num += 10; // needs seven more because first line is description string and we have the weight and speed info
348 } else {
349 for (const Train *v = Train::Get(veh_id); v != NULL; v = v->GetNextVehicle()) {
350 GetCargoSummaryOfArticulatedVehicle(v, &_cargo_summary);
351 num += max(1u, _cargo_summary.Length());
353 uint length = GetLengthOfArticulatedVehicle(v);
354 if (length > TRAIN_DETAILS_MAX_INDENT) num++;
358 return num;
362 * Draw the details for the given vehicle at the given position
364 * @param v current vehicle
365 * @param left The left most coordinate to draw
366 * @param right The right most coordinate to draw
367 * @param y The y coordinate
368 * @param vscroll_pos Position of scrollbar
369 * @param vscroll_cap Number of lines currently displayed
370 * @param det_tab Selected details tab
372 void DrawTrainDetails(const Train *v, int left, int right, int y, int vscroll_pos, uint16 vscroll_cap, TrainDetailsWindowTabs det_tab)
374 /* get rid of awkward offset */
375 y -= WD_MATRIX_TOP;
377 int sprite_height = ScaleGUITrad(GetVehicleHeight(VEH_TRAIN));
378 int line_height = max(sprite_height, WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM);
379 int sprite_y_offset = line_height / 2;
380 int text_y_offset = (line_height - FONT_HEIGHT_NORMAL) / 2;
382 /* draw the first 3 details tabs */
383 if (det_tab != TDW_TAB_TOTALS) {
384 bool rtl = _current_text_dir == TD_RTL;
385 Direction dir = rtl ? DIR_E : DIR_W;
386 int x = rtl ? right : left;
387 for (; v != NULL && vscroll_pos > -vscroll_cap; v = v->GetNextVehicle()) {
388 GetCargoSummaryOfArticulatedVehicle(v, &_cargo_summary);
390 /* Draw sprites */
391 uint dx = 0;
392 int px = x;
393 const Train *u = v;
394 do {
395 Point offset;
396 int width = u->GetDisplayImageWidth(&offset);
397 if (vscroll_pos <= 0 && vscroll_pos > -vscroll_cap) {
398 int pitch = 0;
399 const Engine *e = Engine::Get(v->engine_type);
400 if (e->GetGRF() != NULL) {
401 pitch = ScaleGUITrad(e->GetGRF()->traininfo_vehicle_pitch);
403 PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
404 VehicleSpriteSeq seq;
405 u->GetImage(dir, EIT_IN_DETAILS, &seq);
406 seq.Draw(px + (rtl ? -offset.x : offset.x), y - line_height * vscroll_pos + sprite_y_offset + pitch, pal, (v->vehstatus & VS_CRASHED) != 0);
408 px += rtl ? -width : width;
409 dx += width;
410 u = u->Next();
411 } while (u != NULL && u->IsArticulatedPart());
413 bool separate_sprite_row = (dx > (uint)ScaleGUITrad(TRAIN_DETAILS_MAX_INDENT));
414 if (separate_sprite_row) {
415 vscroll_pos--;
416 dx = 0;
419 uint num_lines = max(1u, _cargo_summary.Length());
420 for (uint i = 0; i < num_lines; i++) {
421 int sprite_width = max<int>(dx, ScaleGUITrad(TRAIN_DETAILS_MIN_INDENT)) + 3;
422 int data_left = left + (rtl ? 0 : sprite_width);
423 int data_right = right - (rtl ? sprite_width : 0);
424 if (vscroll_pos <= 0 && vscroll_pos > -vscroll_cap) {
425 int py = y - line_height * vscroll_pos + text_y_offset;
426 if (i > 0 || separate_sprite_row) {
427 if (vscroll_pos != 0) GfxFillRect(left, py - WD_MATRIX_TOP - 1, right, py - WD_MATRIX_TOP, _colour_gradient[COLOUR_GREY][5]);
429 switch (det_tab) {
430 case TDW_TAB_CARGO:
431 if (i < _cargo_summary.Length()) {
432 TrainDetailsCargoTab(&_cargo_summary[i], data_left, data_right, py);
433 } else {
434 DrawString(data_left, data_right, py, STR_QUANTITY_N_A, TC_LIGHT_BLUE);
436 break;
438 case TDW_TAB_INFO:
439 if (i == 0) TrainDetailsInfoTab(v, data_left, data_right, py);
440 break;
442 case TDW_TAB_CAPACITY:
443 if (i < _cargo_summary.Length()) {
444 TrainDetailsCapacityTab(&_cargo_summary[i], data_left, data_right, py);
445 } else {
446 SetDParam(0, STR_EMPTY);
447 DrawString(data_left, data_right, py, STR_VEHICLE_INFO_NO_CAPACITY);
449 break;
451 default: NOT_REACHED();
454 vscroll_pos--;
457 } else {
458 CargoArray act_cargo;
459 CargoArray max_cargo;
460 Money feeder_share = 0;
461 uint16 empty_weight = 0;
462 uint16 loaded_weight = 0;
463 uint16 empty_max_speed = 0;
464 uint16 loaded_max_speed = 0;
466 for (const Vehicle *u = v; u != NULL; u = u->Next()) {
467 act_cargo[u->cargo_type] += u->cargo.StoredCount();
468 max_cargo[u->cargo_type] += u->cargo_cap;
469 feeder_share += u->cargo.FeederShare();
470 empty_weight += Train::From(u)->GetEmptyWeight();
471 loaded_weight += Train::From(u)->GetLoadedWeight();
474 double tractive_effort_empty = empty_weight * v->GetRollingFriction();
475 double tractive_effort_loaded = loaded_weight * v->GetRollingFriction();
476 double power = v->gcache.cached_power * 746ll;
477 double max_te = v->gcache.cached_max_te;
478 empty_max_speed = min(v->GetDisplayMaxSpeed(), (tractive_effort_empty == 0 || tractive_effort_empty > max_te) ? 0 : (3.6 * (power / tractive_effort_empty)));
479 loaded_max_speed = min(v->GetDisplayMaxSpeed(), (tractive_effort_loaded == 0 || tractive_effort_loaded > max_te) ? 0 : (3.6 * (power / tractive_effort_loaded)));
481 /* draw performance tab */
482 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
483 SetDParam(0, CeilDiv(Train::From(v)->gcache.cached_total_length * 100, TILE_SIZE));
484 SetDParam(1, 2);
485 DrawString(left, right, y + text_y_offset, STR_VEHICLE_DETAILS_TRAIN_TOTAL_LENGTH);
486 y += line_height;
489 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
490 y += line_height;
493 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
494 SetDParam(0, empty_weight);
495 DrawString(left, right, y + text_y_offset, STR_VEHICLE_DETAILS_TRAIN_TOTAL_EMPTY_WEIGHT);
496 y += line_height;
499 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
500 SetDParam(0, loaded_weight);
501 DrawString(left, right, y + text_y_offset, STR_VEHICLE_DETAILS_TRAIN_TOTAL_LOADED_WEIGHT);
502 y += line_height;
505 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
506 y += line_height;
509 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
510 SetDParam(0, empty_max_speed);
511 DrawString(left, right, y + text_y_offset, empty_max_speed > 0 ? STR_VEHICLE_DETAILS_TRAIN_MAX_EMPTY_SPEED : STR_VEHICLE_DETAILS_TRAIN_MAX_EMPTY_SPEED_ZERO);
512 y += line_height;
515 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
516 SetDParam(0, loaded_max_speed);
517 DrawString(left, right, y + text_y_offset, loaded_max_speed > 0 ? STR_VEHICLE_DETAILS_TRAIN_MAX_LOADED_SPEED : STR_VEHICLE_DETAILS_TRAIN_MAX_LOADED_SPEED_ZERO);
518 y += line_height;
521 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
522 y += line_height;
525 if (--vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
526 DrawString(left, right, y + text_y_offset, STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY_TEXT);
527 y += line_height;
530 for (CargoID i = 0; i < NUM_CARGO; i++) {
531 if (max_cargo[i] > 0 && --vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
532 SetDParam(0, i); // {CARGO} #1
533 SetDParam(1, act_cargo[i]); // {CARGO} #2
534 SetDParam(2, i); // {SHORTCARGO} #1
535 SetDParam(3, max_cargo[i]); // {SHORTCARGO} #2
536 SetDParam(4, _settings_game.vehicle.freight_trains);
537 DrawString(left, right, y + text_y_offset, FreightWagonMult(i) > 1 ? STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY_MULT : STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY);
538 y += line_height;