Vegetation Asset Weight Selector Component

The Vegetation Asset Weight Selector component uses the values of a gradient to select assets from a vegetation asset list. The assets can be sorted by weight prior to selection and the input gradient can be modified to affect the count and distribution of vegetation assets.

Provider

Vegetation Gem

Vegetation Asset Weight Selector properties

Vegetation Asset Weight Selector component properties

PropertyDescriptionValuesDefault
Sort By WeightDetermines if asset descriptors are sorted by weight before the gradient is used to select assets.Unsorted, Ascending, or DescendingUnsorted
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 gradient provided by the entity set 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

DescriptorWeightSelectorRequestBus

Use the following request functions with the DescriptorWeightSelectorRequestBus EBus interface to communicate with Vegetation Asset Weight Selector components in your game.

Method NameDescriptionParameterReturnScriptable
GetGradientSamplerReturns the gradient sampler object of a weight selector.NoneGradient SamplerYes
GetSortBehaviorSets the configuration of a Sort By Weight property. Returns 0 for Unsorted, 1 for Ascending, and 2 for Descending.NoneSort Behavior: IntegerYes
SetSortBehaviorSets the configuration of a Sort By Weight property. 0 for Unsorted, 1 for Ascending, and 2 for Descending.Sort Behavior: IntegerNoneYes

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.