| パッケージ | mx.effects |
| クラス | public class Tween |
| 継承 | Tween  EventDispatcher Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
 | Flex 4.0 以降では、このクラスの代わりとして spark.effects.animation.Animation クラスを使用することをお勧めします。 Tween は、Flex 3 のエフェクトの基本アニメーションクラスです。Flex 4 で導入された Spark エフェクトでは、同様の機能を提供する spark.effects.animation.Animation クラスが使用されます。 |
Tween クラスは、トゥイーン、つまり一定時間にターゲットオブジェクト上で実行されるプロパティアニメーションを定義します。 Move エフェクトによって実行される位置の変更、Resize や Zoom エフェクトによって実行されるサイズの変更、または Fade や Dissolve エフェクトによって実行される可視性の変更がアニメーションである場合もあれば、その他のタイプのアニメーションである場合もあります。
トゥイーンエフェクトを定義する場合、通常、EffectInstance.play() メソッドのオーバーライドで Tween クラスのインスタンスを作成します。 Tween インスタンスでは、アニメーションを定義するための startValue、endValue および duration プロパティとオプションのイージング関数を使用できます。
Tween オブジェクトは、エフェクトインスタンスで、エフェクトの持続時間の間、mx.effects.effectClasses.TweenEffectInstance.onTweenUpdate() コールバック関数を一定の間隔で呼び出し、onTweenUpdate() メソッドに startValue と endValue の間の補間値を渡します。 通常、コールバック関数はターゲットオブジェクトのプロパティをいくつか更新することで、エフェクトの持続時間の間、そのオブジェクトをアニメーション化します。
エフェクトの再生が終了すると、Tween オブジェクトは mx.effects.effectClasses.TweenEffectInstance.onTweenEnd() コールバック関数を呼び出します（定義されている場合）。
関連する API エレメント
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| duration : Number = 3000
アニメーションの継続時間を表します（ミリ秒単位）。 | Tween | ||
| easingFunction : Function [書き込み専用]
アニメーションのイージング関数を設定します。 | Tween | ||
| listener : Object
アニメーションの間隔ごとに通知されるオブジェクトを表します。 | Tween | ||
| メソッド | 定義元 | ||
|---|---|---|---|
Tween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1, updateFunction:Function = null, endFunction:Function = null)
コンストラクターです。 | Tween | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | |
|
イベントをイベントフローに送出します。 | EventDispatcher | |
トゥイーンを中断し、直ちにトゥイーンの終わりにジャンプし、onTweenEnd() コールバック関数を呼び出します。 | Tween | ||
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | |
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
resume() メソッドを呼び出すまで、エフェクトを一時停止します。 | Tween | ||
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | |
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。 | Tween | ||
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。 | Tween | ||
トゥイーンエフェクトを指定の位置に移動します。 | Tween | ||
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
デフォルトでは、Tween クラスはエフェクトインスタンスでエフェクトの持続時間の間、mx.effects.effectClasses.TweenEffectInstance.onTweenUpdate() コールバック関数を一定の間隔で呼び出し、さらにエフェクトの持続時間の終了時に、オプションの mx.effects.effectClasses.TweenEffectInstance.onTweenEnd() コールバック関数を呼び出します。 | Tween | ||
イベントを送出したり、Tween の endFunction や onTweenEnd() を呼び出したりせずに、トゥイーンを停止します。 | Tween | ||
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
duration | プロパティ |
public var duration:Number = 3000| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
アニメーションの継続時間を表します（ミリ秒単位）。
easingFunction | プロパティ |
easingFunction:Function [書き込み専用] | 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
アニメーションのイージング関数を設定します。 イージング関数は startValue 値と endValue 値の間の補間に使用されます。 一般のイージング関数は線形補間を実行しますが、より高度なイージング関数では加速と減速の効果を生成して、アニメーションがより自然になるようにします。
イージング関数を指定しない場合は、Math.sin() メソッドに基づくイージング関数が使用されます。
イージング関数は、Robert Penner 氏が普及に尽力した関数シグネチャに従っています。 この関数では、4 つの引数を使用できます。 1 番目の引数は、アニメーションの開始時刻を 0 とした "現在の時刻" です。 2 番目の引数は、アニメーション開始時の初期値（数値）です。 3 番目の引数は、終了値から初期値を引いた値です。 4 番目の引数は、アニメーションの再生時間です。 戻り値は、現在の時刻に対する補間値になります。通常は、初期値と終了値の間の値になります。
Flex は、mx.effects.easing パッケージにイージング関数を一式含んでいます。
実装
public function set easingFunction(value:Function):voidlistener | プロパティ |
public var listener:Object| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
アニメーションの間隔ごとに通知されるオブジェクトを表します。
Tween | () | コンストラクター |
public function Tween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1, updateFunction:Function = null, endFunction:Function = null)| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
コンストラクターです。
コンストラクターが呼び出されると、アニメーションの再生が自動的に開始されます。
パラメーターlistener:Object — アニメーションの間隔ごとに通知されるオブジェクトを表します。 通常は、this キーワードを値として渡します。 listener で onTweenUpdate() メソッドを定義する必要があり、場合によっては onTweenEnd() メソッドも定義する必要があります。 前者のメソッドはアニメーションの間隔ごとに呼び出され、後者はアニメーションが完了した後にのみ呼び出されます。
| |
startValue:Object — アニメーションの初期値を表します（1 つまたは複数）。 数値、または数値の配列のいずれかになります。 数値が渡された場合、Tween は、その数値と endValue パラメーターで渡された数値との間で補間を実行します。 数値の配列が渡された場合は、配列内の各数値が補間されます。
| |
endValue:Object — アニメーションの終了値を表します（1 つまたは複数）。 この引数の型は startValue パラメーターの型と同じである必要があります。
| |
duration:Number (default = -1) | |
minFps:Number (default = -1)onTweenUpdate() メソッドを呼び出す必要がある 1 秒ごとの最小回数を表します。 トゥイーンコードは、できるだけ頻繁に onTweenUpdate() メソッドを呼び出そうとします（1 秒あたり最大 100 回）。 ただし、頻度が minFps よりも少なくなった場合は、アニメーションの再生時間が自動的に増やされます。 その結果、CPU サイクルが得られずに一時的にフリーズしたアニメーションは、フリーズした位置から再生が再開されます。フリーズした位置よりも後の位置から突然再開することはありません。
| |
updateFunction:Function (default = null)listener.OnTweenUpdate() の代わりに使用される代替更新コールバック関数を指定します。
| |
endFunction:Function (default = null)listener.OnTweenEnd() の代わりに使用される代替更新コールバック関数を指定します。
|
endTween | () | メソッド |
public function endTween():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
トゥイーンを中断し、直ちにトゥイーンの終わりにジャンプし、onTweenEnd() コールバック関数を呼び出します。
pause | () | メソッド |
public function pause():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
resume | () | メソッド |
public function resume():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
pause() メソッドを呼び出してエフェクトを一時停止した後、再開させます。
reverse | () | メソッド |
public function reverse():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
seek | () | メソッド |
setTweenHandlers | () | メソッド |
public function setTweenHandlers(updateFunction:Function, endFunction:Function):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
デフォルトでは、Tween クラスはエフェクトインスタンスでエフェクトの持続時間の間、mx.effects.effectClasses.TweenEffectInstance.onTweenUpdate() コールバック関数を一定の間隔で呼び出し、さらにエフェクトの持続時間の終了時に、オプションの mx.effects.effectClasses.TweenEffectInstance.onTweenEnd() コールバック関数を呼び出します。
このメソッドによって、異なるメソッドを、更新コールバック関数と終了コールバック関数として指定することができます。
パラメーター
updateFunction:Function — 更新コールバック関数を指定します。
| |
endFunction:Function — 終了コールバック関数を指定します。
|
stop | () | メソッド |
public function stop():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
イベントを送出したり、Tween の endFunction や onTweenEnd() を呼び出したりせずに、トゥイーンを停止します。
Tue Jun 12 2018, 10:34 AM Z