A common base for all ITerrain types. More...

Inheritance diagram for AlphaFramework.World.Terrains.ITerrain:

Public Member Functions
void	MarkUntraversableSlopes (bool[,] obstructionMap, int maxTraversableSlope)
	Marks untraversable slopes in a pathfinding "obstruction map". More...

void	LoadHeightMap (Stream stream)
	Loads data for ITerrain.HeightMap from a stream. More...

void	LoadHeightMap (string path)
	Loads data for ITerrain.HeightMap from a file. More...

void	LoadOcclusionIntervalMap (Stream stream)
	Loads data for ITerrain.OcclusionIntervalMap from a stream. More...

void	LoadOcclusionIntervalMap (string path)
	Loads data for ITerrain.OcclusionIntervalMap from a file. More...

void	LoadTextureMap (Stream stream)
	Loads data for ITerrain.TextureMap from a stream. More...

void	LoadTextureMap (string path)
	Loads data for ITerrain.TextureMap from a file. More...

Properties
TerrainSize	Size `[get, set]`
	The size of the terrain. More...

Vector2	Center `[get]`
	The world coordinates of the center of the terrain. More...

ByteGrid	HeightMap `[get, set]`
	Direct access to the internal height-map array. Handle with care; clone when necessary! More...

ByteVector4Grid	OcclusionIntervalMap `[get, set]`
	Direct access to the internal occlusion interval map array. Handle with care; clone when necessary! More...

bool	OcclusionIntervalMapOutdated `[get, set]`
	Indicates that the data stored in OcclusionIntervalMap is outdated and should be recalculated using OcclusionIntervalMapGenerator. More...

NibbleGrid	TextureMap `[get, set]`
	Direct access to the internal height-map array. Handle with care; clone when necessary! More...

bool	DataLoaded `[get]`
	Was the minimum necessary data for the terrain (HeightMap and TextureMap) loaded already? More...

Detailed Description

A common base for all ITerrain types.

Member Function Documentation

◆ LoadHeightMap() [1/2]

void AlphaFramework.World.Terrains.ITerrain.LoadHeightMap ( Stream stream )

Loads data for ITerrain.HeightMap from a stream.

Parameters

stream The stream to read the height-map from.

Exceptions

IOException The height-map size is incorrect.

Implemented in AlphaFramework.World.Terrains.Terrain< TTemplate >.

◆ LoadHeightMap() [2/2]

void AlphaFramework.World.Terrains.ITerrain.LoadHeightMap ( string path )

Loads data for ITerrain.HeightMap from a file.

Parameters

path	The path of the PNG file to load the height-map from.

Exceptions

IOException The texture-map size is incorrect.

Implemented in AlphaFramework.World.Terrains.Terrain< TTemplate >.

◆ LoadOcclusionIntervalMap() [1/2]

void AlphaFramework.World.Terrains.ITerrain.LoadOcclusionIntervalMap ( Stream stream )

Loads data for ITerrain.OcclusionIntervalMap from a stream.

Parameters

stream The stream to read the occlusion interval map from.

Exceptions

IOException The occlusion interval map size is incorrect.

Implemented in AlphaFramework.World.Terrains.Terrain< TTemplate >.

◆ LoadOcclusionIntervalMap() [2/2]

void AlphaFramework.World.Terrains.ITerrain.LoadOcclusionIntervalMap ( string path )

Loads data for ITerrain.OcclusionIntervalMap from a file.

Parameters

path	The path of the PNG file to load the occlusion interval map from.

Exceptions

IOException The texture-map size is incorrect.

Implemented in AlphaFramework.World.Terrains.Terrain< TTemplate >.

◆ LoadTextureMap() [1/2]

void AlphaFramework.World.Terrains.ITerrain.LoadTextureMap ( Stream stream )

Loads data for ITerrain.TextureMap from a stream.

Parameters

stream The stream to read the texture-map from.

Exceptions

IOException The texture-map size is incorrect.

Implemented in AlphaFramework.World.Terrains.Terrain< TTemplate >.

◆ LoadTextureMap() [2/2]

void AlphaFramework.World.Terrains.ITerrain.LoadTextureMap ( string path )

Loads data for ITerrain.TextureMap from a file.

Parameters

path	The path of the PNG file to load the texture-map from.

Exceptions

IOException The texture-map size is incorrect.

Implemented in AlphaFramework.World.Terrains.Terrain< TTemplate >.

◆ MarkUntraversableSlopes()

void AlphaFramework.World.Terrains.ITerrain.MarkUntraversableSlopes	(	bool	obstructionMap[,],
		int	maxTraversableSlope
	)

Marks untraversable slopes in a pathfinding "obstruction map".

Parameters

obstructionMap	The existing pathfinding "obstruction map" to mark the untraversable slopes in.
maxTraversableSlope	The maximum slope to considers traversable.

Implemented in AlphaFramework.World.Terrains.Terrain< TTemplate >.

Property Documentation

◆ Center

Vector2 AlphaFramework.World.Terrains.ITerrain.Center

get

The world coordinates of the center of the terrain.

◆ DataLoaded

bool AlphaFramework.World.Terrains.ITerrain.DataLoaded

get

Was the minimum necessary data for the terrain (HeightMap and TextureMap) loaded already?

◆ HeightMap

ByteGrid AlphaFramework.World.Terrains.ITerrain.HeightMap

getset

Direct access to the internal height-map array. Handle with care; clone when necessary!

Exceptions

InvalidOperationException The height-map size is incorrect.

Is not serialized/stored, is loaded by LoadHeightMap(Stream).

◆ OcclusionIntervalMap

ByteVector4Grid AlphaFramework.World.Terrains.ITerrain.OcclusionIntervalMap

getset

Direct access to the internal occlusion interval map array. Handle with care; clone when necessary!

Exceptions

InvalidOperationException The size is incorrect.

Is not serialized/stored, is loaded by LoadOcclusionIntervalMap(System.IO.Stream).

◆ OcclusionIntervalMapOutdated

bool AlphaFramework.World.Terrains.ITerrain.OcclusionIntervalMapOutdated

getset

Indicates that the data stored in OcclusionIntervalMap is outdated and should be recalculated using OcclusionIntervalMapGenerator.

◆ Size

TerrainSize AlphaFramework.World.Terrains.ITerrain.Size

getset

The size of the terrain.

◆ TextureMap

NibbleGrid AlphaFramework.World.Terrains.ITerrain.TextureMap

getset

Direct access to the internal height-map array. Handle with care; clone when necessary!

Exceptions

InvalidOperationException The height-map size is incorrect.

Is not serialized/stored, is loaded by LoadTextureMap(string).

The documentation for this interface was generated from the following file:

World/Terrains/ITerrain.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ LoadHeightMap() [1/2]

◆ LoadHeightMap() [2/2]

◆ LoadOcclusionIntervalMap() [1/2]

◆ LoadOcclusionIntervalMap() [2/2]

◆ LoadTextureMap() [1/2]

◆ LoadTextureMap() [2/2]

◆ MarkUntraversableSlopes()

Property Documentation

◆ Center

◆ DataLoaded

◆ HeightMap

◆ OcclusionIntervalMap

◆ OcclusionIntervalMapOutdated

◆ Size

◆ TextureMap