GTKX

API Reference / @gtkx/animated / Interpolator

Interface: Interpolator() ​

This interpolates one or more FluidValue objects. The exported interpolate function uses this type.

Call Signature ​

Interpolator<Input, Output>(parents, interpolator): Interpolation<Output>

This interpolates one or more FluidValue objects. The exported interpolate function uses this type.

Type Parameters ​

Input ​

Input extends readonly any[]

Output ​

Output

Parameters ​

parents ​

Input

interpolator ​

(...args) => Output

Returns ​

Interpolation<Output>

Call Signature ​

Interpolator<Input, Output>(parent, interpolator): Interpolation<Output>

This interpolates one or more FluidValue objects. The exported interpolate function uses this type.

Type Parameters ​

Input ​

Input

Output ​

Output

Parameters ​

parent ​

Input | FluidValue<Input, any>

interpolator ​

InterpolatorFn<Input, Output>

Returns ​

Interpolation<Output>

Call Signature ​

Interpolator<Out>(parents, config): Interpolation<Animatable<Out>>

This interpolates one or more FluidValue objects. The exported interpolate function uses this type.

Type Parameters ​

Out ​

Out

Parameters ​

parents ​

OneOrMore<FluidValue<any, any>>

config ​

InterpolatorConfig<Out>

Returns ​

Interpolation<Animatable<Out>>

Call Signature ​

Interpolator<Out>(parents, range, output, extrapolate?): Interpolation<Animatable<Out>>

This interpolates one or more FluidValue objects. The exported interpolate function uses this type.

Type Parameters ​

Out ​

Out

Parameters ​

parents ​

OneOrMore<FluidValue<number, any>> | FluidValue<number[], any>

range ​

readonly number[]

output ​

readonly Constrain<Out, string | number | readonly (string | number)[]>[]

extrapolate? ​

ExtrapolateType

Returns ​

Interpolation<Animatable<Out>>