public class javafx.animation.KeyFrame

Inherits from: com.sun.javafx.runtime.FXBase > javafx.animation.KeyFrame java.lang.Comparable,

Known subclasses:

Jump to Section:
overview
variables
functions

Overview

Defines target values at a specified point in time for a set of variables that are interpolated along a Timeline.

The developer controls the interpolation of a set of variables for the interval between successive key frames by providing a target value and an Interpolator associated with each variable. The variables are interpolated such that they will reach their target value at the specified time. An action function is invoked on each KeyFrame if one is provided.

See Also:
Timeline, Interpolator

Profile: common

Variable Summary

access	name	type	Default Value	description
public	action	function():Void	null	A function that is called when the elapsed time on a cycle passes the specified time of this `KeyFrame`. A function that is called when the elapsed time on a cycle passes the specified time of this `KeyFrame`. The `action` function variable will be called if the elapsed time passes the indicated value, even if it never equaled the time value exactly. null Profile: common
public	canSkip	Boolean	false	Defines whether or not the action() function can be skipped if the master timer gets behind and more than one Timeline cycles are skipped between time pulses. Defines whether or not the action() function can be skipped if the master timer gets behind and more than one Timeline cycles are skipped between time pulses. If `true`, only one call to the action function variable will occur for each time pulse, regardless of how many cycles have occurred since the last time pulse was processed. false Profile: common
public	time	Duration	0s	Defines the reference elapsed time offset within a single cycle of a Timeline at which the associated values will be set and at which the action function variable will be called. Defines the reference elapsed time offset within a single cycle of a Timeline at which the associated values will be set and at which the action function variable will be called. `KeyFrame`s having `time < 0s` will be ignored by the `Timeline`. 0s See Also: Timeline#keyValues Profile: common
public	values	KeyValue[]	null	The list of target variables and the desired values they should interpolate at the specified time of this `KeyFrame`. The list of target variables and the desired values they should interpolate at the specified time of this `KeyFrame`. Commonly, KeyValues use a constant value, for example: `values: x => 10` but can also use a non-constant value, such as: `values: x => someVal + 5` KeyValue.value expressions are evaluated once before a Timeline is played. The results are saved and used for each play of the Timeline. For some Timelines, it is desirable for KeyValues to be re-evaluated and take on a different value for each run (or even during a run). The `Timeline.evaluateKeyValues()` function allows this. null See Also: Timeline#evaluateKeyValues Profile: common

Inherited Variables

Function Summary

public compareTo(o: java.lang.Object) : Integer

A comparison function used to sort KeyFrames by their specified reference time.

o: the KeyFrame to compare to

Integer: an Integer value
> 0 if specified KeyFrame timing is ahead of this
= 0 if they have the same timing
< 0 if specified KeyFrame timing is behind this