class in UnityEngine
/
Inherits from:Object
/
Implemented in:UnityEngine.TerrainModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseThe TerrainData class stores heightmaps, detail mesh positions, tree instances, and terrain texture alpha maps.
The Terrain component links to the terrain data and renders it.
AlphamapTextureName | The name for the Terrain alpha map textures. |
HolesTextureName | The name for the Terrain holes Texture. |
alphamapHeight | Height of the alpha map. (Read only.) |
alphamapLayers | Number of alpha map layers. |
alphamapResolution | The size of the alpha map in texels for either the width or the height. |
alphamapTextureCount | Returns the number of alphamap textures. |
alphamapTextures | Alpha map textures used by the Terrain. Used by Terrain Inspector for undo. |
alphamapWidth | Width of the alpha map. |
baseMapResolution | Resolution of the base map used for rendering far patches on the terrain. |
bounds | The local bounding box of the TerrainData object. |
detailHeight | The resolution of the detail data stored in TerrainData. |
detailPatchCount | The number of patches along a terrain tile edge. This is squared to make a grid of patches. |
detailPrototypes | Contains the detail texture/meshes that the Terrain has. |
detailResolution | Detail Resolution of the TerrainData. |
detailResolutionPerPatch | Detail Resolution of each patch. A larger value will decrease the number of batches used by detail objects. |
detailScatterMode | Additional resources: DetailScatterMode |
detailWidth | The resolution of the detail data stored in TerrainData. |
enableHolesTextureCompression | Enable the Terrain holes Texture compression. |
heightmapResolution | The size of the heightmap in texels for either the width or the height. |
heightmapScale | Returns a Vector3 where the x and z components are the size of each heightmap sample (i.e. the space between two neighboring heightmap samples), and the y component is the entire Terrain's height range in world space. |
heightmapTexture | Returns the heightmap texture. |
holesResolution | Returns the Terrain holes resolution for both the data and the Texture. |
holesTexture | Returns the Terrain holes Texture. |
maxDetailScatterPerRes | The maximum value of each sample in the detail map of the terrain data. |
size | The total size in world units of the terrain. |
terrainLayers | Retrieves the terrain layers used by the current terrain. |
treeInstanceCount | Returns the number of tree instances. |
treeInstances | Contains the current trees placed in the terrain. |
treePrototypes | The list of tree prototypes available in the inspector. |
wavingGrassAmount | Amount of waving grass in the terrain. |
wavingGrassSpeed | Speed of the waving grass. |
wavingGrassStrength | Strength of the waving grass in the terrain. |
wavingGrassTint | Color of the waving grass that the terrain has. |
ComputeDetailCoverage | This function computes and returns the coverage (how many instances fit in a square unit) of a detail prototype, given its index. |
ComputeDetailInstanceTransforms | This function computes and returns an array of detail object transforms for the specified patch and the specified prototype. You can use this function to retrieve the exact same transform data the Unity engine uses for detail rendering. |
CopyActiveRenderTextureToHeightmap | Copies the specified part of the active RenderTexture to the Terrain heightmap texture. |
CopyActiveRenderTextureToTexture | Copies the specified part of the active RenderTexture to the Terrain texture. |
DirtyHeightmapRegion | Marks the specified part of the heightmap as dirty. |
DirtyTextureRegion | Marks the specified part of the Terrain texture as dirty. |
GetAlphamaps | Returns the alpha map at a position x, y given a width and height. |
GetAlphamapTexture | Returns the alphamap texture at the specified index. |
GetClampedDetailPatches | Returns an array of detail patches, which are each identified by X-Z coordinates. Detail objects in the patches are clamped to the maximum count. |
GetDetailLayer | Returns a 2D array of the detail object density (i.e. the number of detail objects for this layer) in the specific location. |
GetHeight | Gets the world space height of the Terrain at a certain point x,y without adding the Terrain's world position y. |
GetHeights | Gets an array of heightmap samples. |
GetHoles | Gets an array of Terrain holes samples. |
GetInterpolatedHeight | Gets an interpolated height at a point x,y. The x and y coordinates are clamped to [0, 1]. |
GetInterpolatedHeights | Gets an array of terrain height values using the normalized x,y coordinates. |
GetInterpolatedNormal | Get an interpolated normal at a given location. |
GetMaximumHeightError | Returns an array of tesselation maximum height error values per renderable terrain patch. The returned array can be modified and passed to OverrideMaximumHeightError. |
GetPatchMinMaxHeights | Returns an array of min max height values for all the renderable patches in a terrain. The returned array can be modified and then passed to OverrideMinMaxPatchHeights. |
GetSteepness | Gets the gradient of the terrain at point (x,y). The gradient's value is always positive. |
GetSupportedLayers | Returns an array of all supported detail layer indices in the area. |
GetTreeInstance | Gets the tree instance at the specified index. It is used as a faster version of treeInstances[index] as this function doesn't create the entire tree instances array. |
IsHole | Gets whether a certain point at x,y is a hole. |
OverrideMaximumHeightError | Override the maximum tessellation height error with user provided values. Note that the overriden values get reset when the terrain resolution is changed and stays unchanged when the terrain heightmap is painted or changed via script. |
OverrideMinMaxPatchHeights | Override the minimum and maximum patch heights for every renderable terrain patch. Note that the overriden values get reset when the terrain resolution is changed and stays unchanged when the terrain heightmap is painted or changed via script. |
RefreshPrototypes | Reloads all the values of the available prototypes (ie, detail mesh assets) in the TerrainData Object. |
RemoveDetailPrototype | Removes the detail prototype at the specified index. |
SetAlphamaps | Assign all splat values in the given map area. |
SetBaseMapDirty | Marks the terrain data as dirty to trigger an update of the terrain basemap texture. |
SetDetailLayer | Sets the detail layer density map. |
SetDetailResolution | Sets the resolution of the detail map. |
SetDetailScatterMode | Sets the DetailScatterMode. |
SetHeights | Sets an array of heightmap samples. |
SetHeightsDelayLOD | Sets an array of heightmap samples. |
SetHoles | Sets an array of Terrain holes samples. |
SetHolesDelayLOD | Sets an array of Terrain holes samples. |
SetTerrainLayersRegisterUndo | This function sets the terrainLayers property, and in addition, registers the action to the Editor's undo stack. |
SetTreeInstance | Sets the tree instance with new parameters at the specified index. However, you cannot change TreeInstance.prototypeIndex and TreeInstance.position. If you change them, the method throws an ArgumentException. |
SetTreeInstances | Sets the Tree Instance array, and optionally snaps Trees onto the surface of the Terrain heightmap. |
SyncHeightmap | Performs synchronization queued by previous calls to CopyActiveRenderTextureToHeightmap and DirtyHeightmapRegion, which makes the height data and LOD data used for tessellation up to date. |
SyncTexture | Performs synchronization queued by previous calls to CopyActiveRenderTextureToTexture and DirtyTextureRegion, which makes CPU data of the Terrain textures up to date. |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
GetInstanceID | Gets the instance ID of the object. |
ToString | Returns the name of the object. |
Destroy | Removes a GameObject, component or asset. |
DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
FindAnyObjectByType | Retrieves any active loaded object of Type type. |
FindFirstObjectByType | Retrieves the first active loaded object of Type type. |
FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
InstantiateAsync | Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. |
bool | Does the object exist? |
operator != | Compares if two objects refer to a different object. |
operator == | Compares two object references to see if they refer to the same object. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.