Different functions related to conversions between directions. More...
#include "direction_type.h"
Go to the source code of this file.
Functions | |
static Direction | ReverseDir (Direction d) |
Return the reverse of a direction. | |
static DirDiff | DirDifference (Direction d0, Direction d1) |
Calculate the difference between to directions. | |
static DirDiff | ChangeDirDiff (DirDiff d, DirDiff delta) |
Applies two differences together. | |
static Direction | ChangeDir (Direction d, DirDiff delta) |
Change a direction by a given difference. | |
static DiagDirection | ReverseDiagDir (DiagDirection d) |
Returns the reverse direction of the given DiagDirection. | |
static DiagDirection | ChangeDiagDir (DiagDirection d, DiagDirDiff delta) |
Applies a difference on a DiagDirection. | |
static DiagDirection | DirToDiagDir (Direction dir) |
Convert a Direction to a DiagDirection. | |
static Direction | DiagDirToDir (DiagDirection dir) |
Convert a DiagDirection to a Direction. | |
static Axis | OtherAxis (Axis a) |
Select the other axis as provided. | |
static Axis | DiagDirToAxis (DiagDirection d) |
Convert a DiagDirection to the axis. | |
static DiagDirection | AxisToDiagDir (Axis a) |
Converts an Axis to a DiagDirection. | |
static Direction | AxisToDirection (Axis a) |
Converts an Axis to a Direction. | |
static DiagDirection | XYNSToDiagDir (Axis xy, uint ns) |
Convert an axis and a flag for north/south into a DiagDirection. | |
static bool | IsValidDiagDirection (DiagDirection d) |
Checks if an interger value is a valid DiagDirection. | |
static bool | IsValidDirection (Direction d) |
Checks if an integer value is a valid Direction. | |
static bool | IsValidAxis (Axis d) |
Checks if an integer value is a valid Axis. |
Different functions related to conversions between directions.
Definition in file direction_func.h.
static DiagDirection AxisToDiagDir | ( | Axis | a | ) | [inline, static] |
Converts an Axis to a DiagDirection.
This function returns the DiagDirection which belongs to the axis. As 2 directions are mapped to an axis this function returns the one which points to south, either south-west (on X axis) or south-east (on Y axis)
a | The axis |
Definition at line 172 of file direction_func.h.
Referenced by CmdBuildBridge(), CmdBuildLongRoad(), CmdBuildRailWaypoint(), DrawBridgePillars(), GetNorthernBridgeEnd(), GetSouthernBridgeEnd(), and TrainApproachingCrossing().
Converts an Axis to a Direction.
This function returns the Direction which belongs to the axis. As 2 directions are mapped to an axis this function returns the one which points to south, either south-west (on X axis) or south-east (on Y axis)
a | The axis |
Definition at line 188 of file direction_func.h.
static DiagDirection ChangeDiagDir | ( | DiagDirection | d, | |
DiagDirDiff | delta | |||
) | [inline, static] |
Applies a difference on a DiagDirection.
This function applies a difference on a DiagDirection and returns the new DiagDirection.
d | The DiagDirection | |
delta | The difference to applie on |
Definition at line 95 of file direction_func.h.
Referenced by AircraftGetEntryPoint(), GrowTownInTile(), IsNeighborRoadTile(), and TrainExitDir().
Change a direction by a given difference.
This functions returns a new direction of the given direction which is rotated by the given difference.
d | The direction to get a new direction from | |
delta | The offset/drift applied to the direction |
Definition at line 67 of file direction_func.h.
Referenced by AircraftController(), DisasterTick_Submarine(), HandleCrashedAircraft(), and RotateAirportMovingData().
Applies two differences together.
This function adds two differences together and return the resulting difference. So adding two DIRDIFF_REVERSE together results in the DIRDIFF_SAME difference.
d | The first difference | |
delta | The second difference to add on |
Definition at line 52 of file direction_func.h.
static Axis DiagDirToAxis | ( | DiagDirection | d | ) | [inline, static] |
Convert a DiagDirection to the axis.
This function returns the axis which belongs to the given DiagDirection. The axis X belongs to the DiagDirection north-east and south-west.
d | The DiagDirection |
Definition at line 155 of file direction_func.h.
Referenced by CanEnterTileOwnerCheck(), CheckFlatLandRoadStop(), CleanUpRoadBits(), CmdBuildBridge(), CmdBuildRoad(), CmdBuildRoadStop(), CmdBuildTunnel(), DrawCatenaryRailway(), DrawTile_TunnelBridge(), ExploreSegment(), GetAnyRoadBits(), GetBridgeHeight(), IsWateredTile(), MakeDock(), NeighbourHasReachableRoad(), PlaceRoad_BusStation(), PlaceRoad_TruckStation(), RoadFindPathToDest(), SetRailStationPlatformReservation(), TrainApproachingCrossingTile(), and VehicleEnter_Track().
static Direction DiagDirToDir | ( | DiagDirection | dir | ) | [inline, static] |
Convert a DiagDirection to a Direction.
This function can be used to convert the 4-way DiagDirection to the 8-way Direction. As 4-way are less than 8-way not all possible directions can be calculated.
dir | The direction to convert |
Definition at line 125 of file direction_func.h.
Referenced by CmdBuildRailVehicle(), CmdBuildRailWagon(), CmdBuildRoadVehicle(), TrainCanLeaveTile(), and VehicleEnter_Track().
Calculate the difference between to directions.
d0 | The first direction as the base | |
d1 | The second direction as the offset from the base |
Definition at line 36 of file direction_func.h.
Referenced by AircraftController(), and Train::GetCurveSpeedLimit().
static DiagDirection DirToDiagDir | ( | Direction | dir | ) | [inline, static] |
Convert a Direction to a DiagDirection.
This function can be used to convert the 8-way Direction to the 4-way DiagDirection. If the direction cannot be mapped its "rounded clockwise". So DIR_N becomes DIAGDIR_NE.
dir | The direction to convert |
Definition at line 110 of file direction_func.h.
Referenced by AircraftGetEntryPoint(), CmdTurnRoadVeh(), DisasterTick_Submarine(), RoadStop::Enter(), FindVehiclesInRoadStop(), GetTrainStopLocation(), Train::GetVehicleTrackdir(), Ship::GetVehicleTrackdir(), RoadVehicle::GetVehicleTrackdir(), IsWateredTile(), RoadStop::Leave(), and TrainExitDir().
static bool IsValidAxis | ( | Axis | d | ) | [inline, static] |
Checks if an integer value is a valid Axis.
d | The value to check |
Definition at line 232 of file direction_func.h.
References AXIS_END.
Referenced by CmdBuildRoadStop(), and PlaceRail_Waypoint().
static bool IsValidDiagDirection | ( | DiagDirection | d | ) | [inline, static] |
Checks if an interger value is a valid DiagDirection.
d | The value to check |
Definition at line 210 of file direction_func.h.
References DIAGDIR_END.
Referenced by ChooseShipTrack(), CmdBuildRoadStop(), GetOtherAqueductEnd(), BuildDocksToolbarWindow::OnPlacePresize(), OPFShipChooseTrack(), TileIndexDiffCByDiagDir(), and TileOffsByDiagDir().
static bool IsValidDirection | ( | Direction | d | ) | [inline, static] |
Checks if an integer value is a valid Direction.
d | The value to check |
Definition at line 221 of file direction_func.h.
References DIR_END.
Referenced by TileIndexDiffCByDir(), and TileOffsByDir().
Select the other axis as provided.
This is basically the not-operator for the axis.
a | The given axis |
Definition at line 139 of file direction_func.h.
Referenced by CmdBuildRailWaypoint(), CmdBuildRoad(), DrawBridgePillars(), and GetCrossingRailAxis().
static DiagDirection ReverseDiagDir | ( | DiagDirection | d | ) | [inline, static] |
Returns the reverse direction of the given DiagDirection.
d | The DiagDirection to get the reverse from |
Definition at line 79 of file direction_func.h.
Referenced by AIBridge::_BuildBridgeRoad1(), AIBridge::_BuildBridgeRoad2(), AITunnel::_BuildTunnelRoad1(), AITunnel::_BuildTunnelRoad2(), AircraftGetEntryPoint(), AIMarine::AreWaterTilesConnected(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::CanEnterNewTile(), CanEnterTile(), CcBuildBridge(), CcBuildRoadTunnel(), CcRoadStop(), CheckTownBuild2House(), CheckTownBuild2x2House(), ClearPathReservation(), CmdBuildBridge(), CmdBuildDock(), CmdBuildLongRoad(), CmdBuildTunnel(), ConnectRoadToStructure(), DoClearBridge(), DoClearTunnel(), DrawBridgePillars(), DrawCatenaryRailway(), ExploreSegment(), FixOwnerOfRailTrack(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::FollowTileExit(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::ForcedReverse(), GetAnyRoadBits(), GetBridgeEnd(), AIRoad::GetDriveThroughBackTile(), GetNorthernBridgeEnd(), GetOtherAqueductEnd(), GetOtherTunnelEnd(), GetTownRoadGridElement(), GrowTownAtRoad(), GrowTownInTile(), GrowTownWithBridge(), IsNeighborRoadTile(), IsWateredTile(), MaskWireBits(), BuildDocksToolbarWindow::OnPlaceObject(), BuildDocksToolbarWindow::OnPlacePresize(), OPFShipChooseTrack(), CYapfCostRoadT< Types >::PfCalcCost(), CYapfCostRailT< Types >::PfCalcCost(), RoadStop::Entry::Rebuild(), TrainApproachingCrossing(), TrainCanLeaveTile(), TrainCheckIfLineEnds(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::TryReverse(), UpdateSignalsInBuffer(), and VehicleEnter_Track().
Return the reverse of a direction.
d | The direction to get the reverse from |
Definition at line 23 of file direction_func.h.
Referenced by DrawCatenaryOnBridge(), Train::GetImage(), TileLoop_Water(), UpdateStatusAfterSwap(), and VehicleEnter_Track().
static DiagDirection XYNSToDiagDir | ( | Axis | xy, | |
uint | ns | |||
) | [inline, static] |
Convert an axis and a flag for north/south into a DiagDirection.
xy | axis to convert | |
ns | north -> 0, south -> 1 |
Definition at line 199 of file direction_func.h.
Referenced by GetShipDepotDirection().