Vegetation Rotation Modifier Component

Add variation to the vegetation instances in your level with the Vegetation Rotation Modifier component. Use gradients to control how vegetation or blocker instances are individually rotated on the X, Y, or Z-axis. By default, this component is configured to rotate a vegetation instance up to 180 degrees on the Z-axis, in either direction.

Provider

Vegetation Gem

Dependencies

Add one of the following required components when using the Vegetation Rotation Modifier component:

Vegetation Rotation Modifier properties

Vegetation Rotation Modifier component properties

PropertyDescriptionValuesDefault
Allow Per-Item OverridesIf Enabled, vegetation descriptor properties that are enabled can override this component’s properties.BooleanDisabled
Rotation X - Range MinSets the minimum modified rotation of the vegetation instance on the X-axis.Float: -Infinity to Infinity0.0
Rotation X - Range MaxSets the maximum modified rotation of the vegetation instance on the X-axis.Float: -Infinity to Infinity0.0
Rotation X - GradientRefer to Gradient properties below.
Rotation Y - Range MinSets the minimum modified rotation of the vegetation instance on the Y-axis.Float: -Infinity to Infinity0.0
Rotation Y - Range MaxSets the maximum modified rotation of the vegetation instance on the Y-axis.Float: -Infinity to Infinity0.0
Rotation Y - GradientRefer to Gradient properties below.
Rotation Z - Range MinSets the minimum modified rotation of the vegetation instance on the Z-axis.Float: -Infinity to Infinity-180.0
Rotation Z - Range MaxSets the maximum modified rotation of the vegetation instance on the Z-axis.Float: -Infinity to Infinity180.0
Rotation Z - 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

RotationModifierRequestBus

Use the following request functions with the RotationModifierRequestBus EBus interface to communicate with Vegetation Rotation Modifier components in your game.

Method NameDescriptionParameterReturnScriptable
GetAllowOverridesReturns the configuration of the Allow Per-Item Overrides property.NoneBooleanYes
GetGradientSamplerXReturns the gradient sampler object of the Rotation X group properties.NoneGradient SamplerYes
GetGradientSamplerYReturns the gradient sampler object of the Rotation Y group properties.NoneGradient SamplerYes
GetGradientSamplerZReturns the gradient sampler object of the Rotation Z group properties.NoneGradient SamplerYes
GetRangeMaxReturns a Vector3 of Range Max properties.NoneVector3: (Rotation X - Range Max, Rotation Y - Range Max, Rotation Z - Range Max)Yes
GetRangeMinReturns a Vector3 of Range Min properties.NoneVector3: (Rotation X - Range Min, Rotation Y - Range Min, Rotation Z - Range Min)Yes
SetAllowOverridesSets the configuration of the Allow Per-Item Overrides property.BooleanNoneYes
SetRangeMaxSets the X, Y, and Z Range Max properties.Vector3: (Rotation X - Range Max, Rotation Y - Range Max, Rotation Z - Range Max)NoneYes
SetRangeMinSets the X, Y, and Z Range Min properties.Vector3: (Rotation X - Range Min, Rotation Y - Range Min, Rotation Z - Range Min)NoneYes

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.