Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetInterpolatedHeights

Gets an array of terrain height values using the normalized x,y coordinates.
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.TerrainModule

GetInterpolatedHeights(float, float, int, int, float, float)

Gets an array of terrain height values using the normalized x,y coordinates.
public float[,] GetInterpolatedHeights(float xBase, float yBase, int xCount, int yCount, float xInterval, float yInterval)

Parameters

xBase

The base x coordinate.

yBase

The base y coordinate.

xCount

The number of queries along the X axis.

yCount

The number of queries along the Y axis.

xInterval

The interval between each query along the X axis.

yInterval

The interval between each query along the Y axis.

Returns

Type

Description

float[,]

Remarks

The function returns a two-dimensional array of size [yCount, xCount]. Each returned value is an interpolation between the four neighboring Terrain height samples, based on where the sampling point is located within the quad of the four neighboring samples. The sampling points are evenly distributed, starting at (xBase, yBase). Points are spaced
xInterval
apart along the X axis, and
yInterval
apart along the Y axis. All the floating point arguments are specified as normalized coordinates, with 0 indicating the left/top border of the Terrain, and 1 indicating the right/bottom border of the Terrain. If a sampling point is placed outside of [0,1], it is clamped to the range.

GetInterpolatedHeights(Single[0:,0:], int, int, float, float, int, int, float, float)

Fills the array with Terrain height values using normalized x,y coordinates.
public void GetInterpolatedHeights(float[,] results, int resultXOffset, int resultYOffset, float xBase, float yBase, int xCount, int yCount, float xInterval, float yInterval)

Parameters

results

The array to fill with height values.

resultXOffset

The offset from the beginning of the array, along the X axis, at which to start filling in height values.

resultYOffset

The offset from the beginning of the array, along the Y axis, at which to start filling in height values.

xBase

The base x coordinate.

yBase

The base y coordinate.

xCount

The number of queries along the X axis.

yCount

The number of queries along the Y axis.

xInterval

The interval between each query along the X axis.

yInterval

The interval between each query along the Y axis.

Remarks

The function takes a two-dimensional array, and fills height values into the part starting at (resultXOffset, resultYOffset). Unlike the function overload above, Unity guarantees not to allocate any memory during calls to the
GetInterpolatedHeights
function.