RectEvaluator

class RectEvaluator : TypeEvaluator


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.

RectEvaluator(reuseRect: Rect)

Constructs a RectEvaluator that modifies and returns reuseRect in evaluate calls.

Public functions

Rect
evaluate(fraction: Float, startValue: Rect, 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

RectEvaluator

RectEvaluator()

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

RectEvaluator

RectEvaluator(reuseRect: Rect)

Constructs a RectEvaluator that modifies and returns reuseRect in evaluate calls. The value returned from evaluate 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 functions

evaluate

fun evaluate(fraction: Float, startValue: Rect, 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 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

Returns
Rect

A linear interpolation between the start and end values, given the fraction parameter.