# train_gui.cpp

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * 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.
    00006  * 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.
    00007  * 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/>.
    00008  */
    00009
    00012 #include "stdafx.h"
    00013 #include "window_gui.h"
    00014 #include "command_func.h"
    00015 #include "train.h"
    00016 #include "strings_func.h"
    00017 #include "vehicle_func.h"
    00018
    00019 #include "table/strings.h"
    00020
    00028 void CcBuildWagon(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
    00029 {
    00030   if (result.Failed()) return;
    00031
    00032   /* find a locomotive in the depot. */
    00033   const Vehicle *found = NULL;
    00034   const Train *t;
    00035   FOR_ALL_TRAINS(t) {
    00036     if (t->IsFrontEngine() && t->tile == tile &&
    00037         t->track == TRACK_BIT_DEPOT) {
    00038       if (found != NULL) return; // must be exactly one.
    00039       found = t;
    00040     }
    00041   }
    00042
    00043   /* if we found a loco, */
    00044   if (found != NULL) {
    00045     found = found->Last();
    00046     /* put the new wagon at the end of the loco. */
    00047     DoCommandP(0, _new_vehicle_id, found->index, CMD_MOVE_RAIL_VEHICLE);
    00048     InvalidateWindowClassesData(WC_TRAINS_LIST, 0);
    00049   }
    00050 }
    00051
    00059 static int HighlightDragPosition(int px, int max_width, VehicleID selection)
    00060 {
    00061   bool rtl = _current_text_dir == TD_RTL;
    00062
    00063   assert(selection != INVALID_VEHICLE);
    00064   Point offset;
    00065   int dragged_width = Train::Get(selection)->GetDisplayImageWidth(&offset) + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
    00066
    00067   int drag_hlight_left = rtl ? max(px -dragged_width, 0) : px;
    00068   int drag_hlight_right = rtl ? px : min(px + dragged_width, max_width);
    00069   int drag_hlight_width = max(drag_hlight_right - drag_hlight_left, 0);
    00070
    00071   if (drag_hlight_width > 0) {
    00072     GfxFillRect(drag_hlight_left + WD_FRAMERECT_LEFT, WD_FRAMERECT_TOP + 1,
    00073         drag_hlight_right - WD_FRAMERECT_RIGHT, 13 - WD_FRAMERECT_BOTTOM, _colour_gradient[COLOUR_GREY][7]);
    00074   }
    00075
    00076   return drag_hlight_width;
    00077 }
    00078
    00089 void DrawTrainImage(const Train *v, int left, int right, int y, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest)
    00090 {
    00091   bool rtl = _current_text_dir == TD_RTL;
    00092   Direction dir = rtl ? DIR_E : DIR_W;
    00093
    00094   DrawPixelInfo tmp_dpi, *old_dpi;
    00095   /* Position of highlight box */
    00096   int highlight_l = 0;
    00097   int highlight_r = 0;
    00098   int max_width = right - left + 1;
    00099
    00100   if (!FillDrawPixelInfo(&tmp_dpi, left, y, max_width, 14)) return;
    00101
    00102   old_dpi = _cur_dpi;
    00103   _cur_dpi = &tmp_dpi;
    00104
    00105   int px = rtl ? max_width + skip : -skip;
    00106   bool sel_articulated = false;
    00107   bool dragging = (drag_dest != INVALID_VEHICLE);
    00108   bool drag_at_end_of_train = (drag_dest == v->index); // Head index is used to mark dragging at end of train.
    00109   for (; v != NULL && (rtl ? px > 0 : px < max_width); v = v->Next()) {
    00110     if (dragging && !drag_at_end_of_train && drag_dest == v->index) {
    00111       /* Highlight the drag-and-drop destination inside the train. */
    00112       int drag_hlight_width = HighlightDragPosition(px, max_width, selection);
    00113       px += rtl ? -drag_hlight_width : drag_hlight_width;
    00114     }
    00115
    00116     Point offset;
    00117     int width = Train::From(v)->GetDisplayImageWidth(&offset);
    00118
    00119     if (rtl ? px + width > 0 : px - width < max_width) {
    00120       PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
    00121       DrawSprite(v->GetImage(dir, image_type), pal, px + (rtl ? -offset.x : offset.x), 7 + offset.y);
    00122     }
    00123
    00124     if (!v->IsArticulatedPart()) sel_articulated = false;
    00125
    00126     if (v->index == selection) {
    00127       /* Set the highlight position */
    00128       highlight_l = rtl ? px - width : px;
    00129       highlight_r = rtl ? px - 1 : px + width - 1;
    00130       sel_articulated = true;
    00131     } else if ((_cursor.vehchain && highlight_r != 0) || sel_articulated) {
    00132       if (rtl) {
    00133         highlight_l -= width;
    00134       } else {
    00135         highlight_r += width;
    00136       }
    00137     }
    00138
    00139     px += rtl ? -width : width;
    00140   }
    00141
    00142   if (dragging && drag_at_end_of_train) {
    00143     /* Highlight the drag-and-drop destination at the end of the train. */
    00144     HighlightDragPosition(px, max_width, selection);
    00145   }
    00146
    00147   if (highlight_l != highlight_r) {
    00148     /* Draw the highlight. Now done after drawing all the engines, as
    00149      * the next engine after the highlight could overlap it. */
    00150     DrawFrameRect(highlight_l, 0, highlight_r, 13, COLOUR_WHITE, FR_BORDERONLY);
    00151   }
    00152
    00153   _cur_dpi = old_dpi;
    00154 }
    00155
    00157 struct CargoSummaryItem {
    00158   CargoID cargo;
    00159   StringID subtype;
    00160   uint capacity;
    00161   uint amount;
    00162   StationID source;
    00163
    00165   inline bool operator != (const CargoSummaryItem &other) const
    00166   {
    00167     return this->cargo != other.cargo || this->subtype != other.subtype;
    00168   }
    00169 };
    00170
    00171 static const uint TRAIN_DETAILS_MIN_INDENT = 32;
    00172 static const uint TRAIN_DETAILS_MAX_INDENT = 72;
    00173
    00175 typedef SmallVector<CargoSummaryItem, 2> CargoSummary;
    00177 static CargoSummary _cargo_summary;
    00178
    00187 static void TrainDetailsCargoTab(const CargoSummaryItem *item, int left, int right, int y)
    00188 {
    00189   StringID str;
    00190   if (item->amount > 0) {
    00191     SetDParam(0, item->cargo);
    00192     SetDParam(1, item->amount);
    00193     SetDParam(2, item->source);
    00194     SetDParam(3, _settings_game.vehicle.freight_trains);
    00195     str = FreightWagonMult(item->cargo) > 1 ? STR_VEHICLE_DETAILS_CARGO_FROM_MULT : STR_VEHICLE_DETAILS_CARGO_FROM;
    00196   } else {
    00197     SetDParam(0, STR_QUANTITY_N_A);
    00198     str = item->cargo == INVALID_CARGO ? STR_LTBLUE_STRING : STR_VEHICLE_DETAILS_CARGO_EMPTY;
    00199   }
    00200
    00201   DrawString(left, right, y, str);
    00202 }
    00203
    00212 static void TrainDetailsInfoTab(const Vehicle *v, int left, int right, int y)
    00213 {
    00214   if (RailVehInfo(v->engine_type)->railveh_type == RAILVEH_WAGON) {
    00215     SetDParam(0, v->engine_type);
    00216     SetDParam(1, v->value);
    00217     DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_WAGON_VALUE, TC_FROMSTRING, SA_LEFT | SA_STRIP);
    00218   } else {
    00219     SetDParam(0, v->engine_type);
    00220     SetDParam(1, v->build_year);
    00221     SetDParam(2, v->value);
    00222     DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_ENGINE_BUILT_AND_VALUE, TC_FROMSTRING, SA_LEFT | SA_STRIP);
    00223   }
    00224 }
    00225
    00234 static void TrainDetailsCapacityTab(const CargoSummaryItem *item, int left, int right, int y)
    00235 {
    00236   StringID str;
    00237   if (item->cargo != INVALID_CARGO) {
    00238     SetDParam(0, item->cargo);
    00239     SetDParam(1, item->capacity);
    00240     SetDParam(4, item->subtype);
    00241     SetDParam(5, _settings_game.vehicle.freight_trains);
    00242     str = FreightWagonMult(item->cargo) > 1 ? STR_VEHICLE_INFO_CAPACITY_MULT : STR_VEHICLE_INFO_CAPACITY;
    00243   } else {
    00244     /* Draw subtype only */
    00245     SetDParam(0, item->subtype);
    00246     str = STR_VEHICLE_INFO_NO_CAPACITY;
    00247   }
    00248   DrawString(left, right, y, str);
    00249 }
    00250
    00256 static void GetCargoSummaryOfArticulatedVehicle(const Train *v, CargoSummary *summary)
    00257 {
    00258   summary->Clear();
    00259   do {
    00260     if (!v->GetEngine()->CanCarryCargo()) continue;
    00261
    00262     CargoSummaryItem new_item;
    00263     new_item.cargo = v->cargo_cap > 0 ? v->cargo_type : INVALID_CARGO;
    00264     new_item.subtype = GetCargoSubtypeText(v);
    00265     if (new_item.cargo == INVALID_CARGO && new_item.subtype == STR_EMPTY) continue;
    00266
    00267     CargoSummaryItem *item = summary->Find(new_item);
    00268     if (item == summary->End()) {
    00269       item = summary->Append();
    00270       item->cargo = new_item.cargo;
    00271       item->subtype = new_item.subtype;
    00272       item->capacity = 0;
    00273       item->amount = 0;
    00274       item->source = INVALID_STATION;
    00275     }
    00276
    00277     item->capacity += v->cargo_cap;
    00278     item->amount += v->cargo.Count();
    00279     if (item->source == INVALID_STATION) item->source = v->cargo.Source();
    00280   } while ((v = v->Next()) != NULL && v->IsArticulatedPart());
    00281 }
    00282
    00288 static uint GetLengthOfArticulatedVehicle(const Train *v)
    00289 {
    00290   uint length = 0;
    00291
    00292   do {
    00293     length += v->GetDisplayImageWidth();
    00294   } while ((v = v->Next()) != NULL && v->IsArticulatedPart());
    00295
    00296   return length;
    00297 }
    00298
    00305 int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab)
    00306 {
    00307   int num = 0;
    00308
    00309   if (det_tab == TDW_TAB_TOTALS) { // Total cargo tab
    00310     CargoArray act_cargo;
    00311     CargoArray max_cargo;
    00312     for (const Vehicle *v = Vehicle::Get(veh_id); v != NULL; v = v->Next()) {
    00313       act_cargo[v->cargo_type] += v->cargo.Count();
    00314       max_cargo[v->cargo_type] += v->cargo_cap;
    00315     }
    00316
    00317     /* Set scroll-amount seperately from counting, as to not compute num double
    00318      * for more carriages of the same type
    00319      */
    00320     for (CargoID i = 0; i < NUM_CARGO; i++) {
    00321       if (max_cargo[i] > 0) num++; // only count carriages that the train has
    00322     }
    00323     num++; // needs one more because first line is description string
    00324   } else {
    00325     for (const Train *v = Train::Get(veh_id); v != NULL; v = v->GetNextVehicle()) {
    00326       GetCargoSummaryOfArticulatedVehicle(v, &_cargo_summary);
    00327       num += max(1u, _cargo_summary.Length());
    00328
    00329       uint length = GetLengthOfArticulatedVehicle(v);
    00330       if (length > TRAIN_DETAILS_MAX_INDENT) num++;
    00331     }
    00332   }
    00333
    00334   return num;
    00335 }
    00336
    00348 void DrawTrainDetails(const Train *v, int left, int right, int y, int vscroll_pos, uint16 vscroll_cap, TrainDetailsWindowTabs det_tab)
    00349 {
    00350   /* draw the first 3 details tabs */
    00351   if (det_tab != TDW_TAB_TOTALS) {
    00352     bool rtl = _current_text_dir == TD_RTL;
    00353     Direction dir = rtl ? DIR_E : DIR_W;
    00354     int x = rtl ? right : left;
    00355     int sprite_y_offset = 4 + (FONT_HEIGHT_NORMAL - 10) / 2;
    00356     int line_height = WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM;
    00357     for (; v != NULL && vscroll_pos > -vscroll_cap; v = v->GetNextVehicle()) {
    00358       GetCargoSummaryOfArticulatedVehicle(v, &_cargo_summary);
    00359
    00360       /* Draw sprites */
    00361       uint dx = 0;
    00362       int px = x;
    00363       const Train *u = v;
    00364       do {
    00365         Point offset;
    00366         int width = u->GetDisplayImageWidth(&offset);
    00367         if (vscroll_pos <= 0 && vscroll_pos > -vscroll_cap) {
    00368           PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
    00369           DrawSprite(u->GetImage(dir, EIT_IN_DETAILS), pal, px + (rtl ? -offset.x : offset.x), y - line_height * vscroll_pos + sprite_y_offset + offset.y);
    00370         }
    00371         px += rtl ? -width : width;
    00372         dx += width;
    00373         u = u->Next();
    00374       } while (u != NULL && u->IsArticulatedPart());
    00375
    00376       bool separate_sprite_row = (dx > TRAIN_DETAILS_MAX_INDENT);
    00377       if (separate_sprite_row) {
    00378         vscroll_pos--;
    00379         dx = 0;
    00380       }
    00381
    00382       uint num_lines = max(1u, _cargo_summary.Length());
    00383       for (uint i = 0; i < num_lines; i++) {
    00384         int sprite_width = max<int>(dx, TRAIN_DETAILS_MIN_INDENT) + 3;
    00385         int data_left  = left + (rtl ? 0 : sprite_width);
    00386         int data_right = right - (rtl ? sprite_width : 0);
    00387         if (vscroll_pos <= 0 && vscroll_pos > -vscroll_cap) {
    00388           int py = y - line_height * vscroll_pos;
    00389           if (i > 0 || separate_sprite_row) {
    00390             if (vscroll_pos != 0) GfxFillRect(left, py - WD_MATRIX_TOP - 1, right, py - WD_MATRIX_TOP, _colour_gradient[COLOUR_GREY][5]);
    00391           }
    00392           switch (det_tab) {
    00393             case TDW_TAB_CARGO:
    00394               if (i < _cargo_summary.Length()) {
    00395                 TrainDetailsCargoTab(&_cargo_summary[i], data_left, data_right, py);
    00396               } else {
    00397                 DrawString(data_left, data_right, py, STR_QUANTITY_N_A, TC_LIGHT_BLUE);
    00398               }
    00399               break;
    00400
    00401             case TDW_TAB_INFO:
    00402               if (i == 0) TrainDetailsInfoTab(v, data_left, data_right, py);
    00403               break;
    00404
    00405             case TDW_TAB_CAPACITY:
    00406               if (i < _cargo_summary.Length()) {
    00407                 TrainDetailsCapacityTab(&_cargo_summary[i], data_left, data_right, py);
    00408               } else {
    00409                 SetDParam(0, STR_EMPTY);
    00410                 DrawString(data_left, data_right, py, STR_VEHICLE_INFO_NO_CAPACITY);
    00411               }
    00412               break;
    00413
    00414             default: NOT_REACHED();
    00415           }
    00416         }
    00417         vscroll_pos--;
    00418       }
    00419     }
    00420   } else {
    00421     CargoArray act_cargo;
    00422     CargoArray max_cargo;
    00423     Money feeder_share = 0;
    00424
    00425     for (const Vehicle *u = v; u != NULL; u = u->Next()) {
    00426       act_cargo[u->cargo_type] += u->cargo.Count();
    00427       max_cargo[u->cargo_type] += u->cargo_cap;
    00428       feeder_share             += u->cargo.FeederShare();
    00429     }
    00430
    00431     /* draw total cargo tab */
    00432     DrawString(left, right, y, STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY_TEXT);
    00433     y += WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM;
    00434
    00435     for (CargoID i = 0; i < NUM_CARGO; i++) {
    00436       if (max_cargo[i] > 0 && --vscroll_pos < 0 && vscroll_pos > -vscroll_cap) {
    00437         SetDParam(0, i);            // {CARGO} #1
    00438         SetDParam(1, act_cargo[i]); // {CARGO} #2
    00439         SetDParam(2, i);            // {SHORTCARGO} #1
    00440         SetDParam(3, max_cargo[i]); // {SHORTCARGO} #2
    00441         SetDParam(4, _settings_game.vehicle.freight_trains);
    00442         DrawString(left, right, y, FreightWagonMult(i) > 1 ? STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY_MULT : STR_VEHICLE_DETAILS_TRAIN_TOTAL_CAPACITY);
    00443         y += WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM;
    00444       }
    00445     }
    00446     SetDParam(0, feeder_share);
    00447     DrawString(left, right, y, STR_VEHICLE_INFO_FEEDER_CARGO_VALUE);
    00448   }
    00449 }