SineSpace.Scripting.Components.STerrain Class Reference

Inheritance diagram for SineSpace.Scripting.Components.STerrain:

Public Member Functions
float	GetHeight (float x, float y)
	Get an interpolated height at a point x,y. More...
float	GetSteepness (float x, float y)
	Get the gradient of the terrain at point (x,y). More...
float[,]	GetHeights ()
	Get an array of heightmap samples. More...
void	SetHeights (float[,] data)
	Set the resolution of the detail map. More...
void	SetHeight (int x, int y, float value)
	Set value to height of [x,y] More...
SVector	GetNormal (float x, float y)
	Get an interpolated normal at a given location. More...
SVector	GetSlope (float x, float y)
	Get a normalized and interpolated normal at a given location. More...
SVector	GetContour (float x, float y)
	Get a contour of interpolated normal at a given location. More...

Properties
bool	Enabled [get, set]
	Whether the terrain component is Enabled. More...
Properties inherited from ScriptClassComponent< Terrain >
SGameObject	GameObject [get]
	Return the GameObject which component added. More...

Member Function Documentation

GetContour()

SVector SineSpace.Scripting.Components.STerrain.GetContour	(	float	x,
		float	y
	)

Get a contour of interpolated normal at a given location.

local terrain=Space.Host.GetReference("Terrain").Terrain
local contour=terrain.GetContour(1,1)
Space.Log(contour)

Parameters

x	The x offset to read from.
y	The y offset to read from.

GetHeight()

float SineSpace.Scripting.Components.STerrain.GetHeight	(	float	x,
		float	y
	)

Get an interpolated height at a point x,y.

local terrain=Space.Host.GetReference("Terrain").Terrain
local height=terrain.GetHeight(1,1)
Space.Log(height)

Parameters

x	The x offset to read from.
y	The y offset to read from.

GetHeights()

float [,] SineSpace.Scripting.Components.STerrain.GetHeights

(

)

Get an array of heightmap samples.

local terrain=Space.Host.GetReference("Terrain").Terrain
local heights=terrain.GetHeights()
function Heights()
    for i=1, #heights do
        for j=1, #heights[i] do
        Space.Log(heights[i][j])
        end
    end
end

GetNormal()

SVector SineSpace.Scripting.Components.STerrain.GetNormal	(	float	x,
		float	y
	)

Get an interpolated normal at a given location.

local terrain=Space.Host.GetReference("Terrain").Terrain
local vec=terrain.GetNormal(1,1)
Space.Log(vec)

Parameters

x	The x offset to read from.
y	The y offset to read from.

GetSlope()

SVector SineSpace.Scripting.Components.STerrain.GetSlope	(	float	x,
		float	y
	)

Get a normalized and interpolated normal at a given location.

local terrain=Space.Host.GetReference("Terrain").Terrain
local slope=terrain.GetSlope(1,1)
Space.Log(slope)

Parameters

x	The x offset to read from.
y	The y offset to read from.

GetSteepness()

float SineSpace.Scripting.Components.STerrain.GetSteepness	(	float	x,
		float	y
	)

Get the gradient of the terrain at point (x,y).

local terrain=Space.Host.GetReference("Terrain").Terrain
local steepness=terrain.GetSteepness(1,1)
Space.Log(steepness)

Parameters

x	The x offset to read from.
y	The y offset to read from.

SetHeight()

void SineSpace.Scripting.Components.STerrain.SetHeight	(	int	x,
		int	y,
		float	value
	)

Set value to height of [x,y]

local terrain=Space.Host.GetReference("Terrain").Terrain
terrain.SetHeight(1,1,0.11)
Space.Log(terrain.GetHeight(1,1))

Parameters

x	The x offset to read from
y	The y offset to read from
value	the value set

SetHeights()

void SineSpace.Scripting.Components.STerrain.SetHeights

(

float

data[,]

)

Set the resolution of the detail map.

local terrain=Space.Host.GetReference("Terrain").Terrain    
<br>
local heights=terrain.GetHeights()
heights[1][1]=20
terrain.SetHeights(heights)
heights=terrain.GetHeights()
Space.Log(heights[1][1])
&ndash;This will show "20"

Property Documentation

Enabled

bool SineSpace.Scripting.Components.STerrain.Enabled

getset

Whether the terrain component is Enabled.

local terrain=Space.Host.GetReference("Terrain").Terrain
Space.Log(terrain.Enabled)