STerrain
Index
Functions Index
| Function Name | Description |
|---|---|
| float GetHeight (float x, float y) | Get an interpolated height at a point x,y. |
| float GetSteepness (float x, float y) | Get the gradient of the terrain at point (x,y). |
| float[,] GetHeights () | Get an array of heightmap samples. |
| void SetHeights (float[,] data) | Set the resolution of the detail map. |
| void SetHeight (int x, int y, float value) | Set value to height of [x,y] |
| SVector GetNormal (float x, float y) | Get an interpolated normal at a given location. |
| SVector GetSlope (float x, float y) | Get a normalized and interpolated normal at a given location. |
| SVector GetContour (float x, float y) | Get a contour of interpolated normal at a given location. |
Properties Index
| Property Name |
|---|
bool Enabled get set |
SGameObject GameObject get |
Functions
GetHeight
float GetHeight (float x, float y)
Get an interpolated height at a point x,y.
| Parameter | Type | Description |
|---|---|---|
- Lua
floatHeight = Space.Host.ExecutingObject.Terrain.GetHeight(1,1)
GetSteepness
float GetSteepness (float x, float y)
Get the gradient of the terrain at point (x,y).
| Parameter | Type | Description |
|---|---|---|
- Lua
floatSteepness = Space.Host.ExecutingObject.Terrain.GetSteepness(1,1)
GetHeights
float[,] GetHeights ()
Returns a two dimensional array of heightmap samples. The samples are represented as float values ranging from 0 to 1. The array has the dimensions [height,width] and is indexed as [y,x].
- Lua
tableHeights = Space.Host.ExecutingObject.Terrain.GetHeights()
SetHeights
void SetHeights (float[,] data)
Sets heightmap data using a two dimensional array of heightmap samples. The samples are represented as float values ranging from 0 to 1. The heights array is indexed as [y,x].
| Parameter | Type | Description |
|---|---|---|
- Lua
tableHeights = Space.Host.ExecutingObject.Terrain.SetHeights({{1,2},{1,2}})
SetHeight
void SetHeight (int x, int y, float value)
Set value to height of [x,y]
| Parameter | Type | Description |
|---|---|---|
- Lua
Space.Host.ExecutingObject.Terrain.SetHeight(1,1,0.11)
GetNormal
SVector GetNormal (float x, float y)
Get an interpolated normal at a given location.
| Parameter | Type | Description |
|---|---|---|
- Lua
vectorNormal = Space.Host.ExecutingObject.Terrain.GetNormal(1,1)
GetSlope
SVector GetSlope (float x, float y)
Get a normalized and interpolated normal at a given location.
| Parameter | Type | Description |
|---|---|---|
- Lua
vectorSlope = Space.Host.ExecutingObject.Terrain.GetSlope(1,1)
GetContour
SVector GetContour (float x, float y)
Get a contour of interpolated normal at a given location.
| Parameter | Type | Description |
|---|---|---|
- Lua
vectorContour = Space.Host.ExecutingObject.Terrain.GetContour(1,1)
Properties
Enabled
bool Enabled get set
Is the Terrain component enabled?
- Lua
Space.Host.ExecutingObject.Terrain.Enabled = false
GameObject
SGameObject GameObject get
The GameObject that this Terrain component is added to.
- Lua
theGameObject = Space.Host.ExecutingObject.Terrain.GameObject