OpenTTD

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

- File List
- Globals

train_gui.cpp
Go to the documentation of this file.
1 /* $Id: train_gui.cpp 27667 2016-10-16 14:58:38Z 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 "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"
19
20 #include "table/strings.h"
21
22 #include "safeguards.h"
23
31 void CcBuildWagon(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
32 {
33 if (result.Failed()) return;
34
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;
42 }
43 }
44
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);
51 }
52 }
53
62 static int HighlightDragPosition(int px, int max_width, VehicleID selection, bool chain)
63 {
64 bool rtl = _current_text_dir == TD_RTL;
65
66 assert(selection != INVALID_VEHICLE);
67 int dragged_width = WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
68 for (Train *t = Train::Get(selection); t != NULL; t = chain ? t->Next() : (t->HasArticulatedPart() ? t->GetNextArticulatedPart() : NULL)) {
69 dragged_width += t->GetDisplayImageWidth(NULL);
70 }
71
72 int drag_hlight_left = rtl ? max(px -dragged_width, 0) : px;
73 int drag_hlight_right = rtl ? px : min(px + dragged_width, max_width);
74 int drag_hlight_width = max(drag_hlight_right - drag_hlight_left, 0);
75
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]);
79 }
80
81 return drag_hlight_width;
82 }
83
94 void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest)
95 {
96 bool rtl = _current_text_dir == TD_RTL;
97 Direction dir = rtl ? DIR_E : DIR_W;
98
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);
105
106 if (!FillDrawPixelInfo(&tmp_dpi, left, y, max_width, height)) return;
107
108 old_dpi = _cur_dpi;
109 _cur_dpi = &tmp_dpi;
110
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;
120 }
121
122 Point offset;
123 int width = Train::From(v)->GetDisplayImageWidth(&offset);
124
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);
130 }
131
132 if (!v->IsArticulatedPart()) sel_articulated = false;
133
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;
144 }
145 }
146
147 px += rtl ? -width : width;
148 }
149
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);
153 }
154
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);
159 }
160
161 _cur_dpi = old_dpi;
162 }
163
165 struct CargoSummaryItem {
166 CargoID cargo;
167 StringID subtype;
168 uint capacity;
169 uint amount;
170 StationID source;
171
173 inline bool operator != (const CargoSummaryItem &other) const
174 {
175 return this->cargo != other.cargo || this->subtype != other.subtype;
176 }
177 };
178
179 static const uint TRAIN_DETAILS_MIN_INDENT = 32;
180 static const uint TRAIN_DETAILS_MAX_INDENT = 72;
181
183 typedef SmallVector<CargoSummaryItem, 2> CargoSummary;
185 static CargoSummary _cargo_summary;
186
195 static void TrainDetailsCargoTab(const CargoSummaryItem *item, int left, int right, int y)
196 {
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;
207 }
208
209 DrawString(left, right, y, str);
210 }
211
220 static void TrainDetailsInfoTab(const Vehicle *v, int left, int right, int y)
221 {
222 if (RailVehInfo(v->engine_type)->railveh_type == RAILVEH_WAGON) {
223 SetDParam(0, v->engine_type);
224 SetDParam(1, v->value);
225 DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_WAGON_VALUE);
226 } else {
227 SetDParam(0, v->engine_type);
228 SetDParam(1, v->build_year);
229 SetDParam(2, v->value);
230 DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_ENGINE_BUILT_AND_VALUE);
231 }
232 }
233
242 static void TrainDetailsCapacityTab(const CargoSummaryItem *item, int left, int right, int y)
243 {
244 StringID str;
245 if (item->cargo != INVALID_CARGO) {
246 SetDParam(0, item->cargo);
247 SetDParam(1, item->capacity);
248 SetDParam(4, item->subtype);
249 SetDParam(5, _settings_game.vehicle.freight_trains);
250 str = FreightWagonMult(item->cargo) > 1 ? STR_VEHICLE_INFO_CAPACITY_MULT : STR_VEHICLE_INFO_CAPACITY;
251 } else {
252 /* Draw subtype only */
253 SetDParam(0, item->subtype);
254 str = STR_VEHICLE_INFO_NO_CAPACITY;
255 }
256 DrawString(left, right, y, str);
257 }
258
264 static void GetCargoSummaryOfArticulatedVehicle(const Train *v, CargoSummary *summary)
265 {
266 summary->Clear();
267 do {
268 if (!v->GetEngine()->CanCarryCargo()) continue;
269
270 CargoSummaryItem new_item;
271 new_item.cargo = v->cargo_cap > 0 ? v->cargo_type : INVALID_CARGO;
272 new_item.subtype = GetCargoSubtypeText(v);
273 if (new_item.cargo == INVALID_CARGO && new_item.subtype == STR_EMPTY) continue;
274
275 CargoSummaryItem *item = summary->Find(new_item);
276 if (item == summary->End()) {
277 item = summary->Append();
278 item->cargo = new_item.cargo;
279 item->subtype = new_item.subtype;
280 item->capacity = 0;
281 item->amount = 0;
282 item->source = INVALID_STATION;
283 }
284
285 item->capacity += v->cargo_cap;
286 item->amount += v->cargo.StoredCount();
287 if (item->source == INVALID_STATION) item->source = v->cargo.Source();
288 } while ((v = v->Next()) != NULL && v->IsArticulatedPart());
289 }
290
296 static uint GetLengthOfArticulatedVehicle(const Train *v)
297 {
298 uint length = 0;
299
300 do {
301 length += v->GetDisplayImageWidth();
302 } while ((v = v->Next()) != NULL && v->IsArticulatedPart());
303
304 return length;
305 }
306
313 int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab)
314 {
315 int num = 0;
316
317 if (det_tab == TDW_TAB_TOTALS) { // Total cargo tab
318 CargoArray act_cargo;
319 CargoArray max_cargo;
320 for (const Vehicle *v = Vehicle::Get(veh_id); v != NULL; v = v->Next()) {
321 act_cargo[v->cargo_type] += v->cargo.StoredCount();
322 max_cargo[v->cargo_type] += v->cargo_cap;
323 }
324
325 /* Set scroll-amount separately from counting, as to not compute num double
326 * for more carriages of the same type
327 */
328 for (CargoID i = 0; i < NUM_CARGO; i++) {
329 if (max_cargo[i] > 0) num++; // only count carriages that the train has
330 }
331 num++; // needs one more because first line is description string
332 } else {
333 for (const Train *v = Train::Get(veh_id); v != NULL; v = v->GetNextVehicle()) {
334 GetCargoSummaryOfArticulatedVehicle(v, &_cargo_summary);
335 num += max(1u, _cargo_summary.Length());
336
337 uint length = GetLengthOfArticulatedVehicle(v);
338 if (length > TRAIN_DETAILS_MAX_INDENT) num++;
339 }
340 }
341
342 return num;
343 }
344
356 void DrawTrainDetails(const Train *v, int left, int right, int y, int vscroll_pos, uint16 vscroll_cap, TrainDetailsWindowTabs det_tab)
357 {
358 /* get rid of awkward offset */
359 y -= WD_MATRIX_TOP;
360
361 int sprite_height = ScaleGUITrad(GetVehicleHeight(VEH_TRAIN));
362 int line_height = max(sprite_height, WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM);
363 int sprite_y_offset = line_height / 2;
364 int text_y_offset = (line_height - FONT_HEIGHT_NORMAL) / 2;
365
366 /* draw the first 3 details tabs */
367 if (det_tab != TDW_TAB_TOTALS) {
368 bool rtl = _current_text_dir == TD_RTL;
369 Direction dir = rtl ? DIR_E : DIR_W;
370 int x = rtl ? right : left;
371 for (; v != NULL && vscroll_pos > -vscroll_cap; v = v->GetNextVehicle()) {
372 GetCargoSummaryOfArticulatedVehicle(v, &_cargo_summary);
373
374 /* Draw sprites */
375 uint dx = 0;
376 int px = x;
377 const Train *u = v;
378 do {
379 Point offset;
380 int width = u->GetDisplayImageWidth(&offset);
381 if (vscroll_pos <= 0 && vscroll_pos > -vscroll_cap) {
382 int pitch = 0;
383 const Engine *e = Engine::Get(v->engine_type);
384 if (e->GetGRF() != NULL) {
385 pitch = ScaleGUITrad(e->GetGRF()->traininfo_vehicle_pitch);
386 }
387 PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
388 VehicleSpriteSeq seq;
389 u->GetImage(dir, EIT_IN_DETAILS, &seq);
390 seq.Draw(px + (rtl ? -offset.x : offset.x), y - line_height * vscroll_pos + sprite_y_offset + pitch, pal, v->vehstatus & VS_CRASHED);
391 }
392 px += rtl ? -width : width;
393 dx += width;
394 u = u->Next();
395 } while (u != NULL && u->IsArticulatedPart());
396
397 bool separate_sprite_row = (dx > (uint)ScaleGUITrad(TRAIN_DETAILS_MAX_INDENT));
398 if (separate_sprite_row) {
399 vscroll_pos--;
400 dx = 0;
401 }
402
403 uint num_lines = max(1u, _cargo_summary.Length());
404 for (uint i = 0; i < num_lines; i++) {
405 int sprite_width = max<int>(dx, ScaleGUITrad(TRAIN_DETAILS_MIN_INDENT)) + 3;
406 int data_left = left + (rtl ? 0 : sprite_width);
407 int data_right = right - (rtl ? sprite_width : 0);
408 if (vscroll_pos <= 0 && vscroll_pos > -vscroll_cap) {
409 int py = y - line_height * vscroll_pos + text_y_offset;
410 if (i > 0 || separate_sprite_row) {
411 if (vscroll_pos != 0) GfxFillRect(left, py - WD_MATRIX_TOP - 1, right, py - WD_MATRIX_TOP, _colour_gradient[COLOUR_GREY][5]);
412 }
413 switch (det_tab) {
414 case TDW_TAB_CARGO:
415 if (i < _cargo_summary.Length()) {
416 TrainDetailsCargoTab(&_cargo_summary[i], data_left, data_right, py);
417 } else {
418 DrawString(data_left, data_right, py, STR_QUANTITY_N_A, TC_LIGHT_BLUE);
419 }
420 break;
421
422 case TDW_TAB_INFO:
423 if (i == 0) TrainDetailsInfoTab(v, data_left, data_right, py);
424 break;
425
426 case TDW_TAB_CAPACITY:
427 if (i < _cargo_summary.Length()) {
428 TrainDetailsCapacityTab(&_cargo_summary[i], data_left, data_right, py);
429 } else {
430 SetDParam(0, STR_EMPTY);
431 DrawString(data_left, data_right, py, STR_VEHICLE_INFO_NO_CAPACITY);
432 }
433 break;
434
435 default: NOT_REACHED();
436 }
437 }
438 vscroll_pos--;
439 }
440 }
441 } else {
442 CargoArray act_cargo;
443 CargoArray max_cargo;
444 Money feeder_share = 0;
445
446 for (const Vehicle *u = v; u != NULL; u = u->Next()) {
447 act_cargo[u->cargo_type] += u->cargo.StoredCount();
448 max_cargo[u->cargo_type] += u->cargo_cap;
449 feeder_share += u->cargo.FeederShare();
450 }
451
452 /* draw total cargo tab */
453 DrawString(left, right, y + text_y_offset, STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY_TEXT);
454 y += line_height;
455
456 for (CargoID i = 0; i < NUM_CARGO; i++) {
457 if (max_cargo[i] > 0 && --vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
458 SetDParam(0, i); // {CARGO} #1
459 SetDParam(1, act_cargo[i]); // {CARGO} #2
460 SetDParam(2, i); // {SHORTCARGO} #1
461 SetDParam(3, max_cargo[i]); // {SHORTCARGO} #2
462 SetDParam(4, _settings_game.vehicle.freight_trains);
463 DrawString(left, right, y + text_y_offset, FreightWagonMult(i) > 1 ? STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY_MULT : STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY);
464 y += line_height;
465 }
466 }
467 SetDParam(0, feeder_share);
468 DrawString(left, right, y + text_y_offset, STR_VEHICLE_INFO_FEEDER_CARGO_VALUE);
469 }
470 }