| パッケージ | mx.effects |
| public class Tween | |
| 継承 | Tween  EventDispatcher Object |
トゥイーンエフェクトを定義する場合、通常、EffectInstance.play() メソッドのオーバーライドで Tween クラスのインスタンスを作成します。Tween インスタンスでは、アニメーションを定義するための startValue、endValue、および duration プロパティとオプションのイージング関数を使用できます。
Tween オブジェクトは、エフェクトインスタンスで、エフェクトの持続時間の間、mx.effects.effectClasses.TweenEffectInstance.onTweenUpdate() コールバック関数を一定の間隔で呼び出し、startValue と endValue の間の補間値を onTweenUpdate() メソッドに渡します。通常、コールバック関数はターゲットオブジェクトのプロパティをいくつか更新することで、エフェクトの持続時間の間、そのオブジェクトをアニメーション化します。
エフェクトの再生が終了すると、Tween オブジェクトは mx.effects.effectClasses.TweenEffectInstance.onTweenEnd() コールバック関数を呼び出します (定義されている場合)。
関連項目
| プロパティ | 定義 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
| Object | |
| duration : Number = 3000
アニメーションの継続時間を表します (ミリ秒単位)。
| Tween | ||
| easingFunction : Function
[write-only]
アニメーションのイージング関数を設定します。
| Tween | ||
| listener : Object
アニメーションの間隔ごとに通知されるオブジェクトを表します。
| Tween | ||
| prototype : Object
[static]
クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
| Object | |
| メソッド | 定義 | ||
|---|---|---|---|
|
Tween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1)
コンストラクタです。
| 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 | ||
|
指定されたオブジェクトのストリング表現を返します。
| Object | |
|
指定されたオブジェクトのプリミティブな値を返します。
| Object | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
| EventDispatcher | |
| duration | プロパティ |
継承されるパブリックプロパティの非表示
継承されるパブリックプロパティの表示public var duration:Number = 3000アニメーションの継続時間を表します (ミリ秒単位)。
| easingFunction | プロパティ |
easingFunction:Function [write-only]
アニメーションのイージング関数を設定します。イージング関数は startValue 値と endValue 値の間の補間に使用されます。一般のイージング関数は線形補間を実行しますが、より高度なイージング関数では加速と減速の効果を生成して、アニメーションがより自然になるようにします。
イージング関数を指定しない場合は、Math.sin() メソッドに基づくイージング関数が使用されます。
イージング関数は、Robert Penner 氏が普及に尽力した関数シグネチャに従っています。この関数では、4 つの引数を使用できます。1 番目の引数は、アニメーションの開始時刻を 0 とした "現在の時刻" です。2 番目の引数は、アニメーション開始時の初期値 (数値) です。3 番目の引数は、終了値から初期値を引いた値です。4 番目の引数は、アニメーションの再生時間です。戻り値は、現在の時刻に対する補間値になります。通常は、初期値と終了値の間の値になります。
Flex は、mx.effects.easing パッケージにイージング関数を一式含んでいます。
詳細については、http://www.ericd.net/chapter7.pdf を参照してください。
実装 public function set easingFunction(value:Function):void
| listener | プロパティ |
public var listener:Objectアニメーションの間隔ごとに通知されるオブジェクトを表します。
| Tween | () | コンストラクタ |
public 関数 Tween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -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 サイクルが得られずに一時的にフリーズしたアニメーションは、フリーズした位置から再生が再開されます。フリーズした位置よりも後の位置から突然再開することはありません。
|
| endTween | () | メソッド |
public function endTween():void
トゥイーンを中断し、直ちにトゥイーンの終わりにジャンプし、onTweenEnd() コールバック関数を呼び出します。
| pause | () | メソッド |
public function pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
| resume | () | メソッド |
public function resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
| reverse | () | メソッド |
public function reverse():voidエフェクトの現在位置から開始して、逆順でエフェクトを再生します。
| seek | () | メソッド |
public function seek(playheadTime:Number):voidトゥイーンエフェクトを指定の位置に移動します。
パラメータplayheadTime:Number — 0 から duration プロパティの値の範囲に収まる位置を表します (ミリ秒単位)。
|
| setTweenHandlers | () | メソッド |
public function setTweenHandlers(updateFunction:Function, endFunction:Function):void
デフォルトでは、Tween クラスはエフェクトインスタンスでエフェクトの持続時間の間、mx.effects.effectClasses.TweenEffectInstance.onTweenUpdate() コールバック関数を一定の間隔で呼び出し、さらにエフェクトの持続時間の終了時に、オプションの mx.effects.effectClasses.TweenEffectInstance.onTweenEnd() コールバック関数を呼び出します。
このメソッドによって、異なるメソッドを、更新コールバック関数と終了コールバック関数として指定することができます。
パラメータupdateFunction:Function — 更新コールバック関数を指定します。
|
|
endFunction:Function — 終了コールバック関数を指定します。
|