Android APIs
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()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Interpolator (int valueCount)

Added in API level 1

Parameters
valueCount

public Interpolator (int valueCount, int frameCount)

Added in API level 1

Parameters
valueCount
frameCount

Public Methods

public final int getKeyFrameCount ()

Added in API level 1

Returns
int

public final int getValueCount ()

Added in API level 1

Returns
int

public void reset (int valueCount)

Added in 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().

Parameters
valueCount

public void reset (int valueCount, int frameCount)

Added in 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().

Parameters
valueCount
frameCount

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

Added in 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)

Added in 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)

Added in 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.

Parameters
repeatCount
mirror

public Interpolator.Result timeToValues (float[] values)

Added in API level 1

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

Parameters
values
Returns
Interpolator.Result

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

Added in 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
Interpolator.Result how the values were computed (even if values == null)

Protected Methods

protected void finalize ()

Added in API level 1

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable