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

enum Track : uint8_t {
  TRACK_BEGIN = 0,        
  TRACK_X     = 0,        
  TRACK_Y     = 1,        
  TRACK_UPPER = 2,        
  TRACK_LOWER = 3,        
  TRACK_LEFT  = 4,        
  TRACK_RIGHT = 5,        
  TRACK_END,              
  INVALID_TRACK = 0xFF,   
};

DECLARE_INCREMENT_DECREMENT_OPERATORS(Track)
 

template <typename T>
using TrackIndexArray = EnumIndexArray<T, Track, TRACK_END>;

enum TrackBits : uint8_t {
  TRACK_BIT_NONE    = 0U,                                                 
  TRACK_BIT_X       = 1U << TRACK_X,                                      
  TRACK_BIT_Y       = 1U << TRACK_Y,                                      
  TRACK_BIT_UPPER   = 1U << TRACK_UPPER,                                  
  TRACK_BIT_LOWER   = 1U << TRACK_LOWER,                                  
  TRACK_BIT_LEFT    = 1U << TRACK_LEFT,                                   
  TRACK_BIT_RIGHT   = 1U << TRACK_RIGHT,                                  
  TRACK_BIT_CROSS   = TRACK_BIT_X     | TRACK_BIT_Y,                      
  TRACK_BIT_HORZ    = TRACK_BIT_UPPER | TRACK_BIT_LOWER,                  
  TRACK_BIT_VERT    = TRACK_BIT_LEFT  | TRACK_BIT_RIGHT,                  
  TRACK_BIT_3WAY_NE = TRACK_BIT_X     | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,
  TRACK_BIT_3WAY_SE = TRACK_BIT_Y     | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,
  TRACK_BIT_3WAY_SW = TRACK_BIT_X     | TRACK_BIT_LOWER | TRACK_BIT_LEFT, 
  TRACK_BIT_3WAY_NW = TRACK_BIT_Y     | TRACK_BIT_UPPER | TRACK_BIT_LEFT, 
  TRACK_BIT_ALL     = TRACK_BIT_CROSS | TRACK_BIT_HORZ  | TRACK_BIT_VERT, 
  TRACK_BIT_MASK    = 0x3FU,                                              
  TRACK_BIT_WORMHOLE = 0x40U,                                             
  TRACK_BIT_DEPOT   = 0x80U,                                              
};
DECLARE_ENUM_AS_BIT_SET(TrackBits)
 

enum Trackdir : uint8_t {
  TRACKDIR_BEGIN    =  0,         
  TRACKDIR_X_NE     =  0,         
  TRACKDIR_Y_SE     =  1,         
  TRACKDIR_UPPER_E  =  2,         
  TRACKDIR_LOWER_E  =  3,         
  TRACKDIR_LEFT_S   =  4,         
  TRACKDIR_RIGHT_S  =  5,         
  TRACKDIR_RVREV_NE =  6,         
  TRACKDIR_RVREV_SE =  7,         
  TRACKDIR_X_SW     =  8,         
  TRACKDIR_Y_NW     =  9,         
  TRACKDIR_UPPER_W  = 10,         
  TRACKDIR_LOWER_W  = 11,         
  TRACKDIR_LEFT_N   = 12,         
  TRACKDIR_RIGHT_N  = 13,         
  TRACKDIR_RVREV_SW = 14,         
  TRACKDIR_RVREV_NW = 15,         
  TRACKDIR_END,                   
  INVALID_TRACKDIR  = 0xFF,       
};

DECLARE_INCREMENT_DECREMENT_OPERATORS(Trackdir)
 

template <typename T>
using TrackdirIndexArray = EnumIndexArray<T, Trackdir, TRACKDIR_END>;

enum TrackdirBits : uint16_t {
  TRACKDIR_BIT_NONE     = 0U,                     
  TRACKDIR_BIT_X_NE     = 1U << TRACKDIR_X_NE,    
  TRACKDIR_BIT_Y_SE     = 1U << TRACKDIR_Y_SE,    
  TRACKDIR_BIT_UPPER_E  = 1U << TRACKDIR_UPPER_E, 
  TRACKDIR_BIT_LOWER_E  = 1U << TRACKDIR_LOWER_E, 
  TRACKDIR_BIT_LEFT_S   = 1U << TRACKDIR_LEFT_S,  
  TRACKDIR_BIT_RIGHT_S  = 1U << TRACKDIR_RIGHT_S, 
  /* Again, note the two missing values here. This enables trackdir -> track conversion by doing (trackdir & 0xFF) */
  TRACKDIR_BIT_X_SW     = 1U << TRACKDIR_X_SW,    
  TRACKDIR_BIT_Y_NW     = 1U << TRACKDIR_Y_NW,    
  TRACKDIR_BIT_UPPER_W  = 1U << TRACKDIR_UPPER_W, 
  TRACKDIR_BIT_LOWER_W  = 1U << TRACKDIR_LOWER_W, 
  TRACKDIR_BIT_LEFT_N   = 1U << TRACKDIR_LEFT_N,  
  TRACKDIR_BIT_RIGHT_N  = 1U << TRACKDIR_RIGHT_N, 
  TRACKDIR_BIT_MASK     = 0x3F3F,                 
  INVALID_TRACKDIR_BIT  = 0xFFFF,                 
};
DECLARE_ENUM_AS_BIT_SET(TrackdirBits)
 

struct TrackStatus {
  TrackdirBits trackdirs; 
  TrackdirBits signals; 
};
 
#endif /* TRACK_TYPE_H */