slope_type.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 SLOPE_TYPE_H
#define SLOPE_TYPE_H
 
#include "core/enum_type.hpp"

enum Corner : uint8_t {
  CORNER_W = 0,
  CORNER_S = 1,
  CORNER_E = 2,
  CORNER_N = 3,
  CORNER_END,
  CORNER_INVALID = 0xFF
};

template <typename T>
using CornerIndexArray = EnumIndexArray<T, Corner, CORNER_END>;

enum Slope : uint8_t {
  SLOPE_FLAT     = 0x00,                                  
  SLOPE_W        = 0x01,                                  
  SLOPE_S        = 0x02,                                  
  SLOPE_E        = 0x04,                                  
  SLOPE_N        = 0x08,                                  
  SLOPE_STEEP    = 0x10,                                  
  SLOPE_NW       = SLOPE_N | SLOPE_W,                     
  SLOPE_SW       = SLOPE_S | SLOPE_W,                     
  SLOPE_SE       = SLOPE_S | SLOPE_E,                     
  SLOPE_NE       = SLOPE_N | SLOPE_E,                     
  SLOPE_EW       = SLOPE_E | SLOPE_W,                     
  SLOPE_NS       = SLOPE_N | SLOPE_S,                     
  SLOPE_ELEVATED = SLOPE_N | SLOPE_E | SLOPE_S | SLOPE_W, 
  SLOPE_NWS      = SLOPE_N | SLOPE_W | SLOPE_S,           
  SLOPE_WSE      = SLOPE_W | SLOPE_S | SLOPE_E,           
  SLOPE_SEN      = SLOPE_S | SLOPE_E | SLOPE_N,           
  SLOPE_ENW      = SLOPE_E | SLOPE_N | SLOPE_W,           
  SLOPE_STEEP_W  = SLOPE_STEEP | SLOPE_NWS,               
  SLOPE_STEEP_S  = SLOPE_STEEP | SLOPE_WSE,               
  SLOPE_STEEP_E  = SLOPE_STEEP | SLOPE_SEN,               
  SLOPE_STEEP_N  = SLOPE_STEEP | SLOPE_ENW,               
 
  SLOPE_HALFTILE = 0x20,                                  
  SLOPE_HALFTILE_MASK = 0xE0,                             
  SLOPE_HALFTILE_W = SLOPE_HALFTILE | (CORNER_W << 6),    
  SLOPE_HALFTILE_S = SLOPE_HALFTILE | (CORNER_S << 6),    
  SLOPE_HALFTILE_E = SLOPE_HALFTILE | (CORNER_E << 6),    
  SLOPE_HALFTILE_N = SLOPE_HALFTILE | (CORNER_N << 6),    
};
DECLARE_ENUM_AS_BIT_SET(Slope)
 

static constexpr uint8_t NUM_SLOPES = 19;

template <typename T>
using SlopeIndexArray = EnumClassIndexContainer<std::array<T, SLOPE_STEEP | SLOPE_ELEVATED>, Slope>;

template <typename T>
using NonSteepSlopeIndexArray = EnumClassIndexContainer<std::array<T, SLOPE_ELEVATED>, Slope>;

#define M(x) (1U << (x))
static const uint32_t VALID_LEVEL_CROSSING_SLOPES = M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT);
#undef M
 

enum class Foundation : uint8_t {
  None, 
  Leveled, 
  InclinedX, 
  InclinedY, 
  SteepLower, 
 
  /* Halftile foundations */
  SteepBoth, 
  HalfTileW, 
  HalfTileS, 
  HalfTileE, 
  HalfTileN, 
  HalfTileEnd, 
 
  /* Special anti-zig-zag foundations for single horizontal/vertical track */
  RailW = Foundation::HalfTileEnd, 
  RailS, 
  RailE, 
  RailN, 
  End, 
 
  Invalid = 0xFF, 
};
 
#endif /* SLOPE_TYPE_H */