Vegetation Distribution Filter Component

Add the Vegetation Distribution Filter component to use gradients to control where vegetation or blocker instances are spawned in your vegetation area.

Provider

Vegetation Gem

Dependencies

Add one of the following required components when using the Vegetation Distribution Filter component:

Vegetation Distribution Filter properties

Vegetation Distribution Filter component properties

PropertyDescriptionValuesDefault
PreviewDisplays the output gradient with the Threshold properties applied.
Filter StageDefines if filters are applied before or after modifiers.PreProcess, PostProcess, or DefaultDefault
Threshold MinSets the minimum gradient value for vegetation instance placement.Float 0.0 - 1.00.1
Threshold MaxSets the maximum gradient value for vegetation instance placement.Float 0.0 - 1.01.0
GradientRefer to Gradient properties below.

Gradient properties

Gradient properties

PropertyDescriptionValuesDefault
Gradient Entity IdSets an entity with an active Gradient component.EntityNone
OpacitySets the opacity of the input gradient.Float: 0.0 - 1.01.0
Invert InputInverts the values of the input gradient.BooleanDisabled
Preview (Inbound)Displays the input gradient provided by the entity specfified in Gradient Entity Id.
Enable TransformIf Enabled, the translation, scale, and rotation of the input gradient may be modified.BooleanDisabled
TranslateSets the translation of the input gradient.Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
ScaleSets the scale of the input gradient.Vector3: 0.0 to InfinityX:1.0, Y:1.0, Z:1.0
RotateSets the rotation of the input gradient.Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
Enable LevelsIf Enabled, the input and output values of the gradient may be modified.BooleanDisabled
Input MidSets the median value of the input gradient.Float: 0.0 - 1.01.0
Input MinSets a minimum value for the input gradient.Float: 0.0 - 1.00.0
Input MaxSets a maximum value for the input gradient.Float: 0.0 - 1.01.0
Output MinSets a minimum value for the output gradient.Float: 0.0 - 1.00.0
Output MaxSets a maximum value for the output gradient.Float: 0.0 - 1.01.0

DistributionFilterRequestBus

Use the following request functions with the DistributionFilterRequestBus EBus interface to communicate with Vegetation Distribution Filter components in your game.

Method NameDescriptionParameterReturnScriptable
GetGradientSamplerReturns the gradient sampler object of the distribution filter.NoneGradient SamplerYes
GetThresholdMaxReturns the value of the Threshold Max property.NoneFloatYes
GetThresholdMinReturns the value of the Threshold Min property.NoneFloatYes
SetThresholdMaxSets the value of the Threshold Max property.FloatNoneYes
SetThresholdMinSets the value of the Threshold Min property.FloatNoneYes

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.