JavaFX: Bringing Rich Experiences To All the Screens Of Your Life

expand all

Profile: desktop, common

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

accessnametypeCan ReadCan InitCan WriteDefault Valuedescription
publicactionfunction():Voidnull

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 will be called if the elapsed time passes the indicated value, even if it never equaled the time value exactly.

null

Profile: common

 
publiccanSkipBooleanfalse

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 will occur for each time pulse, regardless of how many cycles have occured since the last time pulse was processed.

false

Profile: common

 
publictimeDuration0s

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 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 will be called. KeyFrames having time < 0s will be ignored by the Timeline.

0s

See Also:
Timeline#keyValues

Profile: common

 
publicvaluesKeyValue[]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.

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

Parameters
o

the KeyFrame to compare to

Returns
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

Profile: common

 

Inherited Functions




Spec-Zone.ru - all specs in one place