livery.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef LIVERY_H
#define LIVERY_H
 
#include "core/enum_type.hpp"
#include "company_type.h"
#include "gfx_type.h"
 
static const uint8_t LIT_NONE    = 0; 
static const uint8_t LIT_COMPANY = 1; 
static const uint8_t LIT_ALL     = 2; 

enum class LiveryScheme : uint8_t {
  Begin = 0, 
  Default = 0, 
 
  /* Rail vehicles */
  Steam, 
  Diesel, 
  Electric, 
  Monorail, 
  Maglev, 
  DMU, 
  EMU, 
  PassengerWagonSteam, 
  PassengerWagonDiesel, 
  PassengerWagonElectric, 
  PassengerWagonMonorail, 
  PassengerWagonMaglev, 
  FreightWagon, 
 
  /* Road vehicles */
  Bus, 
  Truck, 
 
  /* Ships */
  PassengerShip, 
  FreightShip, 
 
  /* Aircraft */
  Helicopter, 
  SmallPlane, 
  LargePlane, 
 
  /* Trams (appear on Road Vehicles tab) */
  PassengerTram, 
  FreightTram, 
 
  End, 
};
 
DECLARE_INCREMENT_DECREMENT_OPERATORS(LiveryScheme)
DECLARE_ENUM_AS_ADDABLE(LiveryScheme)
 

using LiverySchemes = EnumBitSet<LiveryScheme, uint32_t, LiveryScheme::End>;

enum class LiveryClass : uint8_t {
  Other, 
  Rail, 
  Road, 
  Ship, 
  Aircraft, 
  GroupRail, 
  GroupRoad, 
  GroupShip, 
  GroupAircraft, 
};
 
DECLARE_ENUM_AS_ADDABLE(LiveryClass)
 

struct Livery {
  enum class Flag : uint8_t {
    Primary = 0, 
    Secondary = 1, 
  };
  using Flags = EnumBitSet<Flag, uint8_t>;
 
  Flags in_use{}; 
  Colours colour1 = Colours::Begin; 
  Colours colour2 = Colours::Begin; 

  inline uint8_t GetRecolourOffset(bool use_secondary = true) const
  {
    return use_secondary ? to_underlying(this->colour1) + to_underlying(this->colour2) * 16 : to_underlying(this->colour1);
  }
};
 
void ResetCompanyLivery(Company *c);
 
#endif /* LIVERY_H */