Class Heightmap
Syntax
Constructors
Heightmap(Byte[], Heightmap.Flip)
Declaration
public Heightmap(byte[] rawData, Heightmap.Flip flip)
Parameters
Heightmap(Single[,], Heightmap.Flip)
Declaration
public Heightmap(float[, ] heights, Heightmap.Flip flip)
Parameters
Heightmap(Heightmap, Vector2Int, Vector2Int, Single, Single)
Declaration
public Heightmap(Heightmap parentHeightmap, Vector2Int offset, Vector2Int size, float remap, float baseLevel)
Parameters
Heightmap(Vector2Int)
Declaration
public Heightmap(Vector2Int size)
Parameters
Fields
Base
Declaration
Field Value
Remap
Declaration
Field Value
Size
Declaration
public readonly Vector2Int Size
Field Value
Properties
Height
Declaration
public int Height { get; }
Property Value
Width
Declaration
public int Width { get; }
Property Value
Methods
ApplyTo(Terrain)
Apply the data held by this height-map to the specified piece of terrain.
Declaration
public void ApplyTo(Terrain terrain)
Parameters
Type |
Name |
Description |
Terrain |
terrain |
The terrain to apply the height-map to.
|
ConvertToRawData()
Converts the specified height-map to a 16-bit raw image file.
Declaration
public byte[] ConvertToRawData()
Returns
Type |
Description |
Byte[] |
The array of bytes to be used.
|
FlipHeightsInPlace(Heightmap.Flip)
Declaration
public void FlipHeightsInPlace(Heightmap.Flip flip)
Parameters
GetNormalisedHeightAt(Vector2)
Gets the normalised height at the specified location in the height-map.
Declaration
public float GetNormalisedHeightAt(Vector2 offset)
Parameters
Type |
Name |
Description |
Vector2 |
offset |
The co-ordinates of the height to fetch.
|
Returns
Type |
Description |
Single |
The normalised height at the location specified.
|
SetNormalisedHeights(Vector2Int, Single[,])
Sets the array of normalised heights at the position specified in the height-map.
Declaration
public void SetNormalisedHeights(Vector2Int offset, float[, ] normalisedHeights)
Parameters
ToTexture2D()
Generate a Texture2D from the current height-map.
Declaration
public Texture2D ToTexture2D()
Returns
Type |
Description |
Texture2D |
The Texture2D generated.
|
ToTexture2D(Vector2Int, Single)
Generate a Texture2D from the current height-map applying a checkerboard effect on the alpha-channel.
Declaration
public Texture2D ToTexture2D(Vector2Int checkerboardDimensions, float checkerboardAlpha)
Parameters
Type |
Name |
Description |
Vector2Int |
checkerboardDimensions |
The number of tiles on the checkerboard.
|
Single |
checkerboardAlpha |
The alpha of the dark checkerboard tiles.
|
Returns
Type |
Description |
Texture2D |
The Texture2D generated.
|
ToTexture2D(Vector2Int, Vector2Int, Single)
Generate a Texture2D from the current height-map applying a checkerboard effect on the alpha-channel.
Declaration
public Texture2D ToTexture2D(Vector2Int textureSize, Vector2Int checkerboardDimensions, float checkerboardAlpha)
Parameters
Type |
Name |
Description |
Vector2Int |
textureSize |
The size of the texture to generate.
|
Vector2Int |
checkerboardDimensions |
The number of tiles on the checkerboard.
|
Single |
checkerboardAlpha |
The alpha of the dark checkerboard tiles.
|
Returns
Type |
Description |
Texture2D |
The Texture2D generated.
|