Animate

パッケージ	spark.effects
クラス	public class Animate
継承	Animate Effect EventDispatcher Object
サブクラス	AnimateColor, AnimateFilter, AnimateTransform, AnimateTransitionShader, Fade, Resize

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

この Animate エフェクトは、任意のプロパティセットを値間でアニメーション化します。motionPaths プロパティを設定することによって、アニメーション化するプロパティと値を指定します。

MXML シンタックス expanded

MXML シンタックスを隠す

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

  <s:Animate
    Properties
    id="ID"
    disableLayout="false"
    easer="{spark.effects.easing.Sine(.5)}"
    interpolator="NumberInterpolator"
    motionPaths="no default"
    repeatBehavior="loop"
  />

デフォルトの MXML プロパティmotionPaths

さらに例を参照

パブリックプロパティ

	プロパティ		定義元
		className : String [読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。	Effect
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		customFilter : mx.effects:EffectTargetFilter エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。	Effect
		disableLayout : Boolean true の場合、エフェクトはそのターゲットの親コンテナでのレイアウトを無効にし、コンテナの autoLayout プロパティを false に設定して、ターゲットオブジェクトでのすべてのレイアウト制約も無効にします。	Animate
		duration : Number エフェクトの継続時間を表します（ミリ秒単位）。	Effect
		easer : IEaser このエフェクトのイージングビヘイビアーです。	Animate
		effectTargetHost : mx.effects:IEffectTargetHost データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。	Effect
		filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。	Effect
		hideFocusRing : Boolean エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。	Effect
		instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。	Effect
		interpolator : IInterpolator プロパティの開始値と終了値の間の値を計算するためにこのエフェクトによって使用されるインターポレーターです。	Animate
		isPlaying : Boolean [読み取り専用] エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。	Effect
		motionPaths : Vector.<MotionPath> MotionPath オブジェクトのベクターです。各オブジェクトには、アニメーション化するプロパティの名前と、アニメーション実行期間においてプロパティが受け取る値が保持されます。	Animate
		perElementOffset : Number エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。	Effect
		playheadTime : Number エフェクトの現在の時間位置です。	Effect
		relevantProperties : Array フィルタリング実行時に使用するプロパティ名の配列を表します。	Effect
		relevantStyles : Array フィルタリング実行時に使用するスタイル名の配列を表します。	Effect
		repeatBehavior : String 繰り返すエフェクト、つまり repeatCount が 0 であるか 1 よりも大きいエフェクトのビヘイビアーです。	Animate
		repeatCount : int = 1 エフェクトを繰り返す回数を表します。	Effect
		repeatDelay : int = 0 エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。	Effect
		startDelay : int = 0 エフェクトを開始する前の待機時間を表します（ミリ秒単位）。	Effect
		target : Object このエフェクトが適用されるオブジェクトを表します。	Effect
		targets : Array エフェクトのターゲットであるオブジェクトの配列を表します。	Effect
		triggerEvent : Event エフェクトがトリガーされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。	Effect

プロテクトプロパティ

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

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

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

パブリックメソッド

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

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

	メソッド		定義元
		Animate(target:Object = null) コンストラクターです。	Animate
		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

イベント

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

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

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

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

プロパティの詳細

disableLayout

プロパティ

disableLayout:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

true の場合、エフェクトはそのターゲットの親コンテナでのレイアウトを無効にし、コンテナの autoLayout プロパティを false に設定して、ターゲットオブジェクトでのすべてのレイアウト制約も無効にします。これらのプロパティは、エフェクトの終了時に復元されます。

デフォルト値： false。

実装
public function get disableLayout():Boolean
public function set disableLayout(value:Boolean):void

easer

プロパティ

easer:IEaser

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

このエフェクトのイージングビヘイビアーです。この IEaser オブジェクトは、アニメーションの経過割合をイージング割合に変換するために使用され、これが後でその経過イージング割合で値を計算するために使用されます。

エフェクトレベルと Keyframe レベルの両方にイージングがある場合があります（Keyframe が MotionPath 構造体で使用される値/時間を保持している場合）。これらのイージングビヘイビアーは相互に作成されます。easer はエフェクト全体のイージングを制御します。Keyframe はアニメーションの特定の間隔におけるイージングを制御します。デフォルトでは、Animate に対するイージングは非線形です（Sine(.5)）。Keyframe に対するイージングは線形です。代わりにキーフレームレベルでイージングのあるエフェクトが必要な場合は、エフェクトのイージングを線形に設定し、Keyframe でイージングを具体的に設定できます。

デフォルト値： spark.effects.easing.Sine(.5)。

実装
public function get easer():IEaser
public function set easer(value:IEaser):void

interpolator

プロパティ

interpolator:IInterpolator

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

プロパティの開始値と終了値の間の値を計算するためにこのエフェクトによって使用されるインターポレーターです。デフォルトでは、補間は NumberInterpolator クラスによって処理されます。開始値と終了値が配列またはベクターになっている場合は、MultiValueInterpolator クラスによって処理されます。他の型の補間、または異なる方法で補間する必要がある Number（カラーチャンネル情報を保持する uint 値など）の補間は、異なるインターポレーターを提供することによって処理できます。

実装
public function get interpolator():IInterpolator
public function set interpolator(value:IInterpolator):void

motionPaths

プロパティ

motionPaths:Vector.<MotionPath>

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

MotionPath オブジェクトのベクターです。各オブジェクトには、アニメーション化するプロパティの名前と、アニメーション実行期間においてプロパティが受け取る値が保持されます。このベクターは、Animate のサブクラスで宣言されたどのプロパティよりも優先されます。例えば、この配列が Move エフェクトに対して直接設定されている場合、xFrom などの Move エフェクトのプロパティはすべて無視されます。

実装
public function get motionPaths():Vector.<MotionPath>
public function set motionPaths(value:Vector.<MotionPath>):void

repeatBehavior

プロパティ

repeatBehavior:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

繰り返すエフェクト、つまり repeatCount が 0 であるか 1 よりも大きいエフェクトのビヘイビアーです。この値は、RepeatBehavior.LOOP（毎回同じ順番でアニメーションを繰り返す）または RepeatBehavior.REVERSE（繰り返しのたびにアニメーションの方向を逆にする）である必要があります。

デフォルト値： RepeatBehavior.LOOP。

実装
public function get repeatBehavior():String
public function set repeatBehavior(value:String):void

コンストラクターの詳細

()

コンストラクター

public function Animate(target:Object = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

コンストラクターです。

パラメーター

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

イベントの詳細

effectRepeat

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

複数回繰り返される任意のエフェクトにおいて、エフェクトが新しい繰り返し処理を開始すると送出されます。同時に、Flex によって、エフェクトの effectUpdate イベントも送出されます。

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

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

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

effectUpdate

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

エフェクトでターゲットが更新されるたびに送出されます。

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

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

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

例この例の使用方法

AnimateEffectExample.mxml

<?xml version="1.0"?>
<s:Application
    xmlns:fx="http://ns.adobe.com/mxml/2009"
    xmlns:mx="library://ns.adobe.com/flex/mx"
    xmlns:s="library://ns.adobe.com/flex/spark">

    <fx:Declarations>
        <s:Animate id="animateEffect"
            target="{targetBox}" repeatCount="2" repeatBehavior="reverse" disableLayout="true" effectStart="playButton.enabled=false" effectEnd="playButton.enabled=true;">
            <s:motionPaths>
                <s:SimpleMotionPath property="x" valueFrom="0" valueTo="100"/>
                <s:SimpleMotionPath property="alpha" valueFrom="1" valueTo="0"/>
            </s:motionPaths>
        </s:Animate>
    </fx:Declarations>

    <s:Panel title="Animate Effect Example"
        width="75%" height="75%">

        <mx:HBox width="100%" height="100%">
            <!-- Our target to affect-->
            <mx:VBox id="targetBox" width="50%"  horizontalAlign="center">
                <mx:Label text="Nokia 9930" />
                <mx:Image id="targetImg" source="@Embed(source='assets/Nokia_6630.png')"/>
            </mx:VBox>
            <mx:VBox id="detailsBox" width="50%" left="0">
                <mx:Text width="99%" color="blue"
                    text="The Animate effect animates any property or style of an object over time using animationProperty arrays. Click 'Animate' to watch the effect."/>
            </mx:VBox>
        </mx:HBox>

        <s:Rect left="0" right="0" bottom="0" height="30">
            <s:fill>
                <s:LinearGradient rotation="90">
                    <s:GradientEntry color="0xE2E2E2" />
                    <s:GradientEntry color="0xD9D9D9" />
                </s:LinearGradient>
            </s:fill>
        </s:Rect>
        <s:Button id="playButton"
            left="5" bottom="5"
            label="Animate"
            click="animateEffect.play();"/>
    </s:Panel>
</s:Application>

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

Animate - AS3 Flex

クラス x

disableLayout

easer

interpolator

motionPaths

repeatBehavior

Animate

effectRepeat

effectUpdate