Terrain Surface Gradient List Component

The Terrain Surface Gradient List component defines mappings between a gradient and a surface type on a terrain layer. When you assign a gradient to a surface, the gradient defines the strength of that surface in the displayed terrain. For example, you can assign a gradient to a rocky surface to make parts of it appear through a grassy region.

Usage

You select a gradient either by dragging an entity containing a gradient component to the GradientEntity field, or by clicking . Once a gradient is assigned, you can select the surface type that this gradient represents, by using the Surface Tag pull-down menu. You can configure the dimensions and priority of the layer using the required Terrain Layer Spawner

Provider

Terrain Gem

Dependencies

Terrain Layer Spawner

Properties

PropertyDescriptionValuesDefault
GradientEntityThe gradient entity to assign to this layer.Gradient EntityNone
Surface TagSets the surface type that this gradient represents.Surface TagNone

TerrainAreaSurfaceRequestBus

Use the following request functions with the TerrainAreaSurfaceRequestBus EBus interface to communicate with other components of your game.

GetSurfaceWeights

Retrieves all of the surfaces that are assigned to this component, along with the gradient’s weight value at the given position.

Parameters

InPosition

Type: Vector3
Position to retrieve information for.

SurfaceWeights [out]

Type: SurfaceTagWeightMap
A list of all the retrieved surfaces and weight values.

Returns

None


Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.