Skip to content

Most visited

Recently visited

navigation

Interpolator

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

Interpolator.Result timeToValues(float[] values)

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

Protected methods

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class java.lang.Object

Public constructors

Interpolator

Added in API level 1
Interpolator (int valueCount)

Parameters
valueCount int

Interpolator

Added in API level 1
Interpolator (int valueCount, 
                int frameCount)

Parameters
valueCount int
frameCount int

Public methods

getKeyFrameCount

Added in API level 1
int getKeyFrameCount ()

Returns
int

getValueCount

Added in API level 1
int getValueCount ()

Returns
int

reset

Added in API level 1
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). After this call the values for each keyFrame must be assigned using setKeyFrame().

Parameters
valueCount int

reset

Added in API level 1
void reset (int valueCount, 
                int frameCount)

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 int
frameCount int

setKeyFrame

Added in API level 1
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.

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

setKeyFrame

Added in API level 1
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).

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

setRepeatMirror

Added in API level 1
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. The default settings are repeatCount = 1, and mirror = false.

Parameters
repeatCount float
mirror boolean

timeToValues

Added in API level 1
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). In any event, computed values are always returned.

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

timeToValues

Added in API level 1
Interpolator.Result timeToValues (float[] values)

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

Parameters
values float
Returns
Interpolator.Result

Protected methods

finalize

Added in API level 1
void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the JavaTM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Throws
Throwable
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.