map_func.h File Reference

Functions related to maps. More...

#include "tile_type.h"
#include "map_type.h"
#include "direction_func.h"

Go to the source code of this file.

Defines

#define TILE_MASK(x)   ((x) & _map_tile_mask)
 'Wraps' the given tile to it is within the map.
#define TILE_ADD(x, y)   ((x) + (y))
 Adds to tiles together.
#define TILE_ADDXY(tile, x, y)   TILE_ADD(tile, TileDiffXY(x, y))
 Adds a given offset to a tile.
#define TILE_LOOP(var, w, h, tile)
 A loop which iterates to a square of tiles.
#define TILE_AREA_LOOP(var, ta)   TILE_LOOP(var, ta.w, ta.h, ta.tile)
 A loop which iterates over the tiles of a TileArea.
#define RandomTile()   RandomTileSeed(Random())
 Get a valid random tile.

Typedefs

typedef int32 TileIndexDiff
 An offset value between to tiles.
typedef bool TestTileOnSearchProc (TileIndex tile, void *user_data)
 A callback function type for searching tiles.

Functions

void AllocateMap (uint size_x, uint size_y)
 Allocate a new map with the given size.
static uint MapLogX ()
 Logarithm of the map size along the X side.
static uint MapLogY ()
 Logarithm of the map size along the y side.
static uint MapSizeX ()
 Get the size of the map along the X.
static uint MapSizeY ()
 Get the size of the map along the Y.
static uint MapSize ()
 Get the size of the map.
static uint MapMaxX ()
 Gets the maximum X coordinate within the map, including MP_VOID.
static uint MapMaxY ()
 Gets the maximum Y coordinate within the map, including MP_VOID.
static uint ScaleByMapSize (uint n)
 Scales the given value by the map size, where the given value is for a 256 by 256 map.
static uint ScaleByMapSize1D (uint n)
 Scales the given value by the maps circumference, where the given value is for a 256 by 256 map.
static TileIndex TileXY (uint x, uint y)
 Returns the TileIndex of a coordinate.
static TileIndexDiff TileDiffXY (int x, int y)
 Calculates an offset for the given coordinate(-offset).
static TileIndex TileVirtXY (uint x, uint y)
static uint TileX (TileIndex tile)
 Get the X component of a tile.
static uint TileY (TileIndex tile)
 Get the Y component of a tile.
static TileIndexDiff ToTileIndexDiff (TileIndexDiffC tidc)
 Return the offset between to tiles from a TileIndexDiffC struct.
TileIndex TileAddWrap (TileIndex tile, int addx, int addy)
 Adds an offset to a tile and check if we are still on the map.
static TileIndexDiffC TileIndexDiffCByDiagDir (DiagDirection dir)
 Returns the TileIndexDiffC offset from a DiagDirection.
static TileIndexDiffC TileIndexDiffCByDir (Direction dir)
 Returns the TileIndexDiffC offset from a Direction.
static TileIndex AddTileIndexDiffCWrap (TileIndex tile, TileIndexDiffC diff)
 Add a TileIndexDiffC to a TileIndex and returns the new one.
static TileIndexDiffC TileIndexToTileIndexDiffC (TileIndex tile_a, TileIndex tile_b)
 Returns the diff between two tiles.
uint DistanceManhattan (TileIndex, TileIndex)
 also known as L1-Norm. Is the shortest distance one could go over diagonal tracks (or roads)
uint DistanceSquare (TileIndex, TileIndex)
 euclidian- or L2-Norm squared
uint DistanceMax (TileIndex, TileIndex)
 also known as L-Infinity-Norm
uint DistanceMaxPlusManhattan (TileIndex, TileIndex)
 Max + Manhattan.
uint DistanceFromEdge (TileIndex)
 shortest distance from any edge of the map
static TileIndexDiff TileOffsByDiagDir (DiagDirection dir)
 Convert a DiagDirection to a TileIndexDiff.
static TileIndexDiff TileOffsByDir (Direction dir)
 Convert a Direction to a TileIndexDiff.
static TileIndex TileAddByDiagDir (TileIndex tile, DiagDirection dir)
 Adds a DiagDir to a tile.
static DiagDirection DiagdirBetweenTiles (TileIndex tile_from, TileIndex tile_to)
 Determines the DiagDirection to get from one tile to another.
bool CircularTileSearch (TileIndex *tile, uint size, TestTileOnSearchProc proc, void *user_data)
 Searches for some cirumstances of a tile around a given tile with a helper function.
bool CircularTileSearch (TileIndex *tile, uint radius, uint w, uint h, TestTileOnSearchProc proc, void *user_data)
 Searches for some cirumstances of a tile around a given rectangle with a helper function.
static TileIndex RandomTileSeed (uint32 r)
 Get a random tile out of a given seed.
uint GetClosestWaterDistance (TileIndex tile, bool water)
 Finds the distance for the closest tile with water/land given a tile.

Variables

uint _map_tile_mask
 _map_size - 1 (to mask the mapsize)
Tile_m
 Pointer to the tile-array.
TileExtended_me
 Pointer to the extended tile-array.

Detailed Description

Functions related to maps.

Definition in file map_func.h.


Define Documentation

 
#define RandomTile (  )     RandomTileSeed(Random())

Get a valid random tile.

Note:
a define so 'random' gets inserted in the place where it is actually called, thus making the random traces more explicit.
Returns:
a valid tile

Definition at line 456 of file map_func.h.

Referenced by CmdBuildIndustry(), DisasterTick_Big_Ufo(), DisasterTick_Ufo(), MaybeNewIndustry(), PlaceInitialIndustry(), PlaceMoreTrees(), and ReleaseDisastersTargetingVehicle().

#define TILE_ADD ( x,
 )     ((x) + (y))
#define TILE_ADDXY ( tile,
x,
 )     TILE_ADD(tile, TileDiffXY(x, y))

Adds a given offset to a tile.

Parameters:
tile The tile to add an offset on it
x The x offset to add to the tile
y The y offset to add to the tile

Definition at line 258 of file map_func.h.

Referenced by CheckAllowRemoveRoad(), CheckNewIndustry_OilRefinery(), CheckNewIndustry_OilRig(), FindStationsNearby(), FloodVehicles(), and MakeTownHouseBigger().

#define TILE_AREA_LOOP ( var,
ta   )     TILE_LOOP(var, ta.w, ta.h, ta.tile)

A loop which iterates over the tiles of a TileArea.

This macro starts 2 nested loops which iterates over a square of tiles.

Parameters:
var The name of the variable which contains the current tile
ta The tile area to search over

Definition at line 358 of file map_func.h.

Referenced by AITileList::AddRectangle(), CmdBuildCanal(), CmdLevelLand(), CmdPlantTree(), DeallocateSpecFromStation(), FindStationsNearby(), FloodVehicles(), GenerateDesertArea(), GenerateRockyArea(), AIIndustry::GetDockLocation(), AIIndustry::GetHeliportLocation(), AIOrder::GetOrderDestination(), GetProductionAroundTiles(), SmallMapWindow::GetTileColours(), RemoveFromRailBaseStation(), RemoveRailStation(), and AITileList::RemoveRectangle().

#define TILE_LOOP ( var,
w,
h,
tile   ) 
Value:
for (uint var = tile, cur_h = (h); cur_h > 0; --cur_h, var += TileDiffXY(0, 1) - (w)) \
    for (uint cur_w = (w); cur_w > 0; --cur_w, var++)

A loop which iterates to a square of tiles.

This macro starts 2 nested loops which iterates over a square of tiles.

Parameters:
var The name of the variable which contains the current tile
w The width (x-width) of the square
h The heigth (y-width) of the square
tile The start tile of the square

Definition at line 346 of file map_func.h.

Referenced by AITileList_IndustryAccepting::AITileList_IndustryAccepting(), AITileList_IndustryProducing::AITileList_IndustryProducing(), AITileList_StationType::AITileList_StationType(), CanExpandRailStation(), CheckFlatLandBelow(), CheckIfCanLevelIndustryPlatform(), CommonRaiseLowerBigLand(), AIOrder::GetOrderDestination(), GetStationAround(), RemoveAirport(), and StationRect::ScanForStationTiles().

#define TILE_MASK (  )     ((x) & _map_tile_mask)

'Wraps' the given tile to it is within the map.

It does this by masking the 'high' bits of.

Parameters:
x the tile to 'wrap'

Definition at line 27 of file map_func.h.

Referenced by DisasterTick_Big_Ufo(), and RandomTileSeed().


Typedef Documentation

typedef bool TestTileOnSearchProc(TileIndex tile, void *user_data)

A callback function type for searching tiles.

Parameters:
tile The tile to test
user_data additional data for the callback function to use
Returns:
A boolean value, depend on the definition of the function.

Definition at line 428 of file map_func.h.

typedef int32 TileIndexDiff

An offset value between to tiles.

This value is used fro the difference between to tiles. It can be added to a tileindex to get the resulting tileindex of the start tile applied with this saved difference.

See also:
TileDiffXY(int, int)

Definition at line 160 of file map_func.h.


Function Documentation

static TileIndex AddTileIndexDiffCWrap ( TileIndex  tile,
TileIndexDiffC  diff 
) [inline, static]

Add a TileIndexDiffC to a TileIndex and returns the new one.

Returns tile + the diff given in diff. If the result tile would end up outside of the map, INVALID_TILE is returned instead.

Parameters:
tile The base tile to add the offset on
diff The offset to add on the tile
Returns:
The resulting TileIndex

Definition at line 303 of file map_func.h.

References INVALID_TILE, MapSizeX(), MapSizeY(), TileX(), TileXY(), TileY(), TileIndexDiffC::x, and TileIndexDiffC::y.

Referenced by TileLoop_Water().

void AllocateMap ( uint  size_x,
uint  size_y 
)

Allocate a new map with the given size.

(Re)allocates a map with the given dimension

Parameters:
size_x the width of the map along the NE/SW edge
size_y the 'height' of the map along the SE/NW edge

Definition at line 39 of file map.cpp.

References _map_log_x, _map_log_y, _map_size, _map_size_x, _map_size_y, _map_tile_mask, error(), FindFirstBit(), IsInsideMM(), MAX_MAP_SIZE, and MIN_MAP_SIZE.

bool CircularTileSearch ( TileIndex tile,
uint  radius,
uint  w,
uint  h,
TestTileOnSearchProc  proc,
void *  user_data 
)

Searches for some cirumstances of a tile around a given rectangle with a helper function.

Generalized circular search allowing for rectangles and a hole. Function performing a search around a center rectangle and going outward. The center rectangle is left out from the search. To do a rectangular search without a hole, set either h or w to zero. Every tile will be tested by means of the callback function proc, which will determine if yes or no the given tile meets criteria of search.

Parameters:
tile to start the search from. Upon completion, it will return the tile matching the search. This tile should be directly north of the hole (if any).
radius How many tiles to search outwards. Note: This is a radius and thus different from the size parameter of the other CircularTileSearch function, which is a diameter.
w the width of the inner rectangle
h the height of the inner rectangle
proc callback testing function pointer.
user_data to be passed to the callback function. Depends on the implementation
Returns:
result of the search
Precondition:
proc != NULL
radius > 0

Definition at line 278 of file map.cpp.

References DIAGDIR_BEGIN, DIAGDIR_END, DIR_W, INVALID_TILE, MapSizeX(), MapSizeY(), TileX(), TileXY(), TileY(), TileIndexDiffC::x, and TileIndexDiffC::y.

bool CircularTileSearch ( TileIndex tile,
uint  size,
TestTileOnSearchProc  proc,
void *  user_data 
)

Searches for some cirumstances of a tile around a given tile with a helper function.

Function performing a search around a center tile and going outward, thus in circle. Although it really is a square search... Every tile will be tested by means of the callback function proc, which will determine if yes or no the given tile meets criteria of search.

Parameters:
tile to start the search from. Upon completion, it will return the tile matching the search
size,: number of tiles per side of the desired search area
proc,: callback testing function pointer.
user_data to be passed to the callback function. Depends on the implementation
Returns:
result of the search
Precondition:
proc != NULL
size > 0

Definition at line 240 of file map.cpp.

References CircularTileSearch(), DIR_N, TILE_ADD, and TileOffsByDir().

Referenced by ChopLumberMillTrees(), CircularTileSearch(), FindNearestGoodCoastalTownSpot(), FindStationsNearby(), GetDistanceFromNearbyHouse(), Station::RecomputeIndustriesNear(), and TownActionBuildStatue().

static DiagDirection DiagdirBetweenTiles ( TileIndex  tile_from,
TileIndex  tile_to 
) [inline, static]

Determines the DiagDirection to get from one tile to another.

The tiles do not necessarily have to be adjacent.

Parameters:
tile_from Origin tile
tile_to Destination tile
Returns:
DiagDirection from tile_from towards tile_to, or INVALID_DIAGDIR if the tiles are not on an axis

Definition at line 408 of file map_func.h.

References DIAGDIR_NE, DIAGDIR_NW, DIAGDIR_SE, DIAGDIR_SW, INVALID_DIAGDIR, TileX(), and TileY().

Referenced by AIBridge::_BuildBridgeRoad1(), AIBridge::_BuildBridgeRoad2(), AITunnel::_BuildTunnelRoad1(), AITunnel::_BuildTunnelRoad2(), and AIMarine::AreWaterTilesConnected().

uint DistanceFromEdge ( TileIndex  tile  ) 

shortest distance from any edge of the map

Param the minimum distance to an edge

Parameters:
tile the tile to get the distance from
Returns:
the distance from the edge in tiles

Definition at line 216 of file map.cpp.

References MapSizeX(), MapSizeY(), min(), TileX(), and TileY().

Referenced by CheckNewIndustry_OilRefinery(), CheckNewIndustry_OilRig(), GrayscaleToMapHeights(), GrowTownWithExtraHouse(), IsRoadAllowedHere(), and TownCanBePlacedHere().

uint DistanceManhattan ( TileIndex  t0,
TileIndex  t1 
)

also known as L1-Norm. Is the shortest distance one could go over diagonal tracks (or roads)

Gets the Manhattan distance between the two given tiles. The Manhattan distance is the sum of the delta of both the X and Y component. Also known as L1-Norm

Parameters:
t0 the start tile
t1 the end tile
Returns:
the distance

Definition at line 156 of file map.cpp.

References Delta(), TileX(), and TileY().

Referenced by AirportGetNearestTown(), AIMarine::AreWaterTilesConnected(), AIRail::BuildRail(), CalcRaildirsDrawstyle(), AIRoad::CanBuildConnectedRoadPartsHere(), DeliverGoods(), FindDeletedWaypointCloseTo(), GetClosestDeletedStation(), GetCountAndDistanceOfClosestInstance(), GetDistanceFromNearbyHouse(), AITown::GetDistanceManhattanToTile(), AITile::GetDistanceManhattanToTile(), AIStation::GetDistanceManhattanToTile(), AIIndustry::GetDistanceManhattanToTile(), IndustryGetVariable(), IsCloseToTown(), CargoPayment::PayTransfer(), Station::RecomputeIndustriesNear(), AIRail::RemoveRail(), VpSelectTilesWithMethod(), VpSetPresizeRange(), and YapfTrainCheckReverse().

uint DistanceMax ( TileIndex  t0,
TileIndex  t1 
)

also known as L-Infinity-Norm

Gets the biggest distance component (x or y) between the two given tiles. Also known as L-Infinity-Norm.

Parameters:
t0 the start tile
t1 the end tile
Returns:
the distance

Definition at line 188 of file map.cpp.

References Delta(), max(), TileX(), and TileY().

Referenced by FindStationsNearby().

uint DistanceMaxPlusManhattan ( TileIndex  t0,
TileIndex  t1 
)

Max + Manhattan.

Gets the biggest distance component (x or y) between the two given tiles plus the Manhattan distance, i.e. two times the biggest distance component and once the smallest component.

Parameters:
t0 the start tile
t1 the end tile
Returns:
the distance

Definition at line 204 of file map.cpp.

References Delta(), TileX(), and TileY().

uint DistanceSquare ( TileIndex  t0,
TileIndex  t1 
)

euclidian- or L2-Norm squared

Gets the 'Square' distance between the two given tiles. The 'Square' distance is the square of the shortest (straight line) distance between the two tiles. Also known as euclidian- or L2-Norm squared.

Parameters:
t0 the start tile
t1 the end tile
Returns:
the distance

Definition at line 173 of file map.cpp.

References TileX(), and TileY().

Referenced by FindNearestHangar(), AITown::GetDistanceSquareToTile(), AITile::GetDistanceSquareToTile(), AIStation::GetDistanceSquareToTile(), AIIndustry::GetDistanceSquareToTile(), GetTownRadiusGroup(), IndustryGetVariable(), and UpdateTownGrowRate().

uint GetClosestWaterDistance ( TileIndex  tile,
bool  water 
)

Finds the distance for the closest tile with water/land given a tile.

Finds the distance for the closest tile with water/land given a tile

Parameters:
tile the tile to find the distance too
water whether to find water or land
Returns:
distance to nearest water (max 0x7F) / land (max 0x1FF; 0x200 if there is no land)
Note:
FAILS when an industry should be seen as water

Definition at line 323 of file map.cpp.

References _settings_game, GameSettings::construction, DIAGDIR_BEGIN, DIAGDIR_END, ConstructionSettings::freeform_edges, IsInsideMM(), IsTileType(), MapMaxX(), MapMaxY(), MapSize(), MP_VOID, MP_WATER, TileX(), TileXY(), and TileY().

Referenced by FindFurthestFromWater(), and IndustryGetVariable().

static uint MapLogX (  )  [inline, static]

Logarithm of the map size along the X side.

Note:
try to avoid using this one
Returns:
2^"return value" == MapSizeX()

Definition at line 55 of file map_func.h.

References _map_log_x.

Referenced by ScaleByMapSize(), ScaleByMapSize1D(), StartupIndustryDailyChanges(), TileXY(), TileY(), and ToTileIndexDiff().

static uint MapLogY (  )  [inline, static]

Logarithm of the map size along the y side.

Note:
try to avoid using this one
Returns:
2^"return value" == MapSizeY()

Definition at line 66 of file map_func.h.

References _map_log_y.

Referenced by ScaleByMapSize(), ScaleByMapSize1D(), and StartupIndustryDailyChanges().

static uint MapMaxX (  )  [inline, static]
static uint MapMaxY (  )  [inline, static]
static uint MapSize (  )  [inline, static]
static uint MapSizeX (  )  [inline, static]
static uint MapSizeY (  )  [inline, static]
static TileIndex RandomTileSeed ( uint32  r  )  [inline, static]

Get a random tile out of a given seed.

Parameters:
r the random 'seed'
Returns:
a valid tile

Definition at line 445 of file map_func.h.

References TILE_MASK.

Referenced by PlaceTreesRandomly().

static uint ScaleByMapSize ( uint  n  )  [inline, static]

Scales the given value by the map size, where the given value is for a 256 by 256 map.

Parameters:
n the value to scale
Returns:
the scaled size

Definition at line 126 of file map_func.h.

References MapLogX(), and MapLogY().

Referenced by GenerateIndustries(), GenerateLandscape(), GenerateTowns(), GenerateTrees(), GetScaledIndustryProbability(), PlaceMoreTrees(), and PlaceTreesRandomly().

static uint ScaleByMapSize1D ( uint  n  )  [inline, static]

Scales the given value by the maps circumference, where the given value is for a 256 by 256 map.

Parameters:
n the value to scale
Returns:
the scaled size

Definition at line 141 of file map_func.h.

References MapLogX(), and MapLogY().

Referenced by GetScaledIndustryProbability(), and UpdateViewportPosition().

static TileIndex TileAddByDiagDir ( TileIndex  tile,
DiagDirection  dir 
) [inline, static]

Adds a DiagDir to a tile.

Parameters:
tile The current tile
dir The direction in which we want to step
Returns:
the moved tile

Definition at line 396 of file map_func.h.

References TILE_ADD, and TileOffsByDiagDir().

Referenced by CleanUpRoadBits(), ClearPathReservation(), CmdRemoveSingleSignal(), GrowTownAtRoad(), GrowTownInTile(), GrowTownWithBridge(), GrowTownWithExtraHouse(), MaskWireBits(), NeighbourHasReachableRoad(), BuildDocksToolbarWindow::OnPlacePresize(), SetWaterClassDependingOnSurroundings(), and TryPathReserve().

TileIndex TileAddWrap ( TileIndex  tile,
int  addx,
int  addy 
)

Adds an offset to a tile and check if we are still on the map.

This function checks if we add addx/addy to tile, if we do wrap around the edges. For example, tile = (10,2) and addx = +3 and addy = -4. This function will now return INVALID_TILE, because the y is wrapped. This is needed in for example, farmland. When the tile is not wrapped, the result will be tile + TileDiffXY(addx, addy)

Parameters:
tile the 'starting' point of the adding
addx the amount of tiles in the X direction to add
addy the amount of tiles in the Y direction to add
Returns:
translated tile, or INVALID_TILE when it would've wrapped.

Definition at line 113 of file map.cpp.

References _settings_game, GameSettings::construction, ConstructionSettings::freeform_edges, INVALID_TILE, MapMaxX(), MapMaxY(), TileDiffXY(), TileX(), and TileY().

Referenced by CountMapSquareAround(), DisasterTick_Big_Ufo_Destroyer(), DoPlaceMoreTrees(), FindStationsAroundTiles(), and PlaceTreeAtSameHeight().

static TileIndexDiff TileDiffXY ( int  x,
int  y 
) [inline, static]
static TileIndexDiffC TileIndexDiffCByDiagDir ( DiagDirection  dir  )  [inline, static]

Returns the TileIndexDiffC offset from a DiagDirection.

Parameters:
dir The given direction
Returns:
The offset as TileIndexDiffC value

Definition at line 271 of file map_func.h.

References _tileoffs_by_diagdir, DIAGDIR_END, and IsValidDiagDirection().

static TileIndexDiffC TileIndexDiffCByDir ( Direction  dir  )  [inline, static]

Returns the TileIndexDiffC offset from a Direction.

Parameters:
dir The given direction
Returns:
The offset as TileIndexDiffC value

Definition at line 285 of file map_func.h.

References _tileoffs_by_dir, DIR_END, and IsValidDirection().

Referenced by TileLoop_Water().

static TileIndexDiffC TileIndexToTileIndexDiffC ( TileIndex  tile_a,
TileIndex  tile_b 
) [inline, static]

Returns the diff between two tiles.

Parameters:
tile_a from tile
tile_b to tile
Returns:
the difference between tila_a and tile_b

Definition at line 319 of file map_func.h.

References TileX(), TileY(), TileIndexDiffC::x, and TileIndexDiffC::y.

Referenced by GetTownRoadGridElement(), TownLayoutAllows2x2HouseHere(), and TownLayoutAllowsHouseHere().

static TileIndexDiff TileOffsByDiagDir ( DiagDirection  dir  )  [inline, static]

Convert a DiagDirection to a TileIndexDiff.

Parameters:
dir The DiagDirection
Returns:
The resulting TileIndexDiff
See also:
TileIndexDiffCByDiagDir

Definition at line 367 of file map_func.h.

References _tileoffs_by_diagdir, DIAGDIR_END, IsValidDiagDirection(), and ToTileIndexDiff().

Referenced by AIBridge::_BuildBridgeRoad1(), AIBridge::_BuildBridgeRoad2(), AITunnel::_BuildTunnelRoad1(), AITunnel::_BuildTunnelRoad2(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::CanEnterNewTile(), CheckFree2x2Area(), RoadStop::Entry::CheckIntegrity(), CheckTownBuild2House(), CheckTownBuild2x2House(), RoadStop::ClearDriveThrough(), CmdBuildDock(), CmdBuildLongRoad(), CmdBuildRailWaypoint(), CmdBuildRoad(), CmdBuildTunnel(), CmdConvertRail(), Disaster_CoalMine_Init(), DisasterTick_Submarine(), DoBuildShiplift(), DrawCatenaryRailway(), ExploreSegment(), ExtendTrainReservation(), FixOwnerOfRailTrack(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::FollowTileExit(), FollowTrainReservation(), GetBridgeEnd(), AIRoad::GetDriveThroughBackTile(), GetOtherTunnelEnd(), AITunnel::GetOtherTunnelEnd(), Station::GetPlatformLength(), AIRail::GetRailDepotFrontTile(), AIRoad::GetRoadDepotFrontTile(), AIRoad::GetRoadStationFrontTile(), GetTrainForReservation(), GrowTownWithBridge(), CYapfCostRailT< Types >::IsAnyStationTileReserved(), IsNeighborRoadTile(), IsTunnelInWayDir(), MakeDock(), RoadStop::MakeDriveThrough(), NPFRoadVehicleChooseTrack(), NPFSaveTargetData(), NPFShipChooseTrack(), CYapfCostRoadT< Types >::OneTileCost(), OPFShipChooseTrack(), RoadStop::Entry::Rebuild(), RemoveDock(), RemoveRoad(), CYapfReserveTrack< Types >::ReserveRailStationPlatform(), SetRailStationPlatformReservation(), TileAddByDiagDir(), TrainApproachingCrossing(), TrainApproachingCrossingTile(), TrainCheckIfLineEnds(), CYapfReserveTrack< Types >::UnreserveSingleTrack(), and UpdateSignalsInBuffer().

static TileIndexDiff TileOffsByDir ( Direction  dir  )  [inline, static]

Convert a Direction to a TileIndexDiff.

Parameters:
dir The direction to convert from
Returns:
The resulting TileIndexDiff

Definition at line 381 of file map_func.h.

References _tileoffs_by_dir, DIR_END, IsValidDirection(), and ToTileIndexDiff().

Referenced by CircularTileSearch(), FindStationsNearby(), IsWateredTile(), and MarkCanalsAndRiversAroundDirty().

static uint TileX ( TileIndex  tile  )  [inline, static]

Get the X component of a tile.

Parameters:
tile the tile to get the X component of
Returns:
the X component

Definition at line 205 of file map_func.h.

References MapMaxX().

Referenced by AIRoad::_BuildRoadInternal(), AIRoad::_BuildRoadStationInternal(), TileArea::Add(), AddTileIndexDiffCWrap(), AircraftController(), AircraftGetEntryPoint(), AlignTileToGrid(), AIRoad::AreRoadTilesConnected(), AIBridge::BuildBridge(), AIRail::BuildRail(), AIRail::BuildRailDepot(), AIRoad::BuildRoadDepot(), AIRail::BuildSignal(), AIMarine::BuildWaterDepot(), CalcClosestStationTile(), CalcHeightdiff(), CanExpandRailStation(), CheckIfCanLevelIndustryPlatform(), CircularTileSearch(), TileArea::ClampToMap(), CmdBuildAircraft(), CmdBuildBridge(), CmdBuildLongRoad(), CmdBuildRailVehicle(), CmdBuildRailWagon(), CmdBuildRoadVeh(), CmdBuildShip(), CmdBuildTunnel(), CmdClearArea(), CmdConvertRail(), CmdPlaceSign(), CmdRemoveLongRoad(), CommonRaiseLowerBigLand(), DiagdirBetweenTiles(), Disaster_Small_Ufo_Init(), Disaster_Zeppeliner_Init(), DisasterTick_Aircraft(), DisasterTick_Big_Ufo(), DisasterTick_Ufo(), DistanceFromEdge(), DistanceManhattan(), DistanceMax(), DistanceMaxPlusManhattan(), DistanceSquare(), DoCommandP(), DrawTileSelection(), SmallMapWindow::DrawTowns(), FindIndustryToDeliver(), FindStationsNearby(), GetAcceptanceAroundTiles(), GetClosestWaterDistance(), GetDriveableTrackdirBits(), GetMinimalAirportDistanceToTile(), AIRoad::GetNeighbourRoadCount(), GetPCPElevation(), GetProductionAroundTiles(), GetRelativePosition(), AIRail::GetSignalType(), GetTileMaxZ(), GetTileSlope(), AIMap::GetTileX(), GetTileZ(), GetTunnelBridgeLength(), GrayscaleToMapHeights(), GrowTownWithBridge(), GUIPlaceProcDragXY(), HouseGetVariable(), Town::InitializeLayout(), InitializeWindowViewport(), TileArea::Intersects(), IsTileAlignedToGrid(), IsTunnelInWay(), MarkTileDirtyByTile(), NPFDistanceTrack(), NPFHash(), WaypointWindow::OnInvalidateData(), CYapfDestinationTileRoadT< Types >::PfCalcEstimate(), CYapfDestinationTileOrStationRailT< Types >::PfCalcEstimate(), CYapfDestinationTileT< Types >::PfCalcEstimate(), AIRail::RemoveRail(), AIRoad::RemoveRoad(), AIRoad::RemoveRoadFull(), AIRail::RemoveSignal(), SetTileType(), SetWaterClassDependingOnSurroundings(), ShowBuildBridgeWindow(), SimulateDrag(), SwapDirection(), TerraformAddDirtyTileAround(), TerraformTileHeight(), TgenSetTileHeight(), TileAddWrap(), TileArea::TileArea(), TileIndexToTileIndexDiffC(), TileStr(), Waypoint::UpdateVirtCoord(), Town::UpdateVirtCoord(), Station::UpdateVirtCoord(), VehicleFromPos(), VpSelectTilesWithMethod(), VpSetPresizeRange(), and VpStartPlaceSizing().

static TileIndex TileXY ( uint  x,
uint  y 
) [inline, static]
static uint TileY ( TileIndex  tile  )  [inline, static]

Get the Y component of a tile.

Parameters:
tile the tile to get the Y component of
Returns:
the Y component

Definition at line 215 of file map_func.h.

References MapLogX().

Referenced by AIRoad::_BuildRoadInternal(), AIRoad::_BuildRoadStationInternal(), TileArea::Add(), AddTileIndexDiffCWrap(), AircraftController(), AircraftGetEntryPoint(), AlignTileToGrid(), AIRoad::AreRoadTilesConnected(), AIBridge::BuildBridge(), AIRail::BuildRail(), AIRail::BuildRailDepot(), AIRoad::BuildRoadDepot(), AIRail::BuildSignal(), AIMarine::BuildWaterDepot(), CalcClosestStationTile(), CanExpandRailStation(), CheckIfCanLevelIndustryPlatform(), CircularTileSearch(), TileArea::ClampToMap(), CmdBuildAircraft(), CmdBuildBridge(), CmdBuildLongRoad(), CmdBuildRailVehicle(), CmdBuildRailWagon(), CmdBuildRoadVeh(), CmdBuildShip(), CmdBuildTunnel(), CmdClearArea(), CmdConvertRail(), CmdPlaceSign(), CmdRemoveLongRoad(), CommonRaiseLowerBigLand(), DiagdirBetweenTiles(), Disaster_Helicopter_Init(), DisasterTick_Aircraft(), DisasterTick_Big_Ufo(), DisasterTick_Ufo(), DistanceFromEdge(), DistanceManhattan(), DistanceMax(), DistanceMaxPlusManhattan(), DistanceSquare(), DoCommandP(), DrawTileSelection(), SmallMapWindow::DrawTowns(), FindIndustryToDeliver(), FindStationsNearby(), GetAcceptanceAroundTiles(), GetClosestWaterDistance(), GetDriveableTrackdirBits(), GetMinimalAirportDistanceToTile(), AIRoad::GetNeighbourRoadCount(), GetPCPElevation(), GetProductionAroundTiles(), GetRelativePosition(), AIRail::GetSignalType(), GetTileMaxZ(), GetTileSlope(), AIMap::GetTileY(), GetTileZ(), GetTunnelBridgeLength(), GrayscaleToMapHeights(), GrowTownWithBridge(), GUIPlaceProcDragXY(), HouseGetVariable(), Town::InitializeLayout(), InitializeWindowViewport(), TileArea::Intersects(), IsTileAlignedToGrid(), IsTunnelInWay(), MarkTileDirtyByTile(), NPFDistanceTrack(), NPFHash(), WaypointWindow::OnInvalidateData(), CYapfDestinationTileRoadT< Types >::PfCalcEstimate(), CYapfDestinationTileOrStationRailT< Types >::PfCalcEstimate(), CYapfDestinationTileT< Types >::PfCalcEstimate(), AIRail::RemoveRail(), AIRoad::RemoveRoad(), AIRoad::RemoveRoadFull(), AIRail::RemoveSignal(), SetTileType(), SetWaterClassDependingOnSurroundings(), ShowBuildBridgeWindow(), SimulateDrag(), SwapDirection(), TerraformAddDirtyTileAround(), TerraformTileHeight(), TgenSetTileHeight(), TileAddWrap(), TileArea::TileArea(), TileIndexToTileIndexDiffC(), TileStr(), Waypoint::UpdateVirtCoord(), Town::UpdateVirtCoord(), Station::UpdateVirtCoord(), VehicleFromPos(), VpSelectTilesWithMethod(), VpSetPresizeRange(), and VpStartPlaceSizing().

static TileIndexDiff ToTileIndexDiff ( TileIndexDiffC  tidc  )  [inline, static]

Return the offset between to tiles from a TileIndexDiffC struct.

This function works like TileDiffXY(int, int) and returns the difference between two tiles.

Parameters:
tidc The coordinate of the offset as TileIndexDiffC
Returns:
The difference between two tiles.
See also:
TileDiffXY(int, int)

Definition at line 230 of file map_func.h.

References MapLogX(), TileIndexDiffC::x, and TileIndexDiffC::y.

Referenced by CalcHeightdiff(), CmdBuildAirport(), CmdBuildDock(), CmdRailTrackHelper(), CmdSignalTrackHelper(), Ship::GetOrderStationLocation(), GrowTown(), TerraformTileHeight(), TileOffsByDiagDir(), and TileOffsByDir().


Variable Documentation

Tile* _m

Pointer to the tile-array.

This variable points to the tile-array which contains the tiles of the map.

Definition at line 30 of file map.cpp.

Referenced by AddClearCounter(), AddClearDensity(), AddTreeCount(), AddTreeCounter(), AddTreeGrowth(), ClearSingleBridgeMiddle(), ClearSnow(), GetBridgeAxis(), GetBridgeType(), GetCleanHouseType(), GetCleanIndustryGfx(), GetClearCounter(), GetClearDensity(), GetCompanyHQSection(), GetCompanyHQSize(), GetCustomStationSpecIndex(), GetDepotIndex(), GetDisallowedRoadDirections(), GetFenceSE(), GetFenceSW(), GetFieldType(), GetHouseAge(), GetHouseAnimationFrame(), GetHouseBuildingStage(), GetHouseConstructionTick(), GetHouseRandomBits(), GetHouseTriggers(), GetIndustryAnimationLoop(), GetIndustryAnimationState(), GetIndustryConstructionCounter(), GetIndustryConstructionStage(), GetIndustryIndex(), GetIndustryIndexOfField(), GetIndustryTriggers(), GetLiftPosition(), GetPresentSignals(), GetRailDepotDirection(), GetRailReservationTrackBits(), GetRailTileType(), GetRailType(), GetRawClearGround(), GetSignalStates(), GetStationGfx(), GetStationIndex(), GetStationTileRandomBits(), GetStationType(), GetStatueTownID(), GetTileOwner(), GetTileType(), GetTownIndex(), GetTrackBits(), GetTreeCount(), GetTreeCounter(), GetTreeDensity(), GetTreeGround(), GetTreeGrowth(), GetTreeType(), GetTropicZone(), GetTunnelBridgeDirection(), GetTunnelBridgeTransportType(), GetUnmovableType(), HasCrossingReservation(), HasDepotReservation(), HasStationReservation(), HasTunnelBridgeReservation(), IncHouseConstructionTick(), IncrementHouseAge(), IsBridge(), IsBridgeAbove(), IsCompanyHQ(), IsCustomStationSpecIndex(), IsHouseCompleted(), IsIndustryCompleted(), IsSnowTile(), IsTunnel(), MakeBridgeRamp(), MakeClear(), MakeField(), MakeHouseTile(), MakeIndustry(), MakeRailTunnel(), MakeRoadTunnel(), MakeSnow(), MakeStation(), MakeStatue(), MakeTree(), MakeUnmovable(), MakeVoid(), MakeWater(), MoveWaypointsToBaseStations(), ResetHouseAge(), ResetIndustryConstructionStage(), SetBridgeMiddle(), SetClearCounter(), SetClearDensity(), SetClearGroundDensity(), SetCompanyHQSection(), SetCompanyHQSize(), SetCrossingReservation(), SetCustomStationSpecIndex(), SetDepotReservation(), SetDisallowedRoadDirections(), SetFenceSE(), SetFenceSW(), SetFieldType(), SetHasSignals(), SetHouseAnimationFrame(), SetHouseCompleted(), SetHouseRandomBits(), SetHouseTriggers(), SetHouseType(), SetIndustryAnimationLoop(), SetIndustryAnimationState(), SetIndustryCompleted(), SetIndustryConstructionCounter(), SetIndustryConstructionStage(), SetIndustryGfx(), SetIndustryIndexOfField(), SetIndustryTriggers(), SetLiftPosition(), SetPresentSignals(), SetRailStationReservation(), SetRailType(), SetSignalStates(), SetStationGfx(), SetStationTileRandomBits(), SetTileHeight(), SetTileOwner(), SetTileType(), SetTownIndex(), SetTrackBits(), SetTrackReservation(), SetTreeCounter(), SetTreeGroundDensity(), SetTreeGrowth(), SetTropicZone(), SetTunnelBridgeReservation(), SetWaterClassDependingOnSurroundings(), TileHeight(), and CrashLog::WriteSavegame().


Generated on Sun Nov 14 14:42:03 2010 for OpenTTD by  doxygen 1.6.1