Component:ValueGradientDriver: Difference between revisions

Revision as of 18:46, 17 February 2024

Component image

**Value Gradient Driver`1** component as seen in the Scene Inspector

The ValueGradientDriver component changes the value of the field defined in Target based on the items in the Points list, and their Position in relation to the Progress value.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled.
`Progress`	Float	Controls which items from the `Points` list will be used to drive the value of `Target`
`Target`	IField<float>	The field that this component will drive the value of
`Interpolate`	Bool	Controls whether or not this component will interpolate (or blend) between the nearest two `Points` to the current `Progress` value.
`Points`	SyncList<Point>	A list of items indicating their `Position` (in relation to `Progress`), and a `Value`

Usage

Each point in the Points list has a Position field and Value field. The Position field is used for comparison with the component's Progress field, while the Value field is the value used for driving the field in Target.

When Interpolate is checked, the value stored in Target is linearly interpolated between the Values of the two points surrounding the current Progress. When unchecked, the output value is simply set to the Value of the closest point before the current Progress. The only exception to this is when no point exists before the current Progress, in which case the first point after the current Progress is used.

If two points have the same Position, then the point of greatest index takes priority if the value is not interpolated or if the positions are exactly equal to the current Progress. During interpolation, however, the point of least index takes priority.

Examples

Load video
Local File
Local File might collect personal data.

General usage of the component, showing interpolation and non-interpolation between five float values.
An unorthodox yet valid usage of the component, as way to find the index of the maximum value in a list of floats (as the Position values) without the need for ProtoFlux. Progress may be set to 0 to find the index of the minimum value as well.

Related Components

@@ Line 30: / Line 30: @@
 == Examples ==
 <gallery widths=560px heights=480px>
+File:component_example_ValueGradientDriver.webm|alt=A ValueGradientDriver is set up with five float values. Index 0 has position 0.00 and value 0, index 1 has position 0.77 and value 2, index 2 has position 0.25 and value 4, index 3 has position 0.67 and value 6, and index 4 has position 1.00 and value 8. As progress moves from 0 to 1, the target field is linearly interpolated between the values of indices 0, 2, 3, 1, then 4. Once interpolation is unchecked, the target field is merely set to the previous index value.|General usage of the component, showing interpolation and non-interpolation between five float values.
 File:Component_example_ValueGradientDriver_IndexOfMax.webp|alt=A ValueGradientDriver is set up with five int values. The progress is fixed at 1 and each point's value is set to its index. Interpolation is disabled. The index of the point with the greatest position is output.|An unorthodox yet valid usage of the component, as way to find the index of the maximum value in a list of floats (as the <code>Position</code> values) without the need for ProtoFlux. <code>Progress</code> may be set to 0 to find the index of the minimum value as well.
 </gallery>