Interface IBrushRenderWithTerrain
An interface that represent all of the functionality required to render a terrain-brush at a particular UV co-ordinate on a particular terrain.
Inherited Members
Namespace: UnityEditor.TerrainTools
Assembly: Unity.TerrainTools.Editor.dll
Syntax
public interface IBrushRenderWithTerrain : IPaintContextRender, IDisposableMethods
AcquireHeightmap(bool, Terrain, Rect, int)
Gets the PaintContext for the height-map at the bounds specified, you need to say whether this is to be writable upon acquisition.
Declaration
PaintContext AcquireHeightmap(bool writable, Terrain terrain, Rect boundsInTerrainSpace, int extraBorderPixels = 0)Parameters
| Type | Name | Description |
|---|---|---|
| bool | writable | Determines if we wish to allow writing to the height-map. |
| Terrain | terrain | The initial terrain to acquire the height-map. |
| Rect | boundsInTerrainSpace | The bounds of the height-map to use (in pixels). |
| int | extraBorderPixels | Extra padding on the bounds specified. |
Returns
| Type | Description |
|---|---|
| PaintContext | Returns the paint context created. |
AcquireHolesTexture(bool, Terrain, Rect, int)
Gets the PaintContext for the holes at the bounds specified, you need to say whether this is to be writable upon acquisition.
Declaration
PaintContext AcquireHolesTexture(bool writable, Terrain terrain, Rect boundsInTerrainSpace, int extraBorderPixels = 0)Parameters
| Type | Name | Description |
|---|---|---|
| bool | writable | Determines if we wish to allow writing to the normal-map. |
| Terrain | terrain | The initial terrain to acquire the normal-map. |
| Rect | boundsInTerrainSpace | The bounds of the normal-map to use (in pixels). |
| int | extraBorderPixels | Extra padding on the bounds specified. |
Returns
| Type | Description |
|---|---|
| PaintContext | Returns the paint context created. |
AcquireNormalmap(bool, Terrain, Rect, int)
Gets the PaintContext for the normal-map at the bounds specified, you need to say whether this is to be writable upon acquisition.
Declaration
PaintContext AcquireNormalmap(bool writable, Terrain terrain, Rect boundsInTerrainSpace, int extraBorderPixels = 0)Parameters
| Type | Name | Description |
|---|---|---|
| bool | writable | Determines if we wish to allow writing to the normal-map. |
| Terrain | terrain | The initial terrain to acquire the normal-map. |
| Rect | boundsInTerrainSpace | The bounds of the normal-map to use (in pixels). |
| int | extraBorderPixels | Extra padding on the bounds specified. |
Returns
| Type | Description |
|---|---|
| PaintContext | Returns the paint context created. |
AcquireTexture(bool, Terrain, Rect, TerrainLayer, int)
Gets the PaintContext for the texture-map at the bounds specified, you need to say whether this is to be writable upon acquisition.
Declaration
PaintContext AcquireTexture(bool writable, Terrain terrain, Rect boundsInTerrainSpace, TerrainLayer layer, int extraBorderPixels = 0)Parameters
| Type | Name | Description |
|---|---|---|
| bool | writable | Determines if we wish to allow writing to the texture-map. |
| Terrain | terrain | The initial terrain to acquire the texture-map. |
| Rect | boundsInTerrainSpace | The bounds of the texture-map to use (in pixels). |
| TerrainLayer | layer | The terrain layer to acquire the texture-map for. |
| int | extraBorderPixels | Extra padding on the bounds specified. |
Returns
| Type | Description |
|---|---|
| PaintContext | Returns the paint context created. |
CalculateBrushTransform(Terrain, Vector2, float, float, out BrushTransform)
Calculates the brush-transform on the specified terrain at the specified UV co-ordinates (taking into account scattering).
Declaration
bool CalculateBrushTransform(Terrain terrain, Vector2 uv, float size, float rotation, out BrushTransform brushTransform)Parameters
| Type | Name | Description |
|---|---|---|
| Terrain | terrain | The terrain to calculate the brush-transform for. |
| Vector2 | uv | The UV co-ordinate on that terrain. |
| float | size | The size of the brush. |
| float | rotation | The rotation about the Y axis of the brush. |
| BrushTransform | brushTransform | The brush-transform on the terrain at the specified UV co-ordinates. |
Returns
| Type | Description |
|---|---|
| bool | Returns |
CalculateBrushTransform(Terrain, Vector2, float, out BrushTransform)
Calculates the brush-transform on the specified terrain at the specified UV co-ordinates (taking into account scattering).
Declaration
bool CalculateBrushTransform(Terrain terrain, Vector2 uv, float size, out BrushTransform brushTransform)Parameters
| Type | Name | Description |
|---|---|---|
| Terrain | terrain | The terrain to calculate the brush-transform for. |
| Vector2 | uv | The UV co-ordinate on that terrain. |
| float | size | The size of the brush. |
| BrushTransform | brushTransform | The brush-transform on the terrain at the specified UV co-ordinates. |
Returns
| Type | Description |
|---|---|
| bool | Returns "true" if calculated successfully, "false" otherwise. |
CalculateBrushTransform(Terrain, Vector2, out BrushTransform)
Calculates the brush-transform on the specified terrain at the specified UV co-ordinates (taking into account scattering).
Declaration
bool CalculateBrushTransform(Terrain terrain, Vector2 uv, out BrushTransform brushTransform)Parameters
| Type | Name | Description |
|---|---|---|
| Terrain | terrain | The terrain to calculate the brush-transform for. |
| Vector2 | uv | The UV co-ordinate on that terrain. |
| BrushTransform | brushTransform | The brush-transform on the terrain at the specified UV co-ordinates. |
Returns
| Type | Description |
|---|---|
| bool | Returns "true" if calculated successfully, "false" otherwise. |
Release(PaintContext)
Releases the PaintContext specified, if this was made writable when acquired, then we write back into the texture at this point.
Declaration
void Release(PaintContext paintContext)Parameters
| Type | Name | Description |
|---|---|---|
| PaintContext | paintContext | The paint context to be released. |