Version:

Levels Gradient Modifier Component

The Levels Gradient Modifier component modifies the high, mid, and low values of an input gradient and sets the minimum and maximum values of the output gradient.

Provider

Gradient Signal Gem

Levels Gradient Modifier properties

Levels Gradient Modifier component properties

PropertyDescriptionValuesDefault
PreviewDisplays the output gradient of this component after all properties are applied.
Pin Preview to ShapeSets an entity with a compatible Shape component to use as the bounds of the preview if Constrain to Shape is Enabled.EntityIdCurrent Entity
Preview PositionSets the world location of the preview.

This field is available only if there is no entity selected in Pin Preview to Shape.
Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
Preview SizeSets the dimensions of the preview.Vector3: 0.0 to InfinityX:1.0, Y:1.0, Z:1.0
Constrain to ShapeIf Enabled, the gradient preview uses the bounds of the entity selected in Pin Preview to Shape.

This field is available only if an entity is selected in Pin Preview to Shape.
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
GradientRefer to Gradient properties below.

Gradient properties

Gradient properties

PropertyDescriptionValuesDefault
Gradient Entity IdSets an entity with an active Gradient component.EntityIdNone
OpacitySets the opacity of the input gradient.Float: 0.0 - 1.01.0
Invert InputInverts the values of the input gradient.BooleanDisabled
Preview (Input)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.0001 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 input 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

LevelsGradientRequestBus

Use the following request functions with the LevelsGradientRequestBus EBus interface to communicate with Levels Gradient Modifier components in your game.

Method NameDescriptionParameterReturnScriptable
GetGradientSamplerReturns the gradient sampler object of the inverted gradient.NoneGradient SamplerYes
GetInputMaxReturns the value of Input Max.NoneMax: FloatYes
GetInputMidReturns the value of Input Mid.NoneMid: FloatYes
GetInputMinReturns the value of Input Min.NoneMin: FloatYes
GetOutputMaxReturns the value of Output Max.NoneMax: FloatYes
GetOutputMinReturns the value of Output Min.NoneMin: FloatYes
SetInputMaxSets the value of Input Max.Max: FloatNoneYes
SetInputMidSets the value of Input Mid.Mid: FloatNoneYes
SetInputMinSets the value of Input Min.Min: FloatNoneYes
SetOutputMaxSets the value of Output Max.Max: FloatNoneYes
SetOutputMinSets the value of Output Min.Min: FloatNoneYes