OpenTTD
Macros | Functions
track_func.h File Reference

Different conversion functions from one kind of track to another. More...

#include "core/bitmath_func.hpp"
#include "track_type.h"
#include "direction_func.h"
#include "slope_func.h"

Go to the source code of this file.

Macros

#define FOR_EACH_SET_TRACK(var, track_bits)   FOR_EACH_SET_BIT_EX(Track, var, TrackBits, track_bits)
 Iterate through each set Track in a TrackBits value. More...
 

Functions

static bool IsValidTrack (Track track)
 Checks if a Track is valid. More...
 
static bool IsValidTrackdirForRoadVehicle (Trackdir trackdir)
 Checks if a Trackdir is valid for road vehicles. More...
 
static bool IsValidTrackdir (Trackdir trackdir)
 Checks if a Trackdir is valid for non-road vehicles. More...
 
static Track AxisToTrack (Axis a)
 Convert an Axis to the corresponding Track AXIS_X -> TRACK_X AXIS_Y -> TRACK_Y Uses the fact that they share the same internal encoding. More...
 
static TrackBits TrackToTrackBits (Track track)
 Maps a Track to the corresponding TrackBits value. More...
 
static TrackBits AxisToTrackBits (Axis a)
 Maps an Axis to the corresponding TrackBits value. More...
 
static TrackBits CornerToTrackBits (Corner corner)
 Returns a single horizontal/vertical trackbit that is in a specific tile corner. More...
 
static TrackdirBits TrackdirToTrackdirBits (Trackdir trackdir)
 Maps a Trackdir to the corresponding TrackdirBits value. More...
 
static Track RemoveFirstTrack (TrackBits *tracks)
 Removes first Track from TrackBits and returns it. More...
 
static Trackdir RemoveFirstTrackdir (TrackdirBits *trackdirs)
 Removes first Trackdir from TrackdirBits and returns it. More...
 
static Track FindFirstTrack (TrackBits tracks)
 Returns first Track from TrackBits or INVALID_TRACK. More...
 
static Track TrackBitsToTrack (TrackBits tracks)
 Converts TrackBits to Track. More...
 
static Trackdir FindFirstTrackdir (TrackdirBits trackdirs)
 Returns first Trackdir from TrackdirBits or INVALID_TRACKDIR. More...
 
static Track TrackToOppositeTrack (Track t)
 Find the opposite track to a given track. More...
 
static Trackdir ReverseTrackdir (Trackdir trackdir)
 Maps a trackdir to the reverse trackdir. More...
 
static Track TrackdirToTrack (Trackdir trackdir)
 Returns the Track that a given Trackdir represents. More...
 
static Trackdir TrackToTrackdir (Track track)
 Returns a Trackdir for the given Track. More...
 
static TrackdirBits TrackToTrackdirBits (Track track)
 Returns a TrackdirBit mask from a given Track. More...
 
static TrackBits TrackdirBitsToTrackBits (TrackdirBits bits)
 Discards all directional information from a TrackdirBits value. More...
 
static TrackdirBits TrackBitsToTrackdirBits (TrackBits bits)
 Converts TrackBits to TrackdirBits while allowing both directions. More...
 
static TrackdirBits TrackStatusToTrackdirBits (TrackStatus ts)
 Returns the present-trackdir-information of a TrackStatus. More...
 
static TrackBits TrackStatusToTrackBits (TrackStatus ts)
 Returns the present-track-information of a TrackStatus. More...
 
static TrackdirBits TrackStatusToRedSignals (TrackStatus ts)
 Returns the red-signal-information of a TrackStatus. More...
 
static TrackStatus CombineTrackStatus (TrackdirBits trackdirbits, TrackdirBits red_signals)
 Builds a TrackStatus. More...
 
static Trackdir NextTrackdir (Trackdir trackdir)
 Maps a trackdir to the trackdir that you will end up on if you go straight ahead. More...
 
static TrackBits TrackCrossesTracks (Track track)
 Maps a track to all tracks that make 90 deg turns with it. More...
 
static DiagDirection TrackdirToExitdir (Trackdir trackdir)
 Maps a trackdir to the (4-way) direction the tile is exited when following that trackdir. More...
 
static Trackdir TrackExitdirToTrackdir (Track track, DiagDirection diagdir)
 Maps a track and an (4-way) dir to the trackdir that represents the track with the exit in the given direction. More...
 
static Trackdir TrackEnterdirToTrackdir (Track track, DiagDirection diagdir)
 Maps a track and an (4-way) dir to the trackdir that represents the track with the entry in the given direction. More...
 
static Trackdir TrackDirectionToTrackdir (Track track, Direction dir)
 Maps a track and a full (8-way) direction to the trackdir that represents the track running in the given direction.
 
static Track DiagDirToDiagTrack (DiagDirection diagdir)
 Maps a (4-way) direction to the diagonal track incidating with that diagdir. More...
 
static TrackBits DiagDirToDiagTrackBits (DiagDirection diagdir)
 Maps a (4-way) direction to the diagonal track bits incidating with that diagdir. More...
 
static Trackdir DiagDirToDiagTrackdir (DiagDirection diagdir)
 Maps a (4-way) direction to the diagonal trackdir that runs in that direction. More...
 
static TrackdirBits DiagdirReachesTrackdirs (DiagDirection diagdir)
 Returns all trackdirs that can be reached when entering a tile from a given (diagonal) direction. More...
 
static TrackBits DiagdirReachesTracks (DiagDirection diagdir)
 Returns all tracks that can be reached when entering a tile from a given (diagonal) direction. More...
 
static TrackdirBits TrackdirReachesTrackdirs (Trackdir trackdir)
 Maps a trackdir to the trackdirs that can be reached from it (ie, when entering the next tile. More...
 
static TrackdirBits TrackdirCrossesTrackdirs (Trackdir trackdir)
 Maps a trackdir to all trackdirs that make 90 deg turns with it. More...
 
static bool IsDiagonalTrack (Track track)
 Checks if a given Track is diagonal. More...
 
static bool IsDiagonalTrackdir (Trackdir trackdir)
 Checks if a given Trackdir is diagonal. More...
 
static bool TracksOverlap (TrackBits bits)
 Checks if the given tracks overlap, ie form a crossing. More...
 
static bool TrackOverlapsTracks (TrackBits tracks, Track track)
 Check if a given track is contained within or overlaps some other tracks. More...
 
static bool IsReversingRoadTrackdir (Trackdir dir)
 Checks whether the trackdir means that we are reversing. More...
 
static bool IsStraightRoadTrackdir (Trackdir dir)
 Checks whether the given trackdir is a straight road. More...
 
static bool IsUphillTrackdir (Slope slope, Trackdir dir)
 Checks whether a trackdir on a specific slope is going uphill. More...
 

Detailed Description

Different conversion functions from one kind of track to another.

Definition in file track_func.h.

Macro Definition Documentation

◆ FOR_EACH_SET_TRACK

#define FOR_EACH_SET_TRACK (   var,
  track_bits 
)    FOR_EACH_SET_BIT_EX(Track, var, TrackBits, track_bits)

Iterate through each set Track in a TrackBits value.

For more informations see FOR_EACH_SET_BIT_EX.

Parameters
varLoop index variable that stores fallowing set track. Must be of type Track.
track_bitsThe value to iterate through (any expression).
See also
FOR_EACH_SET_BIT_EX

Definition at line 29 of file track_func.h.

Function Documentation

◆ AxisToTrack()

static Track AxisToTrack ( Axis  a)
inlinestatic

Convert an Axis to the corresponding Track AXIS_X -> TRACK_X AXIS_Y -> TRACK_Y Uses the fact that they share the same internal encoding.

Parameters
athe axis to convert
Returns
the track corresponding to the axis

Definition at line 76 of file track_func.h.

Referenced by AxisToTrackBits(), GetCrossingRailTrack(), and GetRailStationTrack().

◆ AxisToTrackBits()

static TrackBits AxisToTrackBits ( Axis  a)
inlinestatic

Maps an Axis to the corresponding TrackBits value.

Parameters
athe axis to convert
Returns
the converted TrackBits value of the axis

Definition at line 98 of file track_func.h.

References AxisToTrack(), and TrackToTrackBits().

Referenced by GetCrossingRailBits(), and GetRailStationTrackBits().

◆ CombineTrackStatus()

static TrackStatus CombineTrackStatus ( TrackdirBits  trackdirbits,
TrackdirBits  red_signals 
)
inlinestatic

Builds a TrackStatus.

Parameters
trackdirbitspresent trackdirs
red_signalsred signals
Returns
the TrackStatus representing the given information

Definition at line 376 of file track_func.h.

◆ CornerToTrackBits()

static TrackBits CornerToTrackBits ( Corner  corner)
inlinestatic

Returns a single horizontal/vertical trackbit that is in a specific tile corner.

Parameters
cornerThe corner of a tile.
Returns
The TrackBits of the track in the corner.

Definition at line 109 of file track_func.h.

Referenced by GetRailFoundation().

◆ DiagdirReachesTrackdirs()

static TrackdirBits DiagdirReachesTrackdirs ( DiagDirection  diagdir)
inlinestatic

Returns all trackdirs that can be reached when entering a tile from a given (diagonal) direction.

This will obviously include 90 degree turns, since no information is available about the exact angle of entering

Parameters
diagdirThe joining direction
Returns
The TrackdirBits which can be used from the given direction
See also
DiagdirReachesTracks

Definition at line 543 of file track_func.h.

Referenced by DiagdirReachesTracks(), MaskWireBits(), RoadFindPathToDest(), TrainCheckIfLineEnds(), CYapfFollowShipT< Types >::TransportTypeChar(), and CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::TryReverse().

◆ DiagdirReachesTracks()

static TrackBits DiagdirReachesTracks ( DiagDirection  diagdir)
inlinestatic

Returns all tracks that can be reached when entering a tile from a given (diagonal) direction.

This will obviously include 90 degree turns, since no information is available about the exact angle of entering

Parameters
diagdirThe joining direction
Returns
The tracks which can be used
See also
DiagdirReachesTrackdirs

Definition at line 561 of file track_func.h.

References DiagdirReachesTrackdirs(), and TrackdirBitsToTrackBits().

Referenced by MaskWireBits(), and PlaceExtraDepotRail().

◆ DiagDirToDiagTrack()

static Track DiagDirToDiagTrack ( DiagDirection  diagdir)
inlinestatic

Maps a (4-way) direction to the diagonal track incidating with that diagdir.

Parameters
diagdirThe direction
Returns
The resulting Track

Definition at line 500 of file track_func.h.

Referenced by CmdConvertRail(), GetRailDepotTrack(), and Train::ReserveTrackUnderConsist().

◆ DiagDirToDiagTrackBits()

static TrackBits DiagDirToDiagTrackBits ( DiagDirection  diagdir)
inlinestatic

Maps a (4-way) direction to the diagonal track bits incidating with that diagdir.

Parameters
diagdirThe direction
Returns
The resulting TrackBits

Definition at line 512 of file track_func.h.

Referenced by CollectTrackbitsFromCrashedVehiclesEnum(), DeleteLastWagon(), GetRailTrackBitsUniversal(), and GetTunnelBridgeReservationTrackBits().

◆ DiagDirToDiagTrackdir()

static Trackdir DiagDirToDiagTrackdir ( DiagDirection  diagdir)
inlinestatic

Maps a (4-way) direction to the diagonal trackdir that runs in that direction.

Parameters
diagdirThe direction
Returns
The resulting Trackdir direction

Definition at line 525 of file track_func.h.

Referenced by FollowReservation(), Ship::GetVehicleTrackdir(), RoadVehicle::GetVehicleTrackdir(), Train::GetVehicleTrackdir(), and CYapfCostRoadT< Types >::PfCalcCost().

◆ FindFirstTrack()

static Track FindFirstTrack ( TrackBits  tracks)
inlinestatic

Returns first Track from TrackBits or INVALID_TRACK.

This function returns the first Track found in the TrackBits value as Track-value. It returns INVALID_TRACK if the parameter is TRACK_BIT_NONE or INVALID_TRACK_BIT.

Parameters
tracksThe TrackBits value
Returns
The first Track found or INVALID_TRACK
See also
RemoveFirstTrack

Definition at line 187 of file track_func.h.

References FIND_FIRST_BIT, INVALID_TRACK, INVALID_TRACK_BIT, and TRACK_BIT_NONE.

Referenced by Ship::GetVehicleTrackdir(), Train::GetVehicleTrackdir(), TrainCheckIfLineEnds(), and YapfTrainChooseTrack().

◆ FindFirstTrackdir()

static Trackdir FindFirstTrackdir ( TrackdirBits  trackdirs)
inlinestatic

Returns first Trackdir from TrackdirBits or INVALID_TRACKDIR.

This function returns the first Trackdir in the given TrackdirBits value or INVALID_TRACKDIR if the value is TRACKDIR_BIT_NONE. The TrackdirBits must not be INVALID_TRACKDIR_BIT.

Parameters
trackdirsThe TrackdirBits value
Returns
The first Trackdir from the TrackdirBits or INVALID_TRACKDIR on TRACKDIR_BIT_NONE.
Precondition
trackdirs must not be INVALID_TRACKDIR_BIT
See also
RemoveFirstTrackdir

Definition at line 221 of file track_func.h.

Referenced by ExtendTrainReservation(), and FollowReservation().

◆ IsDiagonalTrack()

static bool IsDiagonalTrack ( Track  track)
inlinestatic

Checks if a given Track is diagonal.

Parameters
trackThe given track to check
Returns
true if diagonal, else false

Definition at line 607 of file track_func.h.

◆ IsDiagonalTrackdir()

static bool IsDiagonalTrackdir ( Trackdir  trackdir)
inlinestatic

Checks if a given Trackdir is diagonal.

Parameters
trackdirThe given trackdir
Returns
true if the trackdir use a diagonal track

Definition at line 619 of file track_func.h.

Referenced by CYapfCostRoadT< Types >::OneTileCost(), CYapfCostRailT< Types >::OneTileCost(), CYapfCostShipT< Types >::PfCalcCost(), and CYapfCostBase::stSlopeCost().

◆ IsReversingRoadTrackdir()

static bool IsReversingRoadTrackdir ( Trackdir  dir)
inlinestatic

Checks whether the trackdir means that we are reversing.

Parameters
dirthe trackdir to check
Returns
true if it is a reversing road trackdir

Definition at line 661 of file track_func.h.

Referenced by RoadVehicle::GetVehicleTrackdir(), and RoadVehicle::HasToUseGetSlopePixelZ().

◆ IsStraightRoadTrackdir()

static bool IsStraightRoadTrackdir ( Trackdir  dir)
inlinestatic

Checks whether the given trackdir is a straight road.

Parameters
dirthe trackdir to check
Returns
true if it is a straight road trackdir

Definition at line 672 of file track_func.h.

◆ IsUphillTrackdir()

static bool IsUphillTrackdir ( Slope  slope,
Trackdir  dir 
)
inlinestatic

Checks whether a trackdir on a specific slope is going uphill.

Valid for rail and road tracks. Valid for tile-slopes (under foundation) and foundation-slopes (on foundation).

Parameters
slopeThe slope of the tile.
dirThe trackdir of interest.
Returns
true iff the track goes upwards.

Definition at line 688 of file track_func.h.

Referenced by CYapfCostBase::stSlopeCost().

◆ IsValidTrack()

static bool IsValidTrack ( Track  track)
inlinestatic

Checks if a Track is valid.

Parameters
trackThe value to check
Returns
true if the given value is a valid track.
Note
Use this in an assert()

Definition at line 38 of file track_func.h.

References TRACK_END.

◆ IsValidTrackdir()

static bool IsValidTrackdir ( Trackdir  trackdir)
inlinestatic

Checks if a Trackdir is valid for non-road vehicles.

Parameters
trackdirThe value to check
Returns
true if the given value is a valid Trackdir
Note
Use this in an assert()

Definition at line 62 of file track_func.h.

References TRACKDIR_BIT_MASK.

◆ IsValidTrackdirForRoadVehicle()

static bool IsValidTrackdirForRoadVehicle ( Trackdir  trackdir)
inlinestatic

Checks if a Trackdir is valid for road vehicles.

Parameters
trackdirThe value to check
Returns
true if the given value is a valid Trackdir
Note
Use this in an assert()

Definition at line 50 of file track_func.h.

References TRACKDIR_END.

◆ NextTrackdir()

static Trackdir NextTrackdir ( Trackdir  trackdir)
inlinestatic

Maps a trackdir to the trackdir that you will end up on if you go straight ahead.

This will be the same trackdir for diagonal trackdirs, but a different (alternating) one for straight trackdirs

Parameters
trackdirThe given trackdir
Returns
The next Trackdir value of the next tile.

Definition at line 391 of file track_func.h.

Referenced by CYapfCostShipT< Types >::PfCalcCost().

◆ RemoveFirstTrack()

static Track RemoveFirstTrack ( TrackBits tracks)
inlinestatic

Removes first Track from TrackBits and returns it.

This function searchs for the first bit in the TrackBits, remove this bit from the parameter and returns the found bit as Track value. It returns INVALID_TRACK if the parameter was TRACK_BIT_NONE or INVALID_TRACK_BIT. This is basically used in while-loops to get up to 6 possible tracks on a tile until the parameter becomes TRACK_BIT_NONE.

Parameters
tracksThe value with the TrackBits
Returns
The first Track from the TrackBits value
See also
FindFirstTrack

Definition at line 141 of file track_func.h.

References INVALID_TRACK_BIT, and TRACK_BIT_NONE.

Referenced by CmdConvertRail().

◆ RemoveFirstTrackdir()

static Trackdir RemoveFirstTrackdir ( TrackdirBits trackdirs)
inlinestatic

Removes first Trackdir from TrackdirBits and returns it.

This function searches for the first bit in the TrackdirBits parameter, remove this bit from the parameter and returns the fnound bit as Trackdir value. It returns INVALID_TRACKDIR if the trackdirs is TRACKDIR_BIT_NONE or INVALID_TRACKDIR_BIT. This is basically used in a while-loop to get all track-directions step by step until the value reaches TRACKDIR_BIT_NONE.

Parameters
trackdirsThe value with the TrackdirBits
Returns
The first Trackdir from the TrackdirBits value
See also
FindFirstTrackdir

Definition at line 166 of file track_func.h.

References INVALID_TRACKDIR_BIT, and TRACKDIR_BIT_NONE.

◆ ReverseTrackdir()

static Trackdir ReverseTrackdir ( Trackdir  trackdir)
inlinestatic

Maps a trackdir to the reverse trackdir.

Returns the reverse trackdir of a Trackdir value. The reverse trackdir is the same track with the other direction on it.

Parameters
trackdirThe Trackdir value
Returns
The reverse trackdir
Precondition
trackdir must not be INVALID_TRACKDIR

Definition at line 257 of file track_func.h.

Referenced by CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::ForcedReverse(), FreeTrainReservation(), HasOnewaySignalBlockingTrackdir(), CYapfCostRailT< Types >::IsAnyStationTileReserved(), NPFTrainFindNearestDepot(), CYapfReserveTrack< Types >::ReserveSingleTrack(), RestoreTrainReservation(), TrackToTrackdirBits(), CYapfReserveTrack< Types >::UnreserveSingleTrack(), YapfShipCheckReverse(), YapfTrainCheckReverse(), and YapfTrainFindNearestDepot().

◆ TrackBitsToTrack()

static Track TrackBitsToTrack ( TrackBits  tracks)
inlinestatic

Converts TrackBits to Track.

This function converts a TrackBits value to a Track value. As it is not possible to convert two or more tracks to one track the parameter must contain only one track or be the INVALID_TRACK_BIT value.

Parameters
tracksThe TrackBits value to convert
Returns
The Track from the value or INVALID_TRACK
Precondition
tracks must contains only one Track or be INVALID_TRACK_BIT

Definition at line 203 of file track_func.h.

Referenced by DeleteLastWagon(), and Train::ReserveTrackUnderConsist().

◆ TrackBitsToTrackdirBits()

static TrackdirBits TrackBitsToTrackdirBits ( TrackBits  bits)
inlinestatic

Converts TrackBits to TrackdirBits while allowing both directions.

Parameters
bitsThe TrackBits
Returns
The TrackdirBits containing of bits in both directions.

Definition at line 329 of file track_func.h.

Referenced by FollowReservation().

◆ TrackCrossesTracks()

static TrackBits TrackCrossesTracks ( Track  track)
inlinestatic

Maps a track to all tracks that make 90 deg turns with it.

For the diagonal directions these are the complement of the direction, for the straight directions these are the two vertical or horizontal tracks, depend on the given direction

Parameters
trackThe given track
Returns
The TrackBits with the tracks marked which cross the given track by 90 deg.

Definition at line 408 of file track_func.h.

Referenced by TrainCheckIfLineEnds().

◆ TrackdirBitsToTrackBits()

static TrackBits TrackdirBitsToTrackBits ( TrackdirBits  bits)
inlinestatic

Discards all directional information from a TrackdirBits value.

Any Track which is present in either direction will be present in the result.

Parameters
bitsThe TrackdirBits to get the TrackBits from
Returns
The TrackBits

Definition at line 318 of file track_func.h.

References TRACK_BIT_MASK.

Referenced by CheckRoadBlockedForOvertaking(), DiagdirReachesTracks(), ExtendTrainReservation(), MaskWireBits(), TrackStatusToTrackBits(), and TrainCheckIfLineEnds().

◆ TrackdirCrossesTrackdirs()

static TrackdirBits TrackdirCrossesTrackdirs ( Trackdir  trackdir)
inlinestatic

Maps a trackdir to all trackdirs that make 90 deg turns with it.

For the diagonal tracks this returns the track direction bits of the other axis in both directions, which cannot be joined by the given track direction. For the straight tracks this returns all possible 90 deg turns either on the current tile (which no train can joined) or on the bordering tiles.

Parameters
trackdirThe track direction
Returns
The TrackdirBits which are (more or less) 90 deg turns.

Definition at line 594 of file track_func.h.

Referenced by ExtendTrainReservation(), and GetDriveableTrackdirBits().

◆ TrackdirReachesTrackdirs()

static TrackdirBits TrackdirReachesTrackdirs ( Trackdir  trackdir)
inlinestatic

Maps a trackdir to the trackdirs that can be reached from it (ie, when entering the next tile.

This will include 90 degree turns!

Parameters
trackdirThe track direction which will be leaved
Returns
The track directions which can be used from this direction (in the next tile)

Definition at line 572 of file track_func.h.

Referenced by ExtendTrainReservation(), and GetDriveableTrackdirBits().

◆ TrackdirToExitdir()

static DiagDirection TrackdirToExitdir ( Trackdir  trackdir)
inlinestatic

Maps a trackdir to the (4-way) direction the tile is exited when following that trackdir.

For the diagonal directions these are the same directions. For the straight directions these are the directions from the imagined base-tile to the bordering tile which will be joined if the given straight direction is leaved from the base-tile.

Parameters
trackdirThe given track direction
Returns
The direction which points to the resulting tile if following the Trackdir

Definition at line 427 of file track_func.h.

Referenced by CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::CanEnterNewTile(), ClearPathReservation(), FreeTrainReservation(), CYapfCostRailT< Types >::IsAnyStationTileReserved(), NPFSaveTargetData(), CYapfCostRoadT< Types >::OneTileCost(), CYapfDestinationTileT< Types >::PfCalcEstimate(), CYapfDestinationTileOrStationRailT< Types >::PfCalcEstimate(), CYapfDestinationTileRoadT< Types >::PfCalcEstimate(), CYapfReserveTrack< Types >::ReserveSingleTrack(), RestoreTrainReservation(), CYapfCostBase::stSlopeCost(), CYapfReserveTrack< Types >::UnreserveSingleTrack(), and YapfTrainCheckReverse().

◆ TrackdirToTrack()

static Track TrackdirToTrack ( Trackdir  trackdir)
inlinestatic

Returns the Track that a given Trackdir represents.

This function filters the Track which is used in the Trackdir value and returns it as a Track value.

Parameters
trackdirThe trackdir value
Returns
The Track which is used in the value

Definition at line 272 of file track_func.h.

Referenced by ClearPathReservation(), ExtendTrainReservation(), FindTrainOnTrackEnum(), FollowReservation(), HasOnewaySignalBlockingTrackdir(), IsWaitingPositionFree(), NPFSaveTargetData(), CYapfReserveTrack< Types >::ReserveSingleTrack(), CYapfReserveTrack< Types >::UnreserveSingleTrack(), YapfShipChooseTrack(), and YapfTrainChooseTrack().

◆ TrackdirToTrackdirBits()

static TrackdirBits TrackdirToTrackdirBits ( Trackdir  trackdir)
inlinestatic

◆ TrackEnterdirToTrackdir()

static Trackdir TrackEnterdirToTrackdir ( Track  track,
DiagDirection  diagdir 
)
inlinestatic

Maps a track and an (4-way) dir to the trackdir that represents the track with the entry in the given direction.

For the diagonal tracks the return value is clear, its either the matching track direction or INVALID_TRACKDIR. For the straight tracks this returns the track direction which results if you follow the DiagDirection and then turn by 45 deg left or right on the next tile. The new direction on the new track will be the returning Trackdir value. If the parameters makes no sense like the track TRACK_UPPER and the direction DIAGDIR_NE (target track cannot be reached) this function returns INVALID_TRACKDIR.

Parameters
trackThe target track
diagdirThe direction to "come from"
Returns
the resulting Trackdir or INVALID_TRACKDIR if not possible.

Definition at line 474 of file track_func.h.

◆ TrackExitdirToTrackdir()

static Trackdir TrackExitdirToTrackdir ( Track  track,
DiagDirection  diagdir 
)
inlinestatic

Maps a track and an (4-way) dir to the trackdir that represents the track with the exit in the given direction.

For the diagonal tracks the resulting track direction are clear for a given DiagDirection. It either matches the direction or it returns INVALID_TRACKDIR, as a TRACK_X cannot be applied with DIAG_SE. For the straight tracks the resulting track direction will be the direction which the DiagDirection is pointing. But this will be INVALID_TRACKDIR if the DiagDirection is pointing 'away' the track.

Parameters
trackThe track to apply an direction on
diagdirThe DiagDirection to apply on
Returns
The resulting track direction or INVALID_TRACKDIR if not possible.

Definition at line 449 of file track_func.h.

◆ TrackOverlapsTracks()

static bool TrackOverlapsTracks ( TrackBits  tracks,
Track  track 
)
inlinestatic

Check if a given track is contained within or overlaps some other tracks.

Parameters
tracksTracks to be tested against
trackThe track to test
Returns
true if the track is already in the tracks or overlaps the tracks.

Definition at line 650 of file track_func.h.

References HasBit(), TracksOverlap(), and TrackToTrackBits().

Referenced by IsWaitingPositionFree().

◆ TracksOverlap()

static bool TracksOverlap ( TrackBits  bits)
inlinestatic

Checks if the given tracks overlap, ie form a crossing.

Basically this means when there is more than one track on the tile, exept when there are two parallel tracks.

Parameters
bitsThe tracks present.
Returns
Whether the tracks present overlap in any way.

Definition at line 633 of file track_func.h.

References KillFirstBit(), TRACK_BIT_HORZ, TRACK_BIT_NONE, and TRACK_BIT_VERT.

Referenced by CmdConvertRail(), GetRailFoundation(), MaskWireBits(), and TrackOverlapsTracks().

◆ TrackStatusToRedSignals()

static TrackdirBits TrackStatusToRedSignals ( TrackStatus  ts)
inlinestatic

Returns the red-signal-information of a TrackStatus.

Note: The result may contain red signals for non-present tracks.

Parameters
tsThe TrackStatus returned by GetTileTrackStatus()
Returns
the The trackdirs that are blocked by red-signals

Definition at line 364 of file track_func.h.

References TRACKDIR_BIT_MASK.

Referenced by CheckRoadBlockedForOvertaking(), RoadFindPathToDest(), and TrainCheckIfLineEnds().

◆ TrackStatusToTrackBits()

static TrackBits TrackStatusToTrackBits ( TrackStatus  ts)
inlinestatic

Returns the present-track-information of a TrackStatus.

Parameters
tsThe TrackStatus returned by GetTileTrackStatus()
Returns
the present tracks

Definition at line 351 of file track_func.h.

References TrackdirBitsToTrackBits(), and TrackStatusToTrackdirBits().

Referenced by DisasterTick_Submarine(), GenericPlaceSignals(), MaskWireBits(), and RoadVehicle::TileMayHaveSlopedTrack().

◆ TrackStatusToTrackdirBits()

static TrackdirBits TrackStatusToTrackdirBits ( TrackStatus  ts)
inlinestatic

◆ TrackToOppositeTrack()

static Track TrackToOppositeTrack ( Track  t)
inlinestatic

Find the opposite track to a given track.

TRACK_LOWER -> TRACK_UPPER and vice versa, likewise for left/right. TRACK_X is mapped to TRACK_Y and reversed.

Parameters
tthe track to convert
Returns
the opposite track

Definition at line 241 of file track_func.h.

◆ TrackToTrackBits()

static TrackBits TrackToTrackBits ( Track  track)
inlinestatic

Maps a Track to the corresponding TrackBits value.

Parameters
trackthe track to convert
Returns
the converted TrackBits value of the track

Definition at line 87 of file track_func.h.

Referenced by AdvanceWagonsAfterSwap(), AxisToTrackBits(), EnsureNoTrainOnTrack(), FollowReservation(), GetDepotReservationTrackBits(), GetRailTrackBitsUniversal(), and TrackOverlapsTracks().

◆ TrackToTrackdir()

static Trackdir TrackToTrackdir ( Track  track)
inlinestatic

Returns a Trackdir for the given Track.

Since every Track corresponds to two Trackdirs, we choose the one which points between NE and S. Note that the actual implementation is quite futile, but this might change in the future.

Parameters
trackThe given Track
Returns
The Trackdir from the given Track

Definition at line 289 of file track_func.h.

Referenced by TrackToTrackdirBits().

◆ TrackToTrackdirBits()

static TrackdirBits TrackToTrackdirBits ( Track  track)
inlinestatic

Returns a TrackdirBit mask from a given Track.

The TrackdirBit mask contains the two TrackdirBits that correspond with the given Track (one for each direction).

Parameters
trackThe track to get the TrackdirBits from
Returns
The TrackdirBits which the selected tracks

Definition at line 304 of file track_func.h.

References ReverseTrackdir(), TrackdirToTrackdirBits(), and TrackToTrackdir().