Class TerrainData

Inheritance
Object
Object
TerrainData
Inherited Members
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
public sealed class TerrainData : Object

Constructors

| Improve this Doc View Source

TerrainData()

Declaration
public TerrainData()

Properties

| Improve this Doc View Source

alphamapHeight

Declaration
public int alphamapHeight { get; }
Property Value
Type Description
Int32

alphamapLayers

Declaration
public int alphamapLayers { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

alphamapResolution

Declaration
public int alphamapResolution { get; set; }
Property Value
Type Description
Int32

alphamapTextureCount

Declaration
public int alphamapTextureCount { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

alphamapTextures

Declaration
public Texture2D[] alphamapTextures { get; }
Property Value
Type Description
Texture2D[]
| Improve this Doc View Source

alphamapWidth

Declaration
public int alphamapWidth { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

baseMapResolution

Declaration
public int baseMapResolution { get; set; }
Property Value
Type Description
Int32

bounds

Declaration
public Bounds bounds { get; }
Property Value
Type Description
Bounds

detailHeight

Declaration
public int detailHeight { get; }
Property Value
Type Description
Int32

detailPatchCount

Declaration
public int detailPatchCount { get; }
Property Value
Type Description
Int32

detailPrototypes

Declaration
public DetailPrototype[] detailPrototypes { get; set; }
Property Value
Type Description
DetailPrototype[]

detailResolution

Declaration
public int detailResolution { get; }
Property Value
Type Description
Int32

detailResolutionPerPatch

Declaration
public int detailResolutionPerPatch { get; }
Property Value
Type Description
Int32

detailWidth

Declaration
public int detailWidth { get; }
Property Value
Type Description
Int32

heightmapHeight

Declaration
public int heightmapHeight { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

heightmapResolution

Declaration
public int heightmapResolution { get; set; }
Property Value
Type Description
Int32

heightmapScale

Declaration
public Vector3 heightmapScale { get; }
Property Value
Type Description
Vector3

heightmapTexture

Declaration
public RenderTexture heightmapTexture { get; }
Property Value
Type Description
RenderTexture

heightmapWidth

Declaration
public int heightmapWidth { get; }
Property Value
Type Description
Int32

size

Declaration
public Vector3 size { get; set; }
Property Value
Type Description
Vector3

splatPrototypes

Declaration
[Obsolete("Please use the terrainLayers API instead.", false)]
public SplatPrototype[] splatPrototypes { get; set; }
Property Value
Type Description
SplatPrototype[]

terrainLayers

Declaration
public TerrainLayer[] terrainLayers { get; set; }
Property Value
Type Description
TerrainLayer[]

thickness

Declaration
public float thickness { get; set; }
Property Value
Type Description
Single

treeInstanceCount

Declaration
public int treeInstanceCount { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

treeInstances

Declaration
public TreeInstance[] treeInstances { get; set; }
Property Value
Type Description
TreeInstance[]

treePrototypes

Declaration
public TreePrototype[] treePrototypes { get; set; }
Property Value
Type Description
TreePrototype[]

wavingGrassAmount

Declaration
public float wavingGrassAmount { get; set; }
Property Value
Type Description
Single

wavingGrassSpeed

Declaration
public float wavingGrassSpeed { get; set; }
Property Value
Type Description
Single

wavingGrassStrength

Declaration
public float wavingGrassStrength { get; set; }
Property Value
Type Description
Single

wavingGrassTint

Declaration
public Color wavingGrassTint { get; set; }
Property Value
Type Description
Color

Methods

| Improve this Doc View Source

GetAlphamaps(Int32, Int32, Int32, Int32)

Declaration
public float[,, ] GetAlphamaps(int x, int y, int width, int height)
Parameters
Type Name Description
Int32 x
Int32 y
Int32 width
Int32 height
Returns
Type Description
Single[,,]

GetAlphamapTexture(Int32)

Declaration
public Texture2D GetAlphamapTexture(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
Texture2D

GetDetailLayer(Int32, Int32, Int32, Int32, Int32)

Declaration
public int[, ] GetDetailLayer(int xBase, int yBase, int width, int height, int layer)
Parameters
Type Name Description
Int32 xBase
Int32 yBase
Int32 width
Int32 height
Int32 layer
Returns
Type Description
Int32[,]

GetHeight(Int32, Int32)

Declaration
public float GetHeight(int x, int y)
Parameters
Type Name Description
Int32 x
Int32 y
Returns
Type Description
Single
| Improve this Doc View Source

GetHeights(Int32, Int32, Int32, Int32)

Declaration
public float[, ] GetHeights(int xBase, int yBase, int width, int height)
Parameters
Type Name Description
Int32 xBase
Int32 yBase
Int32 width
Int32 height
Returns
Type Description
Single[,]

GetInterpolatedHeight(Single, Single)

Declaration
public float GetInterpolatedHeight(float x, float y)
Parameters
Type Name Description
Single x
Single y
Returns
Type Description
Single

GetInterpolatedNormal(Single, Single)

Declaration
public Vector3 GetInterpolatedNormal(float x, float y)
Parameters
Type Name Description
Single x
Single y
Returns
Type Description
Vector3

GetMaximumHeightError()

Declaration
public float[] GetMaximumHeightError()
Returns
Type Description
Single[]

GetPatchMinMaxHeights()

Declaration
public PatchExtents[] GetPatchMinMaxHeights()
Returns
Type Description
PatchExtents[]

GetSteepness(Single, Single)

Declaration
public float GetSteepness(float x, float y)
Parameters
Type Name Description
Single x
Single y
Returns
Type Description
Single

GetSupportedLayers(Int32, Int32, Int32, Int32)

Declaration
public int[] GetSupportedLayers(int xBase, int yBase, int totalWidth, int totalHeight)
Parameters
Type Name Description
Int32 xBase
Int32 yBase
Int32 totalWidth
Int32 totalHeight
Returns
Type Description
Int32[]
| Improve this Doc View Source

GetTreeInstance(Int32)

Declaration
public TreeInstance GetTreeInstance(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
TreeInstance

OverrideMaximumHeightError(Single[])

Declaration
public void OverrideMaximumHeightError(float[] maxError)
Parameters
Type Name Description
Single[] maxError

OverrideMinMaxPatchHeights(PatchExtents[])

Declaration
public void OverrideMinMaxPatchHeights(PatchExtents[] minMaxHeights)
Parameters
Type Name Description
PatchExtents[] minMaxHeights

RefreshPrototypes()

Declaration
public void RefreshPrototypes()
| Improve this Doc View Source

SetAlphamaps(Int32, Int32, Single[,,])

Declaration
public void SetAlphamaps(int x, int y, float[,, ] map)
Parameters
Type Name Description
Int32 x
Int32 y
Single[,,] map

SetBaseMapDirty()

Declaration
public void SetBaseMapDirty()
| Improve this Doc View Source

SetDetailLayer(Int32, Int32, Int32, Int32[,])

Declaration
public void SetDetailLayer(int xBase, int yBase, int layer, int[, ] details)
Parameters
Type Name Description
Int32 xBase
Int32 yBase
Int32 layer
Int32[,] details
| Improve this Doc View Source

SetDetailResolution(Int32, Int32)

Declaration
public void SetDetailResolution(int detailResolution, int resolutionPerPatch)
Parameters
Type Name Description
Int32 detailResolution
Int32 resolutionPerPatch
| Improve this Doc View Source

SetHeights(Int32, Int32, Single[,])

Declaration
public void SetHeights(int xBase, int yBase, float[, ] heights)
Parameters
Type Name Description
Int32 xBase
Int32 yBase
Single[,] heights
| Improve this Doc View Source

SetHeightsDelayLOD(Int32, Int32, Single[,])

Declaration
public void SetHeightsDelayLOD(int xBase, int yBase, float[, ] heights)
Parameters
Type Name Description
Int32 xBase
Int32 yBase
Single[,] heights

SetTreeInstance(Int32, TreeInstance)

Declaration
public void SetTreeInstance(int index, TreeInstance instance)
Parameters
Type Name Description
Int32 index
TreeInstance instance

UpdateDirtyRegion(Int32, Int32, Int32, Int32, Boolean)

Declaration
public void UpdateDirtyRegion(int x, int y, int width, int height, bool syncHeightmapTextureImmediately)
Parameters
Type Name Description
Int32 x
Int32 y
Int32 width
Int32 height
Boolean syncHeightmapTextureImmediately

Extension Methods