tron@2186: /* $Id$ */
tron@2186: 
rubidium@8597: /** @file track_type.h All types related to tracks */
matthijs@1942: 
rubidium@8597: #ifndef TRACK_TYPE_H
rubidium@8597: #define TRACK_TYPE_H
tron@4041: 
rubidium@8759: #include "core/enum_type.hpp"
rubidium@8759: 
rubidium@7892: /**
rubidium@7892:  * These are used to specify a single track.
rubidium@7892:  * Can be translated to a trackbit with TrackToTrackbit
rubidium@7892:  */
rubidium@6574: enum Track {
rubidium@7892: 	TRACK_BEGIN = 0,        ///< Used for iterations
rubidium@7892: 	TRACK_X     = 0,        ///< Track along the x-axis (north-east to south-west)
rubidium@7892: 	TRACK_Y     = 1,        ///< Track along the y-axis (north-west to south-east)
rubidium@7892: 	TRACK_UPPER = 2,        ///< Track in the upper corner of the tile (north)
rubidium@7892: 	TRACK_LOWER = 3,        ///< Track in the lower corner of the tile (south)
rubidium@7892: 	TRACK_LEFT  = 4,        ///< Track in the left corner of the tile (west)
rubidium@7892: 	TRACK_RIGHT = 5,        ///< Track in the right corner of the tile (east)
rubidium@7892: 	TRACK_END,              ///< Used for iterations
rubidium@7892: 	INVALID_TRACK = 0xFF    ///< Flag for an invalid track
rubidium@6574: };
tron@4041: 
rubidium@5838: /** Allow incrementing of Track variables */
rubidium@5838: DECLARE_POSTFIX_INCREMENT(Track);
rubidium@5838: /** Define basic enum properties */
rubidium@5838: template <> struct EnumPropsT<Track> : MakeEnumPropsT<Track, byte, TRACK_BEGIN, TRACK_END, INVALID_TRACK> {};
rubidium@5838: typedef TinyEnumT<Track> TrackByte;
rubidium@5838: 
tron@4041: 
tron@4041: /** Bitfield corresponding to Track */
rubidium@6574: enum TrackBits {
rubidium@7892: 	TRACK_BIT_NONE    = 0U,                                                 ///< No track
rubidium@7892: 	TRACK_BIT_X       = 1U << TRACK_X,                                      ///< X-axis track
rubidium@7892: 	TRACK_BIT_Y       = 1U << TRACK_Y,                                      ///< Y-axis track
rubidium@7892: 	TRACK_BIT_UPPER   = 1U << TRACK_UPPER,                                  ///< Upper track
rubidium@7892: 	TRACK_BIT_LOWER   = 1U << TRACK_LOWER,                                  ///< Lower track
rubidium@7892: 	TRACK_BIT_LEFT    = 1U << TRACK_LEFT,                                   ///< Left track
rubidium@7892: 	TRACK_BIT_RIGHT   = 1U << TRACK_RIGHT,                                  ///< Right track
rubidium@7892: 	TRACK_BIT_CROSS   = TRACK_BIT_X     | TRACK_BIT_Y,                      ///< X-Y-axis cross
rubidium@7892: 	TRACK_BIT_HORZ    = TRACK_BIT_UPPER | TRACK_BIT_LOWER,                  ///< Upper and lower track
rubidium@7892: 	TRACK_BIT_VERT    = TRACK_BIT_LEFT  | TRACK_BIT_RIGHT,                  ///< Left and right track
rubidium@7892: 	TRACK_BIT_3WAY_NE = TRACK_BIT_X     | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,///< "Arrow" to the north-east
rubidium@7892: 	TRACK_BIT_3WAY_SE = TRACK_BIT_Y     | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,///< "Arrow" to the south-east
rubidium@7892: 	TRACK_BIT_3WAY_SW = TRACK_BIT_X     | TRACK_BIT_LOWER | TRACK_BIT_LEFT, ///< "Arrow" to the south-west
rubidium@7892: 	TRACK_BIT_3WAY_NW = TRACK_BIT_Y     | TRACK_BIT_UPPER | TRACK_BIT_LEFT, ///< "Arrow" to the north-west
rubidium@7892: 	TRACK_BIT_ALL     = TRACK_BIT_CROSS | TRACK_BIT_HORZ  | TRACK_BIT_VERT, ///< All possible tracks
rubidium@7892: 	TRACK_BIT_MASK    = 0x3FU,                                              ///< Bitmask for the first 6 bits
rubidium@7892: 	TRACK_BIT_WORMHOLE = 0x40U,                                             ///< Bitflag for a wormhole (used for tunnels)
rubidium@7892: 	TRACK_BIT_DEPOT   = 0x80U,                                              ///< Bitflag for a depot
rubidium@7892: 	INVALID_TRACK_BIT = 0xFF                                                ///< Flag for an invalid trackbits value
rubidium@6574: };
tron@4041: 
rubidium@5838: /** Define basic enum properties */
rubidium@5838: template <> struct EnumPropsT<TrackBits> : MakeEnumPropsT<TrackBits, byte, TRACK_BIT_NONE, TRACK_BIT_ALL, INVALID_TRACK_BIT> {};
rubidium@5838: typedef TinyEnumT<TrackBits> TrackBitsByte;
rubidium@5838: 
rubidium@5838: DECLARE_ENUM_AS_BIT_SET(TrackBits);
tron@4041: 
tron@4158: /**
rubidium@7892:  * Enumeration for tracks and directions.
rubidium@7892:  *
rubidium@7892:  * These are a combination of tracks and directions. Values are 0-5 in one
rubidium@6325:  * direction (corresponding to the Track enum) and 8-13 in the other direction.
rubidium@6325:  * 6, 7, 14 and 15 are used to encode the reversing of road vehicles. Those
rubidium@6325:  * reversing track dirs are not considered to be 'valid' except in a small
rubidium@6325:  * corner in the road vehicle controller.
rubidium@6325:  */
rubidium@6574: enum Trackdir {
rubidium@7892: 	TRACKDIR_BEGIN    =  0,         ///< Used for iterations
rubidium@7892: 	TRACKDIR_X_NE     =  0,         ///< X-axis and direction to north-east
rubidium@7892: 	TRACKDIR_Y_SE     =  1,         ///< Y-axis and direction to south-east
rubidium@7892: 	TRACKDIR_UPPER_E  =  2,         ///< Upper track and direction to east
rubidium@7892: 	TRACKDIR_LOWER_E  =  3,         ///< Lower track and direction to east
rubidium@7892: 	TRACKDIR_LEFT_S   =  4,         ///< Left track and direction to south
rubidium@7892: 	TRACKDIR_RIGHT_S  =  5,         ///< Right track and direction to south
rubidium@7892: 	TRACKDIR_RVREV_NE =  6,         ///< (Road vehicle) reverse direction north-east
rubidium@7892: 	TRACKDIR_RVREV_SE =  7,         ///< (Road vehicle) reverse direction south-east
rubidium@7892: 	TRACKDIR_X_SW     =  8,         ///< X-axis and direction to south-west
rubidium@7892: 	TRACKDIR_Y_NW     =  9,         ///< Y-axis and direction to north-west
rubidium@7892: 	TRACKDIR_UPPER_W  = 10,         ///< Upper track and direction to west
rubidium@7892: 	TRACKDIR_LOWER_W  = 11,         ///< Lower track and direction to west
rubidium@7892: 	TRACKDIR_LEFT_N   = 12,         ///< Left track and direction to north
rubidium@7892: 	TRACKDIR_RIGHT_N  = 13,         ///< Right track and direction to north
rubidium@7892: 	TRACKDIR_RVREV_SW = 14,         ///< (Road vehicle) reverse direction south-west
rubidium@7892: 	TRACKDIR_RVREV_NW = 15,         ///< (Road vehicle) reverse direction north-west
rubidium@7892: 	TRACKDIR_END,                   ///< Used for iterations
rubidium@7892: 	INVALID_TRACKDIR  = 0xFF,       ///< Flag for an invalid trackdir
rubidium@6574: };
matthijs@1942: 
rubidium@5838: /** Define basic enum properties */
rubidium@5838: template <> struct EnumPropsT<Trackdir> : MakeEnumPropsT<Trackdir, byte, TRACKDIR_BEGIN, TRACKDIR_END, INVALID_TRACKDIR> {};
rubidium@5838: typedef TinyEnumT<Trackdir> TrackdirByte;
rubidium@5838: 
rubidium@7892: /**
rubidium@7892:  * Enumeration of bitmasks for the TrackDirs
rubidium@7892:  *
rubidium@7892:  * These are a combination of tracks and directions. Values are 0-5 in one
rubidium@7892:  * direction (corresponding to the Track enum) and 8-13 in the other direction.
rubidium@7892:  */
rubidium@6574: enum TrackdirBits {
rubidium@7892: 	TRACKDIR_BIT_NONE     = 0x0000, ///< No track build
rubidium@7892: 	TRACKDIR_BIT_X_NE     = 0x0001, ///< Track x-axis, direction north-east
rubidium@7892: 	TRACKDIR_BIT_Y_SE     = 0x0002, ///< Track y-axis, direction south-east
rubidium@7892: 	TRACKDIR_BIT_UPPER_E  = 0x0004, ///< Track upper, direction east
rubidium@7892: 	TRACKDIR_BIT_LOWER_E  = 0x0008, ///< Track lower, direction east
rubidium@7892: 	TRACKDIR_BIT_LEFT_S   = 0x0010, ///< Track left, direction south
rubidium@7892: 	TRACKDIR_BIT_RIGHT_S  = 0x0020, ///< Track right, direction south
matthijs@1942: 	/* Again, note the two missing values here. This enables trackdir -> track conversion by doing (trackdir & 0xFF) */
rubidium@7892: 	TRACKDIR_BIT_X_SW     = 0x0100, ///< Track x-axis, direction south-west
rubidium@7892: 	TRACKDIR_BIT_Y_NW     = 0x0200, ///< Track y-axis, direction north-west
rubidium@7892: 	TRACKDIR_BIT_UPPER_W  = 0x0400, ///< Track upper, direction west
rubidium@7892: 	TRACKDIR_BIT_LOWER_W  = 0x0800, ///< Track lower, direction west
rubidium@7892: 	TRACKDIR_BIT_LEFT_N   = 0x1000, ///< Track left, direction north
rubidium@7892: 	TRACKDIR_BIT_RIGHT_N  = 0x2000, ///< Track right, direction north
rubidium@7892: 	TRACKDIR_BIT_MASK     = 0x3F3F, ///< Bitmask for bit-operations
rubidium@7892: 	INVALID_TRACKDIR_BIT  = 0xFFFF, ///< Flag for an invalid trackdirbit value
rubidium@6574: };
matthijs@1942: 
rubidium@5838: /** Define basic enum properties */
rubidium@5838: template <> struct EnumPropsT<TrackdirBits> : MakeEnumPropsT<TrackdirBits, uint16, TRACKDIR_BIT_NONE, TRACKDIR_BIT_MASK, INVALID_TRACKDIR_BIT> {};
rubidium@5838: typedef TinyEnumT<TrackdirBits> TrackdirBitsShort;
rubidium@5838: DECLARE_ENUM_AS_BIT_SET(TrackdirBits);
rubidium@5838: 
frosch@9112: typedef uint32 TrackStatus;
frosch@9112: 
rubidium@8599: #endif /* TRACK_TYPE_H */