Skip to content

Terrain Object

The terrain array contains terrain data for site context. The array always contains exactly one object with terrain parameters.

Terrain Array

KeyTypeDescription
parametersObjectTerrain parameters object defining the terrain properties.

Parameters Object

Each terrain object contains a parameters object with the following properties:

KeyTypeDescription
currentYPositionNumberCurrent Y position of the terrain.
cutOperationDataObject|nullData for cut operations on the terrain.
fadeNumberFade value for terrain blending.
fillOperationDataObject|nullData for fill operations on the terrain.
groundHeightNumberHeight of the ground level.
isHeightMapEnabledBooleanWhether height map is enabled for the terrain.
isLoadedviaAIWorkflowBooleanWhether the terrain was loaded via AI workflow.
isLockedBooleanWhether the terrain is locked from editing.
isSatelliteEnabledBooleanWhether satellite imagery is enabled.
layerIdStringID of the layer this terrain belongs to.
mapCenterObjectMap center coordinates {lng: Number, lat: Number}.
mapZoomNumberZoom level of the map.
neighborhoodLayerStringID of the neighborhood layer.
opacityNumberOpacity value (0-1).
operationOrderArray|nullOrder of terrain operations.
storeyNumberStorey index.
structureStringStructure ID this terrain belongs to.
terrainGeoCoordinatesStringGeographical coordinates in degrees, minutes, seconds format.
uniqueIdNumberUnique identifier for the terrain.
defaultPositionArray<Number>Default position [x, y, z].
defaultRotationArray<Number>Default rotation quaternion [x, y, z, w].
mapBoundsObjectMap bounding box with corners {_ne: Object, _nw: Object, _se: Object, _sw: Object}.
rotationQuaternionArray<Number>Rotation quaternion [x, y, z, w].
terrainPositionArray<Number>Terrain position [x, y, z].