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

RectEvaluator

open class RectEvaluator : TypeEvaluator<Rect!>
kotlin.Any
   ↳ androidx.core.animation.RectEvaluator

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

Summary

Public constructors

Construct a RectEvaluator that returns a new Rect on every evaluate call.

<init>(@NonNull reuseRect: Rect)

Constructs a RectEvaluator that modifies and returns reuseRect in evaluate(float, android.graphics.Rect, android.graphics.Rect) calls.

Public methods
open Rect
evaluate(fraction: Float, @NonNull startValue: Rect, @NonNull endValue: Rect)

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

Public constructors

<init>

RectEvaluator()

Construct a RectEvaluator that returns a new Rect on every evaluate call. To avoid creating an object for each evaluate call, RectEvaluator#RectEvaluator(android.graphics.Rect) should be used whenever possible.

<init>

RectEvaluator(@NonNull reuseRect: Rect)

Constructs a RectEvaluator that modifies and returns reuseRect in evaluate(float, android.graphics.Rect, android.graphics.Rect) calls. The value returned from evaluate(float, android.graphics.Rect, android.graphics.Rect) should not be cached because it will change over time as the object is reused on each call.

Parameters
reuseRect Rect: A Rect to be modified and returned by evaluate.

Public methods

evaluate

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

This function returns the result of linearly interpolating the start and end Rect values, with fraction representing the proportion between the start and end values. The calculation is a simple parametric calculation on each of the separate components in the Rect objects (left, top, right, and bottom).

If RectEvaluator(android.graphics.Rect) was used to construct this RectEvaluator, the object returned will be the reuseRect passed into the constructor.

Parameters
fraction Float: The fraction from the starting to the ending values
startValue Rect: The start Rect
endValue Rect: The end Rect
Return
Rect A linear interpolation between the start and end values, given the fraction parameter.