Class Heightmap

Inheritance

System.Object

Heightmap

Namespace: UnityEngine.Experimental.TerrainAPI

Syntax

public class Heightmap

Constructors

Heightmap(Byte[], Heightmap.Flip)

Declaration

public Heightmap(byte[] rawData, Heightmap.Flip flip)

Parameters

Type	Name	Description
System.Byte[]	rawData
Heightmap.Flip	flip

Heightmap(Single[,], Heightmap.Flip)

Declaration

public Heightmap(float[, ] heights, Heightmap.Flip flip)

Parameters

Type	Name	Description
System.Single[,]	heights
Heightmap.Flip	flip

Heightmap(Heightmap, Vector2Int, Vector2Int, Single, Single)

Declaration

public Heightmap(Heightmap parentHeightmap, Vector2Int offset, Vector2Int size, float remap, float baseLevel)

Parameters

Type	Name	Description
Heightmap	parentHeightmap
Vector2Int	offset
Vector2Int	size
System.Single	remap
System.Single	baseLevel

Heightmap(Vector2Int)

Declaration

public Heightmap(Vector2Int size)

Parameters

Type	Name	Description
Vector2Int	size

Fields

Base

Declaration

public float Base

Field Value

Type	Description
System.Single

Remap

Declaration

public float Remap

Field Value

Type	Description
System.Single

Size

Declaration

public readonly Vector2Int Size

Field Value

Type	Description
Vector2Int

Properties

Height

Declaration

public int Height { get; }

Property Value

Type	Description
System.Int32

Width

Declaration

public int Width { get; }

Property Value

Type	Description
System.Int32

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
System.Byte[]	The array of bytes to be used.

FlipHeightsInPlace(Heightmap.Flip)

Declaration

public void FlipHeightsInPlace(Heightmap.Flip flip)

Parameters

Type	Name	Description
Heightmap.Flip	flip

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
System.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

Type	Name	Description
Vector2Int	offset
System.Single[,]	normalisedHeights

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.
System.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.
System.Single	checkerboardAlpha	The alpha of the dark checkerboard tiles.

Returns

Type	Description
Texture2D	The Texture2D generated.