# engine_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 "gfx_func.h"
    00015 #include "engine_base.h"
    00016 #include "command_func.h"
    00017 #include "strings_func.h"
    00018 #include "engine_gui.h"
    00019 #include "articulated_vehicles.h"
    00020 #include "vehicle_func.h"
    00021 #include "company_func.h"
    00022 #include "rail.h"
    00023 #include "settings_type.h"
    00024
    00025 #include "table/strings.h"
    00026
    00032 StringID GetEngineCategoryName(EngineID engine)
    00033 {
    00034   const Engine *e = Engine::Get(engine);
    00035   switch (e->type) {
    00036     default: NOT_REACHED();
    00037     case VEH_ROAD:              return STR_ENGINE_PREVIEW_ROAD_VEHICLE;
    00038     case VEH_AIRCRAFT:          return STR_ENGINE_PREVIEW_AIRCRAFT;
    00039     case VEH_SHIP:              return STR_ENGINE_PREVIEW_SHIP;
    00040     case VEH_TRAIN:
    00041       return GetRailTypeInfo(e->u.rail.railtype)->strings.new_loco;
    00042   }
    00043 }
    00044
    00046 enum EnginePreviewWidgets {
    00047   EPW_QUESTION,
    00048   EPW_NO,
    00049   EPW_YES,
    00050 };
    00051
    00052 static const NWidgetPart _nested_engine_preview_widgets[] = {
    00053   NWidget(NWID_HORIZONTAL),
    00054     NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE),
    00055     NWidget(WWT_CAPTION, COLOUR_LIGHT_BLUE), SetDataTip(STR_ENGINE_PREVIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    00056   EndContainer(),
    00057   NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE),
    00058     NWidget(WWT_EMPTY, INVALID_COLOUR, EPW_QUESTION), SetMinimalSize(300, 0), SetPadding(8, 8, 8, 8), SetFill(1, 0),
    00059     NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(85, 10, 85),
    00060       NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, EPW_NO), SetDataTip(STR_QUIT_NO, STR_NULL), SetFill(1, 0),
    00061       NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, EPW_YES), SetDataTip(STR_QUIT_YES, STR_NULL), SetFill(1, 0),
    00062     EndContainer(),
    00063     NWidget(NWID_SPACER), SetMinimalSize(0, 8),
    00064   EndContainer(),
    00065 };
    00066
    00067 struct EnginePreviewWindow : Window {
    00068   static const int VEHICLE_SPACE = 40; // The space to show the vehicle image
    00069
    00070   EnginePreviewWindow(const WindowDesc *desc, WindowNumber window_number) : Window()
    00071   {
    00072     this->InitNested(desc, window_number);
    00073   }
    00074
    00075   virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
    00076   {
    00077     if (widget != EPW_QUESTION) return;
    00078
    00079     EngineID engine = this->window_number;
    00080     SetDParam(0, GetEngineCategoryName(engine));
    00081     size->height = GetStringHeight(STR_ENGINE_PREVIEW_MESSAGE, size->width) + WD_PAR_VSEP_WIDE + FONT_HEIGHT_NORMAL + VEHICLE_SPACE;
    00082     SetDParam(0, engine);
    00083     size->height += GetStringHeight(GetEngineInfoString(engine), size->width);
    00084   }
    00085
    00086   virtual void DrawWidget(const Rect &r, int widget) const
    00087   {
    00088     if (widget != EPW_QUESTION) return;
    00089
    00090     EngineID engine = this->window_number;
    00091     SetDParam(0, GetEngineCategoryName(engine));
    00092     int y = r.top + GetStringHeight(STR_ENGINE_PREVIEW_MESSAGE, r.right - r.top + 1);
    00093     y = DrawStringMultiLine(r.left, r.right, r.top, y, STR_ENGINE_PREVIEW_MESSAGE, TC_FROMSTRING, SA_CENTER) + WD_PAR_VSEP_WIDE;
    00094
    00095     SetDParam(0, engine);
    00096     DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_ENGINE_NAME, TC_BLACK, SA_HOR_CENTER);
    00097     y += FONT_HEIGHT_NORMAL;
    00098
    00099     DrawVehicleEngine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, this->width >> 1, y + VEHICLE_SPACE / 2, engine, GetEnginePalette(engine, _local_company));
    00100
    00101     y += VEHICLE_SPACE;
    00102     DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, r.bottom, GetEngineInfoString(engine), TC_FROMSTRING, SA_CENTER);
    00103   }
    00104
    00105   virtual void OnClick(Point pt, int widget, int click_count)
    00106   {
    00107     switch (widget) {
    00108       case EPW_YES:
    00109         DoCommandP(0, this->window_number, 0, CMD_WANT_ENGINE_PREVIEW);
    00110         /* FALL THROUGH */
    00111       case EPW_NO:
    00112         delete this;
    00113         break;
    00114     }
    00115   }
    00116 };
    00117
    00118 static const WindowDesc _engine_preview_desc(
    00119   WDP_CENTER, 0, 0,
    00120   WC_ENGINE_PREVIEW, WC_NONE,
    00121   WDF_CONSTRUCTION,
    00122   _nested_engine_preview_widgets, lengthof(_nested_engine_preview_widgets)
    00123 );
    00124
    00125
    00126 void ShowEnginePreviewWindow(EngineID engine)
    00127 {
    00128   AllocateWindowDescFront<EnginePreviewWindow>(&_engine_preview_desc, engine);
    00129 }
    00130
    00131 uint GetTotalCapacityOfArticulatedParts(EngineID engine)
    00132 {
    00133   uint total = 0;
    00134
    00135   CargoArray cap = GetCapacityOfArticulatedParts(engine);
    00136   for (CargoID c = 0; c < NUM_CARGO; c++) {
    00137     total += cap[c];
    00138   }
    00139
    00140   return total;
    00141 }
    00142
    00143 static StringID GetTrainEngineInfoString(const Engine *e)
    00144 {
    00145   SetDParam(0, e->GetCost());
    00146   SetDParam(2, e->GetDisplayMaxSpeed());
    00147   SetDParam(3, e->GetPower());
    00148   SetDParam(1, e->GetDisplayWeight());
    00149   SetDParam(7, e->GetDisplayMaxTractiveEffort());
    00150
    00151   SetDParam(4, e->GetRunningCost());
    00152
    00153   uint capacity = GetTotalCapacityOfArticulatedParts(e->index);
    00154   if (capacity != 0) {
    00155     SetDParam(5, e->GetDefaultCargoType());
    00156     SetDParam(6, capacity);
    00157   } else {
    00158     SetDParam(5, CT_INVALID);
    00159   }
    00160   return (_settings_game.vehicle.train_acceleration_model != AM_ORIGINAL && GetRailTypeInfo(e->u.rail.railtype)->acceleration_type != 2) ? STR_ENGINE_PREVIEW_COST_WEIGHT_SPEED_POWER_MAX_TE : STR_ENGINE_PREVIEW_COST_WEIGHT_SPEED_POWER;
    00161 }
    00162
    00163 static StringID GetAircraftEngineInfoString(const Engine *e)
    00164 {
    00165   CargoID cargo = e->GetDefaultCargoType();
    00166   uint16 mail_capacity;
    00167   uint capacity = e->GetDisplayDefaultCapacity(&mail_capacity);
    00168
    00169   SetDParam(0, e->GetCost());
    00170   SetDParam(1, e->GetDisplayMaxSpeed());
    00171   SetDParam(2, cargo);
    00172   SetDParam(3, capacity);
    00173
    00174   if (mail_capacity > 0) {
    00175     SetDParam(4, CT_MAIL);
    00176     SetDParam(5, mail_capacity);
    00177     SetDParam(6, e->GetRunningCost());
    00178     return STR_ENGINE_PREVIEW_COST_MAX_SPEED_CAPACITY_CAPACITY_RUNCOST;
    00179   } else {
    00180     SetDParam(4, e->GetRunningCost());
    00181     return STR_ENGINE_PREVIEW_COST_MAX_SPEED_CAPACITY_RUNCOST;
    00182   }
    00183 }
    00184
    00185 static StringID GetRoadVehEngineInfoString(const Engine *e)
    00186 {
    00187   if (_settings_game.vehicle.roadveh_acceleration_model == AM_ORIGINAL) {
    00188     SetDParam(0, e->GetCost());
    00189     SetDParam(1, e->GetDisplayMaxSpeed());
    00190     uint capacity = GetTotalCapacityOfArticulatedParts(e->index);
    00191     if (capacity != 0) {
    00192       SetDParam(2, e->GetDefaultCargoType());
    00193       SetDParam(3, capacity);
    00194     } else {
    00195       SetDParam(2, CT_INVALID);
    00196     }
    00197     SetDParam(4, e->GetRunningCost());
    00198     return STR_ENGINE_PREVIEW_COST_MAX_SPEED_CAPACITY_RUNCOST;
    00199   } else {
    00200     SetDParam(0, e->GetCost());
    00201     SetDParam(2, e->GetDisplayMaxSpeed());
    00202     SetDParam(3, e->GetPower());
    00203     SetDParam(1, e->GetDisplayWeight());
    00204     SetDParam(7, e->GetDisplayMaxTractiveEffort());
    00205
    00206     SetDParam(4, e->GetRunningCost());
    00207
    00208     uint capacity = GetTotalCapacityOfArticulatedParts(e->index);
    00209     if (capacity != 0) {
    00210       SetDParam(5, e->GetDefaultCargoType());
    00211       SetDParam(6, capacity);
    00212     } else {
    00213       SetDParam(5, CT_INVALID);
    00214     }
    00215     return STR_ENGINE_PREVIEW_COST_WEIGHT_SPEED_POWER_MAX_TE;
    00216   }
    00217 }
    00218
    00219 static StringID GetShipEngineInfoString(const Engine *e)
    00220 {
    00221   SetDParam(0, e->GetCost());
    00222   SetDParam(1, e->GetDisplayMaxSpeed());
    00223   SetDParam(2, e->GetDefaultCargoType());
    00224   SetDParam(3, e->GetDisplayDefaultCapacity());
    00225   SetDParam(4, e->GetRunningCost());
    00226   return STR_ENGINE_PREVIEW_COST_MAX_SPEED_CAPACITY_RUNCOST;
    00227 }
    00228
    00229
    00236 StringID GetEngineInfoString(EngineID engine)
    00237 {
    00238   const Engine *e = Engine::Get(engine);
    00239
    00240   switch (e->type) {
    00241     case VEH_TRAIN:
    00242       return GetTrainEngineInfoString(e);
    00243
    00244     case VEH_ROAD:
    00245       return GetRoadVehEngineInfoString(e);
    00246
    00247     case VEH_SHIP:
    00248       return GetShipEngineInfoString(e);
    00249
    00250     case VEH_AIRCRAFT:
    00251       return GetAircraftEngineInfoString(e);
    00252
    00253     default: NOT_REACHED();
    00254   }
    00255 }
    00256
    00266 void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal)
    00267 {
    00268   const Engine *e = Engine::Get(engine);
    00269
    00270   switch (e->type) {
    00271     case VEH_TRAIN:
    00272       DrawTrainEngine(left, right, preferred_x, y, engine, pal);
    00273       break;
    00274
    00275     case VEH_ROAD:
    00276       DrawRoadVehEngine(left, right, preferred_x, y, engine, pal);
    00277       break;
    00278
    00279     case VEH_SHIP:
    00280       DrawShipEngine(left, right, preferred_x, y, engine, pal);
    00281       break;
    00282
    00283     case VEH_AIRCRAFT:
    00284       DrawAircraftEngine(left, right, preferred_x, y, engine, pal);
    00285       break;
    00286
    00287     default: NOT_REACHED();
    00288   }
    00289 }
    00290
    00296 void EngList_Sort(GUIEngineList *el, EngList_SortTypeFunction compare)
    00297 {
    00298   uint size = el->Length();
    00299   /* out-of-bounds access at the next line for size == 0 (even with operator[] at some systems)
    00300    * generally, do not sort if there are less than 2 items */
    00301   if (size < 2) return;
    00302   QSortT(el->Begin(), size, compare);
    00303 }
    00304
    00312 void EngList_SortPartial(GUIEngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items)
    00313 {
    00314   if (num_items < 2) return;
    00315   assert(begin < el->Length());
    00316   assert(begin + num_items <= el->Length());
    00317   QSortT(el->Get(begin), num_items, compare);
    00318 }
    00319