TweenEffect

パッケージ	mx.effects
クラス	public class TweenEffect
継承	TweenEffect Effect EventDispatcher Object
サブクラス	AnimateProperty, Blur, Dissolve, Fade, Glow, Move, Pause, Resize, Rotate, SeriesEffect, Zoom

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

Flex 4.0 以降では、このクラスの代わりとして spark.effects.Animate クラスを使用することをお勧めします。

TweenEffect は、Flex 3 のアニメーション化エフェクトのスーパークラスです。Flex 4 で導入された Spark エフェクトは、TweenEffect ではなく、spark.effects.Animate クラスを拡張します。

TweenEffect クラスは、Tween オブジェクトを基にしたすべてのエフェクトのスーパークラスです。このクラスでは、Tween ベースのエフェクトすべてに共通のメソッドとプロパティをカプセル化して、コードの無駄な繰り返しを防止しています。

TweenEffect クラスのサブクラスを作成して、アニメーションを長時間再生するエフェクトを定義できます。例えば、Resize エフェクトを使用すると、ターゲットのサイズ変更が指定した時間分だけ有効になります。

MXML シンタックス expanded

MXML シンタックスを隠す

The <mx:TweenEffect> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:TagName
    Properties
    easingFunction="easing function name; no default"
     
    Events
    tweenEnd="No default"
  />

例を表示

さらに例を参照

About creating a custom effect
Example: Creating a tween effect

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		className : String [読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。	Effect
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		customFilter : mx.effects:EffectTargetFilter エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。	Effect
		duration : Number エフェクトの継続時間を表します（ミリ秒単位）。	Effect
		easingFunction : Function = null アニメーションのイージング関数を表します。	TweenEffect
		effectTargetHost : mx.effects:IEffectTargetHost データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。	Effect
		filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。	Effect
		hideFocusRing : Boolean エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。	Effect
		instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。	Effect
		isPlaying : Boolean [読み取り専用] エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。	Effect
		perElementOffset : Number エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。	Effect
		playheadTime : Number エフェクトの現在の時間位置です。	Effect
		relevantProperties : Array フィルタリング実行時に使用するプロパティ名の配列を表します。	Effect
		relevantStyles : Array フィルタリング実行時に使用するスタイル名の配列を表します。	Effect
		repeatCount : int = 1 エフェクトを繰り返す回数を表します。	Effect
		repeatDelay : int = 0 エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。	Effect
		startDelay : int = 0 エフェクトを開始する前の待機時間を表します（ミリ秒単位）。	Effect
		suspendBackgroundProcessing : Boolean = false true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。	Effect
		target : Object このエフェクトが適用されるオブジェクトを表します。	Effect
		targets : Array エフェクトのターゲットであるオブジェクトの配列を表します。	Effect
		triggerEvent : Event エフェクトがトリガーされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。	Effect

プロテクトプロパティ

継承されるプロテクトプロパティを隠す

継承されるプロテクトプロパティを表示

	プロパティ		定義元
		applyTransitionEndProperties : Boolean このフラグは、エフェクトがトランジションで実行された場合に、エフェクト自体が設定した値をそのまま使用するのではなく、その終了状態に応じてプロパティ値を自動的に適用するかどうかを制御します。	Effect
		endValuesCaptured : Boolean = false エフェクトの終了値が既に決定されている場合は true を含むフラグ、エフェクトの実行時にエフェクトターゲットの現在のプロパティから終了値を取得する必要がある場合は false を含むフラグです。	Effect

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		TweenEffect(target:Object = null) コンストラクターです。	TweenEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		captureEndValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。	Effect
		captureMoreStartValues(targets:Array):void ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。	Effect
		captureStartValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。	Effect
		createInstance(target:Object = null):IEffectInstance 1 つのエフェクトインスタンスを作成し、それを初期化します。	Effect
		createInstances(targets:Array = null):Array ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。	Effect
		deleteInstance(instance:IEffectInstance):void インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。	Effect
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		end(effectInstance:IEffectInstance = null):void 現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。	Effect
		getAffectedProperties():Array ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。	Effect
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		pause():void resume() メソッドを呼び出すまで、エフェクトを一時停止します。	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array エフェクトの再生を開始します。	Effect
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		resume():void pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。	Effect
		reverse():void エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		stop():void エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。	Effect
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

プロテクトメソッド

継承されるプロテクトメソッドを隠す

継承されるプロテクトメソッドを表示

	メソッド		定義元
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void エフェクトインフラストラクチャによって内部的に使用されます。	Effect
		effectEndHandler(event:EffectEvent):void エフェクトインスタンスの再生終了時に呼び出されます。	Effect
		effectStartHandler(event:EffectEvent):void このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。	Effect
		effectStopHandler(event:EffectEvent):void エフェクトインスタンスが stop() メソッドの呼び出しによって停止されると呼び出されます。	Effect
		filterInstance(propChanges:Array, target:Object):Boolean エフェクトインスタンスをフィルタリングするために必要なロジックを決定します。	Effect
		getValueFromTarget(target:Object, property:String):* ターゲットからプロパティの値を取得するために captureStartValues() メソッドによって呼び出されます。	Effect
		initInstance(instance:IEffectInstance):void エフェクトインスタンスにエフェクトのプロパティをコピーします。	Effect
		tweenEventHandler(event:mx.events:TweenEvent):void TweenEffect から TweenEvent が送出されたときに呼び出されます。	TweenEffect

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
effectEnd	エフェクトのインスタンスの 1 つが再生を停止したとき（インスタンスの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき）に送出されます。	Effect
effectStart	エフェクトの再生開始時に送出されます。	Effect
effectStop	エフェクトが停止されると送出されます。これが発生するのは、stop() メソッドの呼び出しによってエフェクトが中断された場合のみです。	Effect
tweenEnd	トゥイーンエフェクトの終了時に送出されます。	TweenEffect
tweenStart	トゥイーンエフェクトの開始時に送出されます。これは onTweenUpdate() メソッドの最初の呼び出しに対応します。	TweenEffect
tweenUpdate	トゥイーンエフェクトでターゲットが更新されるたびに送出されます。	TweenEffect

プロパティの詳細

easingFunction

プロパティ

public var easingFunction:Function = null

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

アニメーションのイージング関数を表します。イージング関数は初期値と終了値の間の補間に使用されます。一般のイージング関数は線形補間を実行するだけですが、より高度なイージング関数では加速と減速の効果を生成して、アニメーションがより自然になるようにします。

イージング関数を指定しない場合は、Math.sin() メソッドに基づくイージング関数が使用されます。

イージング関数は、Robert Penner 氏が普及に尽力した関数シグネチャに従っています。この関数では、4 つの引数を使用できます。 1 番目の引数は、アニメーションの開始時刻を 0 とした "現在の時刻" です。 2 番目の引数は、アニメーション開始時の初期値（数値）です。 3 番目の引数は、終了値から初期値を引いた値です。 4 番目の引数は、アニメーションの再生時間です。戻り値は、現在の時刻に対する補間値になります。通常、この値は初期値と終了値の間の値になります。

このプロパティの値は、必ず関数オブジェクトとなります。

Flex は、mx.effects.easing パッケージにイージング関数を一式含んでいます。

コンストラクターの詳細

()

コンストラクター

public function TweenEffect(target:Object = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コンストラクターです。

パラメーター

target:Object (default = null) — このエフェクトでアニメーション化するオブジェクトを表します。

メソッドの詳細

tweenEventHandler

()

メソッド

protected function tweenEventHandler(event:mx.events:TweenEvent):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

TweenEffect から TweenEvent が送出されたときに呼び出されます。このメソッドをオーバーライドする場合、必ずスーパーメソッドを呼び出すようにしてください。

パラメーター

event:mx.events:TweenEvent — TweenEvent 型のイベントオブジェクトを表します。

イベントの詳細

tweenEnd

イベント

イベントオブジェクトの型: mx.events.TweenEvent
プロパティ TweenEvent.type = mx.events.TweenEvent.TWEEN_END

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

トゥイーンエフェクトの終了時に送出されます。このイベントは、TweenEffectInstance.onTweenEnd() メソッドの呼び出しに対応しています。

トゥイーンエフェクトが 1 度だけ再生された場合、このイベントは effectEnd イベントと同時に発生します。トゥイーンエフェクトを繰り返し再生させる場合、このイベントはエフェクトが繰り返されるたびに発生し、最後のエフェクトの再生後に endEffect イベントが発生します。

TweenEvent.TWEEN_END 定数により、イベントオブジェクトの type プロパティ値が tweenEnd イベント用に定義されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
`bubbles`	false
`cancelable`	false
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。
`value`	`onTweenEnd()` メソッドに渡された値です。

tweenStart

イベント

イベントオブジェクトの型: mx.events.TweenEvent
プロパティ TweenEvent.type = mx.events.TweenEvent.TWEEN_START

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

トゥイーンエフェクトの開始時に送出されます。これは onTweenUpdate() メソッドの最初の呼び出しに対応します。同時に、Flex によって、エフェクトの最初の tweenUpdate イベントも送出されます。

Effect.effectStart イベントは tweenStart イベントの前に送出されます。

TweenEvent.TWEEN_START 定数により、イベントオブジェクトの type プロパティ値が tweenStart イベント用に定義されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
`bubbles`	false
`cancelable`	false
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。
`value`	`onTweenUpdate()` メソッドに渡された値です。

tweenUpdate

イベント

イベントオブジェクトの型: mx.events.TweenEvent
プロパティ TweenEvent.type = mx.events.TweenEvent.TWEEN_UPDATE

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

トゥイーンエフェクトでターゲットが更新されるたびに送出されます。このイベントは、TweenEffectInstance.onTweenUpdate() メソッドの呼び出しに対応しています。

TweenEvent.TWEEN_UPDATE 定数により、イベントオブジェクトの type プロパティ値が tweenUpdate イベント用に定義されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
`bubbles`	false
`cancelable`	false
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。
`value`	`onTweenUpdate()` メソッドに渡された値です。

例この例の使用方法

SimpleTweenEffectExample.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the TweenEffect class. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <fx:Script>
        <![CDATA[

            import mx.events.TweenEvent;

            // Event handler for the tweenUpdate and tweenEnd effects.
            private function tweenUpdateHandler(event:TweenEvent):void {
                // Access current width of the image.
                currentWidth.text="Current width (in pixels): " + String(event.value[0]);
            }

            // Event handler for the reset button.
            private function resetHandler():void {
                expand.end();
                img.width=30;
                currentWidth.text="Current width (in pixels): 30";
                img.height=60;
                button1.enabled=true;
            }
        ]]>
    </fx:Script>
    <fx:Declarations>
        <mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200"
            duration="10000"
            tweenUpdate="tweenUpdateHandler(event);"
            tweenEnd="tweenUpdateHandler(event);"/>
    </fx:Declarations>

    <s:Panel title="Resize Effect Example" width="100%" height="100%" >
        <s:VGroup left="20" right="20" top="20" bottom="20">

            <s:Label width="100%" color="blue"
                text="Use the Button controls to resize the image."/>

            <s:HGroup width="100%">
                <mx:Image id="img" width="30" height="60"
                    source="@Embed(source='assets/Nokia_6630.png')"/>
                <s:Label id="currentWidth" height="20" width="100%"/>
            </s:HGroup>

            <s:Button id="button1" label="Start" click="expand.play(); button1.enabled=false;"/>
            <s:Button label="Pause" click="expand.pause();"/>
            <s:Button label="Resume" click="expand.resume();"/>
            <s:Button label="Reverse" click="expand.reverse();"/>
            <s:Button label="End" click="expand.end();"/>
            <s:Button label="Reset" click="resetHandler();"/>
        </s:VGroup>

    </s:Panel>
</s:Application>

法律上の注意 | プライバシーポリシー

TweenEffect - AS3 Flex

クラス x

easingFunction

TweenEffect

tweenEventHandler

tweenEnd

tweenStart

tweenUpdate