public abstract class Animation extends Object
Animationは、JavaFXランタイムで使用されるすべてのアニメーションのコア機能を提供します。
アニメーションは、cycleCountを設定することによってループで実行できます。 ループしている間、アニメーションが往復実行されるようにするには、autoReverseフラグを設定します。
Animationを再生するには、play()またはplayFromStart()を呼び出します。 Animationは、rateで指定する方向および速度で進行し、その期間が経過すると停止します。 期間を無限(cycleCount = INDEFINITE)にしたAnimationは、stop()メソッドを明示的に呼び出すまで繰り返し実行されます。このメソッドを呼び出すと、実行中のAnimationが停止され、再生ヘッドが初期位置にリセットされます。
Animationを一時停止するには、pause()を呼び出します。その後、play()を呼び出すと、一時停止した場所からAnimationが再開されます。
Animationが実行中かどうかに関係なく、再生ヘッドの位置を任意に指定できます。 Animationが実行中の場合は、再生ヘッドは指定の位置に即座にジャンプし、新しい位置から再生が続行されます。 Animationが実行中でない場合は、次回play()を呼び出したときに、指定の位置からAnimationが開始されます。
rateの値を反転させると、再生方向が切り替わります。
Timeline, Transition| 型 | プロパティと説明 |
|---|---|
BooleanProperty |
autoReverse
この
Animationで方向を交互に繰り返し反転させるかどうかを定義します。 |
ReadOnlyDoubleProperty |
currentRate
Animationを再生している現在の方向/速度を示す読取り専用変数。 |
ReadOnlyObjectProperty<Duration> |
currentTime
Animationの再生ヘッド位置を定義します。 |
IntegerProperty |
cycleCount
このアニメーションのサイクル数を定義します。
|
ReadOnlyObjectProperty<Duration> |
cycleDuration
この
Animationの1つのサイクルの期間を示す読取り専用変数: 時間0からAnimationの最後までの再生時間(デフォルトのrateは1.0)。 |
ObjectProperty<Duration> |
delay
アニメーションの開始を遅延します。
|
ObjectProperty<EventHandler<ActionEvent>> |
onFinished
この
Animationの最後に実行されるアクション。 |
DoubleProperty |
rate
Animationを再生する方向/速度を定義します。 |
ReadOnlyObjectProperty<Animation.Status> |
status
Animationのステータス。 |
ReadOnlyObjectProperty<Duration> |
totalDuration
繰返しを含むこの
Animationの合計時間を示す読取り専用変数。 |
| 修飾子と型 | クラスと説明 |
|---|---|
static class |
Animation.Status
statusの候補となる状態。 |
| 修飾子と型 | フィールドと説明 |
|---|---|
static int |
INDEFINITE
stop()メソッドを呼び出すまで無限に繰り返すアニメーションを指定するために使用します。 |
| 修飾子 | コンストラクタと説明 |
|---|---|
protected |
Animation()
Animationのコンストラクタ。 |
protected |
Animation(double targetFramerate)
Animationのコンストラクタ。 |
| 修飾子と型 | メソッドと説明 |
|---|---|
BooleanProperty |
autoReverseProperty()
この
Animationで方向を交互に繰り返し反転させるかどうかを定義します。 |
ReadOnlyDoubleProperty |
currentRateProperty()
Animationを再生している現在の方向/速度を示す読取り専用変数。 |
ReadOnlyObjectProperty<Duration> |
currentTimeProperty()
Animationの再生ヘッド位置を定義します。 |
IntegerProperty |
cycleCountProperty()
このアニメーションのサイクル数を定義します。
|
ReadOnlyObjectProperty<Duration> |
cycleDurationProperty()
この
Animationの1つのサイクルの期間を示す読取り専用変数: 時間0からAnimationの最後までの再生時間(デフォルトのrateは1.0)。 |
ObjectProperty<Duration> |
delayProperty()
アニメーションの開始を遅延します。
|
ObservableMap<String,Duration> |
getCuePoints()
キュー・ポイントを使用して、
Animationの重要な位置をマークできます。 |
double |
getCurrentRate()
プロパティcurrentRateの値を取得します。
|
Duration |
getCurrentTime()
プロパティcurrentTimeの値を取得します。
|
int |
getCycleCount()
プロパティcycleCountの値を取得します。
|
Duration |
getCycleDuration()
プロパティcycleDurationの値を取得します。
|
Duration |
getDelay()
プロパティdelayの値を取得します。
|
EventHandler<ActionEvent> |
getOnFinished()
プロパティonFinishedの値を取得します。
|
double |
getRate()
プロパティrateの値を取得します。
|
Animation.Status |
getStatus()
プロパティstatusの値を取得します。
|
double |
getTargetFramerate()
ターゲット・フレームレートは、この
Animationが実行される最大フレームレート(フレーム/秒)です。 |
Duration |
getTotalDuration()
プロパティtotalDurationの値を取得します。
|
boolean |
isAutoReverse()
プロパティautoReverseの値を取得します。
|
void |
jumpTo(Duration time)
この
Animation内の指定の位置にジャンプします。 |
void |
jumpTo(String cuePoint)
この
Animation内の事前定義済の位置にジャンプします。 |
ObjectProperty<EventHandler<ActionEvent>> |
onFinishedProperty()
この
Animationの最後に実行されるアクション。 |
void |
pause()
アニメーションを一時停止します。
|
void |
play()
現在の位置から
rateで指定する方向にAnimationを再生します。 |
void |
playFrom(Duration time)
この
Animationを特定の位置から再生するコンビニエンス・メソッド。 |
void |
playFrom(String cuePoint)
この
Animationを事前定義済の位置から再生するコンビニエンス・メソッド。 |
void |
playFromStart()
初期位置から順方向に
Animationを再生します。 |
DoubleProperty |
rateProperty()
Animationを再生する方向/速度を定義します。 |
void |
setAutoReverse(boolean value)
プロパティautoReverseの値を設定します。
|
void |
setCycleCount(int value)
プロパティcycleCountの値を設定します。
|
protected void |
setCycleDuration(Duration value)
プロパティcycleDurationの値を設定します。
|
void |
setDelay(Duration value)
プロパティdelayの値を設定します。
|
void |
setOnFinished(EventHandler<ActionEvent> value)
プロパティonFinishedの値を設定します。
|
void |
setRate(double value)
プロパティrateの値を設定します。
|
protected void |
setStatus(Animation.Status value)
プロパティstatusの値を設定します。
|
ReadOnlyObjectProperty<Animation.Status> |
statusProperty()
Animationのステータス。 |
void |
stop()
アニメーションを停止し、再生ヘッドを初期位置にリセットします。
|
ReadOnlyObjectProperty<Duration> |
totalDurationProperty()
繰返しを含むこの
Animationの合計時間を示す読取り専用変数。 |
public final DoubleProperty rateProperty
Animationを再生する方向/速度を定義します。
rateの絶対値はAnimationの再生速度を示し、rateの記号は方向を示します。 rateの値が正の場合は順方向に再生し、値が負の場合は逆方向に再生し、0.0の場合はAnimationの実行を停止します。
たとえば、速度1.0は標準再生、2.0は2倍速再生、-1.0は逆方向再生になります。
実行中のAnimationの速度を反転すると、Animationの方向が逆になり、すでに経過したAnimation部分が逆方向に再生されます。
getRate(), setRate(double)public final ReadOnlyDoubleProperty currentRateProperty
Animationを再生している現在の方向/速度を示す読取り専用変数。
currentRateはrateと必ずしも等しくなりません。アニメーションが一時停止または停止されている場合、currentRateは0.0に設定されます。また、autoReverseがtrueの場合、currentRateは反転サイクル中は逆方向を指します。
getCurrentRate()public final ReadOnlyObjectProperty<Duration> cycleDurationProperty
Animationの1つのサイクルの期間を示す読取り専用変数: 時間0からAnimationの最後までの再生時間(デフォルトのrateは1.0)。getCycleDuration(), setCycleDuration(Duration)public final ReadOnlyObjectProperty<Duration> totalDurationProperty
Animationの合計時間を示す読取り専用変数。 AnimationのcycleCountをAnimation.INDEFINITEにした場合、totalDurationはDuration.INDEFINITEになります。
これはcycleDuration * cycleCountに設定されます。
getTotalDuration()public final ReadOnlyObjectProperty<Duration> currentTimeProperty
Animationの再生ヘッド位置を定義します。getCurrentTime()public final ObjectProperty<Duration> delayProperty
getDelay(), setDelay(Duration)public final IntegerProperty cycleCountProperty
cycleCountをINDEFINITEに設定できますが、それ以外の場合は0より大きくする必要があります。
実行中のAnimationのcycleCountは変更できません。 実行中のAnimationのcycleCountの値が変更された場合、新しい値を反映するには、アニメーションを停止し、再度開始する必要があります。
getCycleCount(), setCycleCount(int)public final BooleanProperty autoReverseProperty
Animationで方向を交互に繰り返し反転させるかどうかを定義します。 trueの場合、Animationは1回目のサイクルでは順方向に進行し、2回目のサイクルでは逆方向に進行します(それ以降も同様です)。 それ以外の場合、ループの各サイクルで、アニメーションが先頭から順方向に進行します。 実行中のAnimationのautoReverseフラグは変更できません。 実行中のAnimationのautoReverseの値が変更された場合、新しい値を反映するには、アニメーションを停止し、再度開始する必要があります。 isAutoReverse(), setAutoReverse(boolean)public final ReadOnlyObjectProperty<Animation.Status> statusProperty
Animationのステータス。 Animationの状態は、Animation.Status.STOPPED、Animation.Status.PAUSEDまたはAnimation.Status.RUNNINGのいずれかになります。 getStatus(), setStatus(Status)public final ObjectProperty<EventHandler<ActionEvent>> onFinishedProperty
Animationの最後に実行されるアクション。getOnFinished(), setOnFinished(EventHandler)public static final int INDEFINITE
stop()メソッドを呼び出すまで無限に繰り返すアニメーションを指定するために使用します。protected Animation(double targetFramerate)
Animationのコンストラクタ。 このコンストラクタではターゲット・フレームレートを定義できます。 targetFramerate - このAnimationのカスタム・ターゲット・フレームレートgetTargetFramerate()protected Animation()
Animationのコンストラクタ。public final void setRate(double value)
Animationを再生する方向/速度を定義します。
rateの絶対値はAnimationの再生速度を示し、rateの記号は方向を示します。 rateの値が正の場合は順方向に再生し、値が負の場合は逆方向に再生し、0.0の場合はAnimationの実行を停止します。
たとえば、速度1.0は標準再生、2.0は2倍速再生、-1.0は逆方向再生になります。
実行中のAnimationの速度を反転すると、Animationの方向が逆になり、すでに経過したAnimation部分が逆方向に再生されます。
public final double getRate()
Animationを再生する方向/速度を定義します。
rateの絶対値はAnimationの再生速度を示し、rateの記号は方向を示します。 rateの値が正の場合は順方向に再生し、値が負の場合は逆方向に再生し、0.0の場合はAnimationの実行を停止します。
たとえば、速度1.0は標準再生、2.0は2倍速再生、-1.0は逆方向再生になります。
実行中のAnimationの速度を反転すると、Animationの方向が逆になり、すでに経過したAnimation部分が逆方向に再生されます。
public final DoubleProperty rateProperty()
Animationを再生する方向/速度を定義します。
rateの絶対値はAnimationの再生速度を示し、rateの記号は方向を示します。 rateの値が正の場合は順方向に再生し、値が負の場合は逆方向に再生し、0.0の場合はAnimationの実行を停止します。
たとえば、速度1.0は標準再生、2.0は2倍速再生、-1.0は逆方向再生になります。
実行中のAnimationの速度を反転すると、Animationの方向が逆になり、すでに経過したAnimation部分が逆方向に再生されます。
getRate(), setRate(double)public final double getCurrentRate()
Animationを再生している現在の方向/速度を示す読取り専用変数。
currentRateはrateと必ずしも等しくなりません。アニメーションが一時停止または停止されている場合、currentRateは0.0に設定されます。また、autoReverseがtrueの場合、currentRateは反転サイクル中は逆方向を指します。
public final ReadOnlyDoubleProperty currentRateProperty()
Animationを再生している現在の方向/速度を示す読取り専用変数。
currentRateはrateと必ずしも等しくなりません。アニメーションが一時停止または停止されている場合、currentRateは0.0に設定されます。また、autoReverseがtrueの場合、currentRateは反転サイクル中は逆方向を指します。
getCurrentRate()protected final void setCycleDuration(Duration value)
Animationの1つのサイクルの期間を示す読取り専用変数: 時間0からAnimationの最後までの再生時間(デフォルトのrateは1.0)。public final Duration getCycleDuration()
Animationの1つのサイクルの期間を示す読取り専用変数: 時間0からAnimationの最後までの再生時間(デフォルトのrateは1.0)。public final ReadOnlyObjectProperty<Duration> cycleDurationProperty()
Animationの1つのサイクルの期間を示す読取り専用変数: 時間0からAnimationの最後までの再生時間(デフォルトのrateは1.0)。getCycleDuration(), setCycleDuration(Duration)public final Duration getTotalDuration()
Animationの合計時間を示す読取り専用変数。 AnimationのcycleCountをAnimation.INDEFINITEにした場合、totalDurationはDuration.INDEFINITEになります。
これはcycleDuration * cycleCountに設定されます。
public final ReadOnlyObjectProperty<Duration> totalDurationProperty()
Animationの合計時間を示す読取り専用変数。 AnimationのcycleCountをAnimation.INDEFINITEにした場合、totalDurationはDuration.INDEFINITEになります。
これはcycleDuration * cycleCountに設定されます。
getTotalDuration()public final Duration getCurrentTime()
Animationの再生ヘッド位置を定義します。public final ReadOnlyObjectProperty<Duration> currentTimeProperty()
Animationの再生ヘッド位置を定義します。getCurrentTime()public final void setDelay(Duration value)
IllegalArgumentExceptionが発生します。 public final Duration getDelay()
IllegalArgumentExceptionが発生します。 public final ObjectProperty<Duration> delayProperty()
getDelay(), setDelay(Duration)public final void setCycleCount(int value)
cycleCountをINDEFINITEに設定できますが、それ以外の場合は0より大きくする必要があります。
実行中のAnimationのcycleCountは変更できません。 実行中のAnimationのcycleCountの値が変更された場合、新しい値を反映するには、アニメーションを停止し、再度開始する必要があります。
public final int getCycleCount()
cycleCountをINDEFINITEに設定できますが、それ以外の場合は0より大きくする必要があります。
実行中のAnimationのcycleCountは変更できません。 実行中のAnimationのcycleCountの値が変更された場合、新しい値を反映するには、アニメーションを停止し、再度開始する必要があります。
public final IntegerProperty cycleCountProperty()
cycleCountをINDEFINITEに設定できますが、それ以外の場合は0より大きくする必要があります。
実行中のAnimationのcycleCountは変更できません。 実行中のAnimationのcycleCountの値が変更された場合、新しい値を反映するには、アニメーションを停止し、再度開始する必要があります。
getCycleCount(), setCycleCount(int)public final void setAutoReverse(boolean value)
Animationで方向を交互に繰り返し反転させるかどうかを定義します。 trueの場合、Animationは1回目のサイクルでは順方向に進行し、2回目のサイクルでは逆方向に進行します(それ以降も同様です)。 それ以外の場合、ループの各サイクルで、アニメーションが先頭から順方向に進行します。 実行中のAnimationのautoReverseフラグは変更できません。 実行中のAnimationのautoReverseの値が変更された場合、新しい値を反映するには、アニメーションを停止し、再度開始する必要があります。 public final boolean isAutoReverse()
Animationで方向を交互に繰り返し反転させるかどうかを定義します。 trueの場合、Animationは1回目のサイクルでは順方向に進行し、2回目のサイクルでは逆方向に進行します(それ以降も同様です)。 それ以外の場合、ループの各サイクルで、アニメーションが先頭から順方向に進行します。 実行中のAnimationのautoReverseフラグは変更できません。 実行中のAnimationのautoReverseの値が変更された場合、新しい値を反映するには、アニメーションを停止し、再度開始する必要があります。 public final BooleanProperty autoReverseProperty()
Animationで方向を交互に繰り返し反転させるかどうかを定義します。 trueの場合、Animationは1回目のサイクルでは順方向に進行し、2回目のサイクルでは逆方向に進行します(それ以降も同様です)。 それ以外の場合、ループの各サイクルで、アニメーションが先頭から順方向に進行します。 実行中のAnimationのautoReverseフラグは変更できません。 実行中のAnimationのautoReverseの値が変更された場合、新しい値を反映するには、アニメーションを停止し、再度開始する必要があります。 isAutoReverse(), setAutoReverse(boolean)protected final void setStatus(Animation.Status value)
Animationのステータス。 Animationの状態は、Animation.Status.STOPPED、Animation.Status.PAUSEDまたはAnimation.Status.RUNNINGのいずれかになります。 public final Animation.Status getStatus()
Animationのステータス。 Animationの状態は、Animation.Status.STOPPED、Animation.Status.PAUSEDまたはAnimation.Status.RUNNINGのいずれかになります。 public final ReadOnlyObjectProperty<Animation.Status> statusProperty()
Animationのステータス。 Animationの状態は、Animation.Status.STOPPED、Animation.Status.PAUSEDまたはAnimation.Status.RUNNINGのいずれかになります。 getStatus(), setStatus(Status)public final double getTargetFramerate()
Animationが実行される最大フレームレート(フレーム/秒)です。 特に複雑なAnimationsによってシステム・リソースが過剰消費されないようにする場合などに使用します。 デフォルトでは、Animationのフレームレートは明示的には制限されていません。つまり、Animationは、基礎となるプラットフォームに最も適したフレームレートで実行されます。 public final void setOnFinished(EventHandler<ActionEvent> value)
Animationの最後に実行されるアクション。public final EventHandler<ActionEvent> getOnFinished()
Animationの最後に実行されるアクション。public final ObjectProperty<EventHandler<ActionEvent>> onFinishedProperty()
Animationの最後に実行されるアクション。getOnFinished(), setOnFinished(EventHandler)public final ObservableMap<String,Duration> getCuePoints()
Animationの重要な位置をマークできます。 定義済のキュー・ポイントをjumpTo()およびplayFrom()の引数として使用すると、関連付けられた位置まですばやく移動できます。
すべてのAnimationに"start"と"end"の2つのキュー・ポイントが事前に定義されています(それぞれAnimationの先頭と末尾を表します)。 事前定義済のキュー・ポイントはマップには表示されず、オーバーライドを試みても効果はありません。
Animationのキュー・ポイントを定義するもう1つのオプションは、KeyFrameのKeyFrame.nameプロパティを設定することです。
ObservableMappublic void jumpTo(Duration time)
Animation内の指定の位置にジャンプします。 指定した時間がDuration.ZEROよりも前である場合は、アニメーションの先頭までジャンプします。 指定した時間がこのAnimationの期間よりも後である場合は、末尾までジャンプします。 time - 新しい位置NullPointerException - timeがnullの場合IllegalArgumentException - timeがDuration.UNKNOWNの場合IllegalStateException - 別のアニメーションに埋め込まれている場合(SequentialTransitionやParallelTransitionなど)public void jumpTo(String cuePoint)
Animation内の事前定義済の位置にジャンプします。 キュー・ポイントのエントリを探し、見つかった場合は関連付けられた位置までジャンプします。
キュー・ポイントがこのAnimationの末尾よりも後である場合は、jumpToを呼び出すと、末尾までジャンプします。 キュー・ポイントのDurationが負である場合は、先頭までジャンプします。 キュー・ポイントの値がDuration.UNKNOWNである場合、jumpToを呼び出しても効果はありません。
このAnimationの先頭と末尾を表す2つのキュー・ポイント"start"および"end"が事前に定義されています。
cuePoint - キュー・ポイントの名前NullPointerException - cuePointがnullの場合IllegalStateException - 別のアニメーションに埋め込まれている場合(SequentialTransitionやParallelTransitionなど)getCuePoints()public void playFrom(String cuePoint)
Animationを事前定義済の位置から再生するコンビニエンス・メソッド。 位置はキュー・ポイントに事前に定義されている必要があります。 このメソッドを呼び出すことは、次と同等です。
animation.jumpTo(cuePoint);
animation.play();
playFromStart()とは異なり、このメソッドを呼び出してもこのAnimationの再生方向は変わりません。cuePoint - キュー・ポイントの名前NullPointerException - cuePointがnullの場合IllegalStateException - 別のアニメーションに埋め込まれている場合(SequentialTransitionやParallelTransitionなど)getCuePoints()public void playFrom(Duration time)
Animationを特定の位置から再生するコンビニエンス・メソッド。 このメソッドを呼び出すことは、次と同等です。
animation.jumpTo(time);
animation.play();
playFromStart()とは異なり、このメソッドを呼び出してもこのAnimationの再生方向は変わりません。time - 再生を開始する位置NullPointerException - timeがnullの場合IllegalArgumentException - timeがDuration.UNKNOWNの場合IllegalStateException - 別のアニメーションに埋め込まれている場合(SequentialTransitionやParallelTransitionなど)public void play()
rateで指定する方向にAnimationを再生します。 Animationが実行中の場合、効果はありません。
rate > 0 (順方向再生)の場合にAnimationがすでに末尾位置にあると、1回目のサイクルは再生されず、すでに終了したものとみなされます。 逆方向再生(rate < 0)サイクルにおいてAnimationがすでに先頭位置にある場合にも、このことが該当します。 ただし、cycleCount > 1のAnimationの場合、後続のサイクルは通常どおり再生されます。
Animationが末尾に到達すると、そのAnimationは停止され、再生ヘッドは末尾に残ります。
Animationを末尾から逆方向に再生するには:
animation.setRate(negative rate);
animation.jumpTo(overall duration of animation);
animation.play();
ノート:
play()の呼出しは非同期であり、Animationは即座に開始されるとはかぎりません。 IllegalStateException - 別のアニメーションに埋め込まれている場合(SequentialTransitionやParallelTransitionなど)public void playFromStart()
Animationを再生します。
これは次と同等です。
animation.stop();
animation.setRate = setRate(Math.abs(animation.getRate()));
animation.jumpTo(Duration.ZERO);
animation.play();
ノート:
playFromStart()の呼出しは非同期であり、Animationは即座に開始されるとはかぎりません。 IllegalStateException - 別のアニメーションに埋め込まれている場合(SequentialTransitionやParallelTransitionなど)public void stop()
ノート:
stop()の呼出しは非同期であり、Animationは即座に停止されるとはかぎりません。 IllegalStateException - 別のアニメーションに埋め込まれている場合(SequentialTransitionやParallelTransitionなど)public void pause()
ノート:
pause()の呼出しは非同期であり、Animationは即座に一時停止されるとはかぎりません。 IllegalStateException - 別のアニメーションに埋め込まれている場合(SequentialTransitionやParallelTransitionなど)Copyright (c) 2008, 2015, Oracle and/or its affiliates. All rights reserved.