TerrainPlanting

Description

sealed class Tinman.Engine.Components.TerrainPlanting

Derived from

PlantingOptions

Plants instanced geometry onto the terrain surface.

Use TerrainMesh.PlantingAdd and TerrainMesh.PlantingRemove to control planting of instanced geometry for a TerrainMesh. In addition to the planting settings defined by PlantingOptions, this class provides terrain-specific settings. The following settings further control the terrain regions where geometry is planted:

  • Curvature
    This controls where to plant, based on the local terrain curvature / roughness.

  • Enabled
    This setting just enables or disabled planting completely.

  • Slope
    This controls where to plant, based on the local terrain slope / steepness.

The other settings fine-control where the configured Model instances are placed:

  • Normal
    Chooses the alignment of the planted geometry (terrain up-vector vs. surface normal vector).

  • Offset
    The vertical offset to use for translating the planted geometry along its normal vector, as defined by Normal.

  • Scale
    This uniformly scales the model geometry, before applying the other settings related to positioning.

See also

TerrainBufferFlags.Planting

Public / Constructors

Terrain​Planting

public constructor TerrainPlanting → (1)

name opt : string = null

Initial value for Name.

Creates a new instance of TerrainPlanting.

Public / Methods

For

public method For → (5)

geometryId in : int32

See PlantingOptions.GeometryId.

model in : IModel

See Model.

offset opt : float32 = 0

See Offset.

scale opt : float32 = 1

See Scale.

normal opt : float32 = 1

See Normal.

returns → TerrainPlanting

this

This is a convenience helper for setting multiple planting options at once.

On

public method On → (3)

material in : int32

See PlantingOptions.Material.

weightFrom opt : int32 = 0

See PlantingOptions.Weight.

weightTo opt : int32 = 255

See PlantingOptions.Weight.

returns → TerrainPlanting

this

This is a convenience helper for setting multiple planting options at once.

Where

public method Where → (4)

distanceFrom in : float32

See PlantingOptions.Distance.

distanceTo in : float32

See PlantingOptions.Distance.

curvature opt : float32 = 1

See Curvature.

slope opt : float32 = 1

See Slope.

returns → TerrainPlanting

this

This is a convenience helper for setting multiple planting options at once.

With

public method With → (3)

density in : float32

See PlantingOptions.Density.

probability opt : float32 = 1

See PlantingOptions.Probability.

scatter opt : float32 = 1

See PlantingOptions.Scatter.

returns → TerrainPlanting

this

This is a convenience helper for setting multiple planting options at once.

Public / Attributes

Curvature

public attribute Curvature → (get,set)

value : float32

= 0 : Plant regardless of terrain curvature.
> 0 : Plant where terrain curvature is less than or equal to value.
< 0 : Plant where terrain curvature is greater than or equal to -value.

Clamps the allowed terrain curvature.

The curvature value is the minimum dot-product between the terrain surface normal vector and the normal vectors at the corners of the corresponding terrain mesh sector. A value of 1 means that the mesh sector is flat and a value of almost 0 means that the mesh sector is bend over almost 90°. Defaults to 0.

See also

IPlanter.InstancePlant

Enabled

public attribute Enabled → (get,set)

value : bool

true if enabled, false if disabled.

Is this terrain planting options object enabled, i.e. geometry instances will be planted onto the terrain?

Defaults to true.

Model

public attribute Model → (get,set)

value : IModel

The 3D model or null.

The 3D model to plant onto the terrain.

Defaults to null.

Name

public attribute Name → (get,set)

value : string

The human-readable name or null if none.

Human-readable name of these terrain planting options.

Defaults to null.

Normal

public attribute Normal → (get,set)

value : float32

0 : The model Y+ axis is aligned with the terrain-space up-vector.
1 : The model Y+ axis is aligned with the terrain-space normal vector.

Blends between the terrain-space up- and normal vectors.

Defaults to 0.

Offset

public attribute Offset → (get,set)

value : float32

The vertical offset.

Vertical offset along instance normal (as defined by Normal).

Defaults to 0.

Scale

public attribute Scale → (get,set)

value : float32

The scale factor.

Scale factor to apply to model-space.

Defaults to 1.

Slope

public attribute Slope → (get,set)

value : float32

= 0 : Plant regardless of terrain slope.
> 0 : Plant where terrain slope is less than or equal to value.
< 0 : Plant where terrain slope is greater than or equal to -value.

Clamps the allowed terrain slope.

The slope value is the dot-product between the terrain up-vector and the terrain surface normal vector, i.e. 1 corresponds to a slope angle of 0° and almost 0 corresponds to almost 90°. Defaults to 0.

See also

IPlanter.InstancePlant