heightmap.h File Reference

Functions related to creating heightmaps from files. More...

#include "fileio_type.h"

Go to the source code of this file.

Enumerations
enum	HeightmapRotation { HM_COUNTER_CLOCKWISE , HM_CLOCKWISE }
	Order of these enums has to be the same as in lang/english.txt Otherwise you will get inconsistent behaviour. More...

Functions
bool	GetHeightmapDimensions (DetailedFileType dft, const char *filename, uint *x, uint *y)
	Get the dimensions of a heightmap.
bool	LoadHeightmap (DetailedFileType dft, const char *filename)
	Load a heightmap from file and change the map in its current dimensions to a landscape representing the heightmap.
void	FlatEmptyWorld (uint8_t tile_height)
	Make an empty world where all tiles are of height 'tile_height'.
void	FixSlopes ()
	This function takes care of the fact that land in OpenTTD can never differ more than 1 in height.

Detailed Description

Functions related to creating heightmaps from files.

Definition in file heightmap.h.

Enumeration Type Documentation

HeightmapRotation

enum HeightmapRotation

Order of these enums has to be the same as in lang/english.txt Otherwise you will get inconsistent behaviour.

Enumerator
HM_COUNTER_CLOCKWISE	Rotate the map counter clockwise 45 degrees.
HM_CLOCKWISE	Rotate the map clockwise 45 degrees.

Definition at line 19 of file heightmap.h.

Function Documentation

FixSlopes()

void FixSlopes

(

)

This function takes care of the fact that land in OpenTTD can never differ more than 1 in height.

Definition at line 399 of file heightmap.cpp.

References MAX_TILE_HEIGHT, SetTileHeight(), Map::SizeX(), Map::SizeY(), TileHeight(), and TileXY().

Referenced by FlatEmptyWorld(), GenerateLandscape(), and LoadHeightmap().

FlatEmptyWorld()

void FlatEmptyWorld

(

uint8_t

tile_height

)

Make an empty world where all tiles are of height 'tile_height'.

Parameters

tile_height

of the desired new empty world

Definition at line 521 of file heightmap.cpp.

References _settings_game, GameSettings::construction, FixSlopes(), ConstructionSettings::freeform_edges, MarkWholeScreenDirty(), SetTileHeight(), Map::SizeX(), Map::SizeY(), and TileXY().

Referenced by _GenerateWorld().

GetHeightmapDimensions()

bool GetHeightmapDimensions	(	DetailedFileType	dft,
		const char *	filename,
		uint *	x,
		uint *	y
	)

Get the dimensions of a heightmap.

Parameters

dft	Type of image file.
filename	to query
x	dimension x
y	dimension y

Returns

Returns false if loading of the image failed.

Definition at line 488 of file heightmap.cpp.

References ReadHeightMap().

LoadHeightmap()

bool LoadHeightmap	(	DetailedFileType	dft,
		const char *	filename
	)

Load a heightmap from file and change the map in its current dimensions to a landscape representing the heightmap.

It converts pixels to height. The brighter, the higher.

Parameters

dft	Type of image file.
filename	of the heightmap file to be imported

Definition at line 500 of file heightmap.cpp.

References FixSlopes(), GrayscaleToMapHeights(), MarkWholeScreenDirty(), and ReadHeightMap().

Referenced by GenerateLandscape().