vehicle_gui.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef VEHICLE_GUI_H
#define VEHICLE_GUI_H
 
#include "window_type.h"
#include "vehicle_type.h"
#include "vehicle_gui_base.h"
#include "vehiclelist.h"
#include "order_type.h"
#include "station_type.h"
#include "engine_type.h"
#include "company_type.h"
 
void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit = false);
 
enum TrainDetailsWindowTabs : uint8_t {
  TDW_TAB_CARGO = 0, 
  TDW_TAB_INFO,      
  TDW_TAB_CAPACITY,  
  TDW_TAB_TOTALS,    
};
DECLARE_ENUM_AS_ADDABLE(TrainDetailsWindowTabs)
 
 
enum VehicleInvalidateWindowData {
  VIWD_REMOVE_ALL_ORDERS = -1, 
  VIWD_MODIFY_ORDERS     = -2, 
  VIWD_CONSIST_CHANGED   = -3, 
  VIWD_AUTOREPLACE       = -4, 
};
 
struct TestedEngineDetails {
  Money cost;           
  CargoID cargo;        
  uint capacity;        
  uint16_t mail_capacity; 
  CargoArray all_capacities{}; 
 
  void FillDefaultCapacities(const Engine *e);
};
 
int DrawVehiclePurchaseInfo(int left, int right, int y, EngineID engine_number, TestedEngineDetails &te);
 
void DrawTrainImage(const Train *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip, VehicleID drag_dest = INVALID_VEHICLE);
void DrawRoadVehImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip = 0);
void DrawShipImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type);
void DrawAircraftImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type);
 
void ShowBuildVehicleWindow(TileIndex tile, VehicleType type);
 
uint ShowRefitOptionsList(int left, int right, int y, EngineID engine);
StringID GetCargoSubtypeText(const Vehicle *v);
 
void ShowVehicleListWindow(const Vehicle *v);
void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type);
void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station);
void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile);
 
inline uint GetVehicleHeight(VehicleType type)
{
  return (type == VEH_TRAIN || type == VEH_ROAD) ? 14 : 24;
}
 
int GetSingleVehicleWidth(const Vehicle *v, EngineImageType image_type);
int GetVehicleWidth(const Vehicle *v, EngineImageType image_type);
 
struct VehicleCellSize {
  uint height;       
  uint extend_left;  
  uint extend_right; 
};
 
VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type);
 
inline WindowClass GetWindowClassForVehicleType(VehicleType vt)
{
  switch (vt) {
    default: NOT_REACHED();
    case VEH_TRAIN:    return WC_TRAINS_LIST;
    case VEH_ROAD:     return WC_ROADVEH_LIST;
    case VEH_SHIP:     return WC_SHIPS_LIST;
    case VEH_AIRCRAFT: return WC_AIRCRAFT_LIST;
  }
}
 
/* Unified window procedure */
void ShowVehicleViewWindow(const Vehicle *v);
bool VehicleClicked(const Vehicle *v);
bool VehicleClicked(VehicleList::const_iterator begin, VehicleList::const_iterator end);
bool VehicleClicked(const GUIVehicleGroup &vehgroup);
void StartStopVehicle(const Vehicle *v, bool texteffect);
 
Vehicle *CheckClickOnVehicle(const struct Viewport *vp, int x, int y);
void StopGlobalFollowVehicle(const Vehicle *v);
 
void DrawVehicleImage(const Vehicle *v, const Rect &r, VehicleID selection, EngineImageType image_type, int skip);
void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type);
 
#endif /* VEHICLE_GUI_H */