View source for Component:ValueGradientDriver/en

<languages></languages>
{{Infobox Component
|Image=ValueGradientDriver`1Component.png
|Name=Value Gradient Driver`1
}}
The '''ValueGradientDriver''' component changes the value of the field defined in <code>Target</code> based on the items in the <code>Points</code> list, and their <code>Position</code> in relation to the <code>Progress</code> value.

== Fields ==
{{Table ComponentFields
|Progress|Float| Controls which items from the <code>Points</code> list will be used to drive the value of <code>Target</code>
|Target|IField`1|TypeString1=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 <code>Points</code> to the current <code>Progress</code> value.
|Points|SyncList`1|TypeString3=SyncList<Point>|A list of items indicating their <code>Position</code> (in relation to <code>Progress</code>), and a <code>Value</code>
}}

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

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

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

== 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>

== Related Components ==
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Value Gradient Driver`1]]
[[Category:Components:Transform:Drivers{{#translation:}}|Value Gradient Driver`1]]