This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

Smooth-Step Gradient Modifier Component

The Smooth-Step Gradient Modifier component generates a gradient with falloff, smoothing the transition between high and low gradient values.

Provider

Gradient Signal Gem

Smooth-Step Gradient Modifier properties

Smooth-Step 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
Falloff MidpointSets the midpoint of the falloff gradient.Float: 0.0 - 1.00.5
Falloff RangeSets the maximum range of the falloff gradient.Float: 0.0 - 1.00.5
Falloff SoftnessSets the softness of the falloff gradient.Float: 0.0 - 1.00.25
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

SmoothStepRequestBus

Use the following request functions with the SmoothStepRequestBus EBus interface to communicate with Smooth-Step Gradient Modifier components in your game.

Method NameDescriptionParameterReturnScriptable
GetFallOffMidpointReturns the value of Falloff Midpoint.NoneMidpoint: FloatYes
GetFallOffRangeReturns the value of Falloff Range.NoneMax Range: FloatYes
GetFallOffStrengthReturns the value of Falloff Softness.NoneStrength: FloatYes
SetFallOffMidpointSets the value of Falloff Midpoint.Midpoint: FloatNoneYes
SetFallOffRangeSets the value of Falloff Range.Max Range: FloatNoneYes
SetFallOffStrengthSets the value of Falloff Softness.Strength: FloatNoneYes