パッケージmx.effects.effectClasses
public class TweenEffectInstance
継承TweenEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object
SubclassesAnimatePropertyInstance, BlurInstance, DissolveInstance, FadeInstance, GlowInstance, MoveInstance, PauseInstance, ResizeInstance, RotateInstance, SeriesEffectInstance, ZoomInstance

TweenEffectInstance クラスは TweenEffect のインスタンスクラスを実装します。このクラスのインスタンスは TweenEffect エフェクトの再生時に Flex により作成されます。ユーザー自身が作成することはありません。

関連項目

mx.effects.Tween
mx.effects.TweenEffect
カスタムエフェクトの作成について
例 : トゥイーンエフェクトの作成


パブリックプロパティ
 プロパティ定義
 InheritedclassName : String
このエフェクトクラスの名前です。たとえば、"FadeInstance" などがあります。
EffectInstance
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 Inheritedduration : Number
エフェクトの継続時間を表します (ミリ秒単位)。
EffectInstance
  easingFunction : Function
アニメーションのイージング関数を表します。
TweenEffectInstance
 Inheritedeffect : Effect
この EffectInstance オブジェクトを作成した Effect オブジェクトを表します。
EffectInstance
  playheadTime : Number
[read-only] エフェクトの現在の位置を表します (ミリ秒単位)。
TweenEffectInstance
 InheritedpropertyChanges : PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。
EffectInstance
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 InheritedrepeatCount : int = 1
エフェクトを繰り返す回数を表します。
EffectInstance
 InheritedrepeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します (ミリ秒単位)。
EffectInstance
 InheritedstartDelay : int = 0
エフェクトを開始する前の待機時間を表します (ミリ秒単位)。
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean = false
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
EffectInstance
 Inheritedtarget : Object
このエフェクトが適用される UIComponent オブジェクトを表します。
EffectInstance
 InheritedtriggerEvent : Event
エフェクトの再生をトリガしたイベントを表します (存在する場合)。
EffectInstance
  tween : Tween
Tween オブジェクト。アニメーション化を判断します。
TweenEffectInstance
パブリックメソッド
 メソッド定義
  TweenEffectInstance(target:Object)
コンストラクタ。
TweenEffectInstance
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
  end():void
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。
TweenEffectInstance
 InheritedfinishEffect():void
エフェクトの再生が完了すると、end() メソッドによって呼び出されます。
EffectInstance
 InheritedfinishRepeat():void
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。
EffectInstance
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedinitEffect(event:Event):void
このメソッドは、エフェクトが EffectManager によってトリガされると、呼び出されます。
EffectInstance
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  onTweenEnd(value:Object):void
ターゲットがエフェクトによって最終的に更新される際に呼び出されるコールバックメソッドを表します。
TweenEffectInstance
  onTweenUpdate(value:Object):void
ターゲットがエフェクトによって更新される際に呼び出されるコールバックメソッドを表します。
TweenEffectInstance
 Inheritedpause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
EffectInstance
 Inheritedplay():void
ターゲットでエフェクトインスタンスを再生します。
EffectInstance
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inheritedresume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
EffectInstance
 Inheritedreverse():void
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
EffectInstance
  seek(playheadTime:Number):void
エフェクトを指定の位置に移動します。
TweenEffectInstance
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedstartEffect():void
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。
EffectInstance
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
Protectedメソッド
 メソッド定義
  createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):Tween
Tween インスタンスを作成し、開始値、終了値、継続値を割り当てます。
TweenEffectInstance
プロパティの詳細
easingFunctionプロパティ
public var easingFunction:Function

アニメーションのイージング関数を表します。デフォルトでは、エフェクトは TweenEffect クラスと同じイージング関数を使用します。

関連項目

playheadTimeプロパティ 
playheadTime:Number  [read-only]

エフェクトの現在の位置を表します (ミリ秒単位)。この値は、0 から duration プロパティの値の範囲となります。エフェクトの位置を変更するには seek() メソッドを使用します。

実装
    public function get playheadTime():Number
tweenプロパティ 
public var tween:Tween

Tween オブジェクト。アニメーション化を判断します。エフェクトを作成するには、EffectInstance.play() メソッドのオーバーライドで Tween インスタンスを作成し、これを tween プロパティに割り当てる必要があります。Tween オブジェクトを作成するには、createTween() メソッドを使用します。

コンストラクタの詳細
TweenEffectInstance()コンストラクタ
public 関数 TweenEffectInstance(target:Object)

コンストラクタ。

パラメータ
target:Object — このエフェクトでアニメーション化するオブジェクトを表します。
メソッドの詳細
createTween()メソッド
protected function createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):Tween

Tween インスタンスを作成し、開始値、終了値、継続値を割り当てます。イージング関数が指定されている場合は、この Tween インスタンスに割り当てられます。この Tween インスタンスには、以下の TweenEvents のイベントリスナーが割り当てられます。tweenStarttweenUpdate、およびtweenEnd。通常、このメソッドはアニメーションタイマーを効果的に開始する EffectInstance.play() メソッドのオーバーライドから呼び出します。

パラメータ
listener:Object — アニメーションの間隔ごとに通知されるオブジェクトを表します。通常は、this キーワードを値として渡します。listeneronTweenUpdate() メソッドを定義する必要があり、場合によっては onTweenEnd() メソッドも定義する必要があります。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 サイクルが得られずに一時的にフリーズしたアニメーションは、フリーズした位置から再生が再開されます。フリーズした位置よりも後の位置から突然再開することはありません。

戻り値
Tween — 新しく作成された Tween インスタンスです。
end()メソッド 
public override function end():void

現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。tween プロパティで Tween.endTween() メソッドを呼び出します。このメソッドによって、スーパークラスのメソッドが実装されます。

TweenEffectInstance のサブクラスを作成する場合、任意でこのメソッドをオーバーライドできます。

エフェクトは effectEnd イベントを送出します。

関連項目

onTweenEnd()メソッド 
public function onTweenEnd(value:Object):void

ターゲットがエフェクトによって最終的に更新される際に呼び出されるコールバックメソッドを表します。Tween クラスは、value 引数の値として Tween.endValue を渡します。value 引数は、Number または Number の配列です。

この関数のオーバーライドはオプションとなっています。また、ロジックの後、つまりオーバーライドの終わりでこのメソッドのスーパーバージョン super.onTweenEnd(val) を呼び出す必要があります。

パラメータ
value:Objectvalue 引数の値は、Tween.startValue プロパティや Tween.endValue プロパティのほか、play() メソッドにおけるエフェクトの実装で指定された補間関数によって決定される補間値です。play() メソッドでは、これらの値を使用して、一定時間エフェクトを再生する Tween オブジェクトを作成します。value 引数は、Number または Number の配列です。
onTweenUpdate()メソッド 
public function onTweenUpdate(value:Object):void

ターゲットがエフェクトによって更新される際に呼び出されるコールバックメソッドを表します。Tween クラスでは、イージング関数、ならびに Tween.startValueTween.endValue、および Tween.duration のプロパティを使用して、value 引数の値を算出します。value 引数は、Number または Number の配列です。

すべてのサブクラスではこのメソッドをオーバーライドする必要があります。このメソッドのオーバーライド時、この関数のスーパーバージョンを呼び出す必要はありません。

パラメータ
value:Objectvalue 引数の値は、Tween.startValue プロパティや Tween.endValue プロパティのほか、play() メソッドにおけるエフェクトの実装で指定された補間関数によって決定される補間値です。play() メソッドでは、これらの値を使用して、一定時間エフェクトを再生する Tween オブジェクトを作成します。value 引数は、Number または Number の配列です。
seek()メソッド 
public function seek(playheadTime:Number):void

エフェクトを指定の位置に移動します。

パラメータ
playheadTime:Number — 0 から duration プロパティの値の範囲に収まる位置を表します (ミリ秒単位)。