Google is committed to advancing racial equity for Black communities. See how.

FloatEvaluator

class FloatEvaluator : TypeEvaluator<Float!>
kotlin.Any
   ↳ androidx.core.animation.FloatEvaluator

This evaluator can be used to perform type interpolation between float values.

Summary

Public methods

Float
evaluate(fraction: Float, @NonNull startValue: Float, @NonNull endValue: Float)

This function returns the result of linearly interpolating the start and end values, with fraction representing the proportion between the start and end values.

static FloatEvaluator

Returns an instance of FloatEvaluator that may be used in ValueAnimator#setEvaluator(TypeEvaluator).

Public methods

evaluate

@NonNull fun evaluate(
    fraction: Float,
    @NonNull startValue: Float,
    @NonNull endValue: Float
): Float

This function returns the result of linearly interpolating the start and end values, with fraction representing the proportion between the start and end values. The calculation is a simple parametric calculation: result = x0 + t * (v1 - v0), where x0 is startValue, x1 is endValue, and t is fraction.

Parameters
fraction Float: The fraction from the starting to the ending values
startValue Float: The start value; should be of type float or Float
endValue Float: The end value; should be of type float or Float
Return
Float A linear interpolation between the start and end values, given the fraction parameter.

getInstance

@NonNull static fun getInstance(): FloatEvaluator

Returns an instance of FloatEvaluator that may be used in ValueAnimator#setEvaluator(TypeEvaluator). The same instance may be used in multiple Animators because it holds no state.

Return
FloatEvaluator An instance of FloatEvaluator.