public class

Interpolator

extends Object
java.lang.Object
   ↳ android.graphics.Interpolator

Summary

Nested Classes
enum Interpolator.Result  
Public Constructors
Interpolator(int valueCount)
Interpolator(int valueCount, int frameCount)
Public Methods
final int getKeyFrameCount()
final int getValueCount()
void reset(int valueCount)
Reset the Interpolator to have the specified number of values and an implicit keyFrame count of 2 (just a start and end).
void reset(int valueCount, int frameCount)
Reset the Interpolator to have the specified number of values and keyFrames.
void setKeyFrame(int index, int msec, float[] values, float[] blend)
Assign the keyFrame (specified by index) a time value and an array of key values and blend array.
void setKeyFrame(int index, int msec, float[] values)
Assign the keyFrame (specified by index) a time value and an array of key values (with an implicity blend array of [0, 0, 1, 1] giving linear transition to the next set of key values).
void setRepeatMirror(float repeatCount, boolean mirror)
Set a repeat count (which may be fractional) for the interpolator, and whether the interpolator should mirror its repeats.
Interpolator.Result timeToValues(float[] values)
Calls timeToValues(msec, values) with the msec set to now (by calling (int)SystemClock.uptimeMillis().)
Interpolator.Result timeToValues(int msec, float[] values)
Given a millisecond time value (msec), return the interpolated values and return whether the specified time was within the range of key times (NORMAL), was before the first key time (FREEZE_START) or after the last key time (FREEZE_END).
Protected Methods
void finalize()
Called before the object's memory is reclaimed by the VM.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Interpolator (int valueCount)

Since: API Level 1

public Interpolator (int valueCount, int frameCount)

Since: API Level 1

Public Methods

public final int getKeyFrameCount ()

Since: API Level 1

public final int getValueCount ()

Since: API Level 1

public void reset (int valueCount)

Since: API Level 1

Reset the Interpolator to have the specified number of values and an implicit keyFrame count of 2 (just a start and end). After this call the values for each keyFrame must be assigned using setKeyFrame().

public void reset (int valueCount, int frameCount)

Since: API Level 1

Reset the Interpolator to have the specified number of values and keyFrames. After this call the values for each keyFrame must be assigned using setKeyFrame().

public void setKeyFrame (int index, int msec, float[] values, float[] blend)

Since: API Level 1

Assign the keyFrame (specified by index) a time value and an array of key values and blend array.

Parameters
index The index of the key frame to assign
msec The time (in mililiseconds) for this key frame. Based on the SystemClock.uptimeMillis() clock
values Array of values associated with theis key frame
blend (may be null) Optional array of 4 blend values

public void setKeyFrame (int index, int msec, float[] values)

Since: API Level 1

Assign the keyFrame (specified by index) a time value and an array of key values (with an implicity blend array of [0, 0, 1, 1] giving linear transition to the next set of key values).

Parameters
index The index of the key frame to assign
msec The time (in mililiseconds) for this key frame. Based on the SystemClock.uptimeMillis() clock
values Array of values associated with theis key frame

public void setRepeatMirror (float repeatCount, boolean mirror)

Since: API Level 1

Set a repeat count (which may be fractional) for the interpolator, and whether the interpolator should mirror its repeats. The default settings are repeatCount = 1, and mirror = false.

public Interpolator.Result timeToValues (float[] values)

Since: API Level 1

Calls timeToValues(msec, values) with the msec set to now (by calling (int)SystemClock.uptimeMillis().)

public Interpolator.Result timeToValues (int msec, float[] values)

Since: API Level 1

Given a millisecond time value (msec), return the interpolated values and return whether the specified time was within the range of key times (NORMAL), was before the first key time (FREEZE_START) or after the last key time (FREEZE_END). In any event, computed values are always returned.

Parameters
msec The time (in milliseconds) used to sample into the Interpolator. Based on the SystemClock.uptimeMillis() clock
values Where to write the computed values (may be NULL).
Returns
  • how the values were computed (even if values == null)

Protected Methods

protected void finalize ()

Since: API Level 1

Called before the object's memory is reclaimed by the VM. This can only happen once the garbage collector has detected that the object is no longer reachable by any thread of the running application.

The method can be used to free system resources or perform other cleanup before the object is garbage collected. The default implementation of the method is empty, which is also expected by the VM, but subclasses can override finalize() as required. Uncaught exceptions which are thrown during the execution of this method cause it to terminate immediately but are otherwise ignored.

Note that the VM does guarantee that finalize() is called at most once for any object, but it doesn't guarantee when (if at all) finalize() will be called. For example, object B's finalize() can delay the execution of object A's finalize() method and therefore it can delay the reclamation of A's memory. To be safe, use a ReferenceQueue, because it provides more control over the way the VM deals with references during garbage collection.

Throws
Throwable