Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
spark.effects 

Wipe  - AS3 Flex

パッケージspark.effects
クラスpublic class Wipe
継承Wipe Inheritance AnimateTransitionShader Inheritance Animate Inheritance Effect Inheritance EventDispatcher Inheritance Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4
ランタイムバージョン: Flash Player 10, AIR 1.5


Wipe エフェクトは、AIR モバイルアプリケーションではサポートされていない Pixel Bender を使用します。

Wipe エフェクトは、最初のビットマップと 2 番目のビットマップの間において指定した方向でワイプを行うことによって、ビットマップトランジションエフェクトを実行します。このワイプは、アニメーション実行期間にわたって、direction プロパティによって示された方向で 2 番目のビットマップを公開します。

エフェクトによってロードされるピクセルシェーダープログラムは、基になるビットマップエフェクトを実行します。別の Wipe ビヘイビアーを使用する場合は、カスタムのピクセルシェーダープログラムを指定する必要があります。ピクセルシェーダープログラムは、AnimateTransitionShader クラスの shaderByteCode プロパティで指定された制約を順守し、3 つの追加パラメーターを提供する必要があります。Wipe シェーダーで必要になる追加のパラメーターは次のとおりです。

  • int の direction パラメーター。この値は、Wipe クラスの関連する String プロパティと同じ意味を持ちます。
  • 浮動小数点パラメーター imageWidth および imageHeight

これらのすべてのパラメーターは、エフェクトの再生が開始されるときにシェーダーで設定されます。したがって、エフェクトが正しく機能するためには、パラメーターが存在しており、何らかの適切な役割を果たす必要があります。

MXML シンタックスexpandedMXML シンタックスを隠す

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

  <s:Wipe
    Properties
    id="ID"
    direction="right"
  />
  

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

例を表示

さらに例を参照

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
 InheritedbitmapFrom : BitmapData
このエフェクトの開始ステートを表すビットマップデータです。
AnimateTransitionShader
 InheritedbitmapTo : BitmapData
このエフェクトの終了ステートを表すビットマップデータです。
AnimateTransitionShader
 InheritedclassName : String
[読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。
Effect
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
 InheritedcustomFilter : mx.effects:EffectTargetFilter
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。
Effect
  direction : String = "right"
アニメーション実行期間にワイプが移動する方向は、WipeDirection.RIGHT、WipeDirection.LEFT、WipeDirection.UP、または WipeDirection.DOWN です。
Wipe
 InheriteddisableLayout : Boolean
true の場合、エフェクトはそのターゲットの親コンテナでのレイアウトを無効にし、コンテナの autoLayout プロパティを false に設定して、ターゲットオブジェクトでのすべてのレイアウト制約も無効にします。
Animate
 Inheritedduration : Number
エフェクトの継続時間を表します(ミリ秒単位)。
Effect
 Inheritedeaser : IEaser
このエフェクトのイージングビヘイビアーです。
Animate
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。
Effect
 Inheritedfilter : String
エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。
Effect
 InheritedhideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。
Effect
 InheritedinstanceClass : Class
このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。
Effect
 Inheritedinterpolator : IInterpolator
プロパティの開始値と終了値の間の値を計算するためにこのエフェクトによって使用されるインターポレーターです。
Animate
 InheritedisPlaying : Boolean
[読み取り専用] エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。
Effect
 InheritedmotionPaths : Vector.<MotionPath>
MotionPath オブジェクトのベクターです。各オブジェクトには、アニメーション化するプロパティの名前と、アニメーション実行期間においてプロパティが受け取る値が保持されます。
Animate
 InheritedperElementOffset : Number
エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延(ミリ秒)です。
Effect
 InheritedplayheadTime : Number
エフェクトの現在の時間位置です。
Effect
 InheritedrelevantProperties : Array
フィルタリング実行時に使用するプロパティ名の配列を表します。
Effect
 InheritedrelevantStyles : Array
フィルタリング実行時に使用するスタイル名の配列を表します。
Effect
 InheritedrepeatBehavior : String
繰り返すエフェクト、つまり repeatCount が 0 であるか 1 よりも大きいエフェクトのビヘイビアーです。
Animate
 InheritedrepeatCount : int = 1
エフェクトを繰り返す回数を表します。
Effect
 InheritedrepeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します(ミリ秒単位)。
Effect
 InheritedshaderByteCode : Object
2 つのビットマップ間をアニメーション化するためにエフェクトが使用する、ピクセルシェーダープログラムのバイトコードです。
AnimateTransitionShader
 InheritedshaderProperties : Object
再生の前にピクセルシェーダープログラムに渡される、パラメーターの名前と値のペアを表すマップです。
AnimateTransitionShader
 InheritedstartDelay : int = 0
エフェクトを開始する前の待機時間を表します(ミリ秒単位)。
Effect
 Inheritedtarget : Object
このエフェクトが適用されるオブジェクトを表します。
Effect
 Inheritedtargets : Array
エフェクトのターゲットであるオブジェクトの配列を表します。
Effect
 InheritedtriggerEvent : Event
エフェクトがトリガーされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。
Effect
プロテクトプロパティ
 プロパティ定義元
 InheritedapplyTransitionEndProperties : Boolean
このフラグは、エフェクトがトランジションで実行された場合に、エフェクト自体が設定した値をそのまま使用するのではなく、その終了状態に応じてプロパティ値を自動的に適用するかどうかを制御します。
Effect
 InheritedendValuesCaptured : Boolean = false
エフェクトの終了値が既に決定されている場合は true を含むフラグ、エフェクトの実行時にエフェクトターゲットの現在のプロパティから終了値を取得する必要がある場合は false を含むフラグです。
Effect
パブリックメソッド
 メソッド定義元
  
Wipe(target:Object = null)
コンストラクターです。
Wipe
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。
Effect
 Inherited
ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。
Effect
 Inherited
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。
Effect
 Inherited
1 つのエフェクトインスタンスを作成し、それを初期化します。
Effect
 Inherited
createInstances(targets:Array = null):Array
ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。
Effect
 Inherited
インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。
Effect
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
end(effectInstance:IEffectInstance = null):void
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。
Effect
 Inherited
ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。
Effect
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
エフェクトの再生を開始します。
Effect
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
Effect
 Inherited
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
Effect
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。
Effect
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
エフェクトインフラストラクチャによって内部的に使用されます。
Effect
 Inherited
エフェクトインスタンスの再生終了時に呼び出されます。
Effect
 Inherited
このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。
Effect
 Inherited
エフェクトインスタンスが stop() メソッドの呼び出しによって停止されると呼び出されます。
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
エフェクトインスタンスをフィルタリングするために必要なロジックを決定します。
Effect
 Inherited
getValueFromTarget(target:Object, property:String):*
ターゲットからプロパティの値を取得するために captureStartValues() メソッドによって呼び出されます。
Effect
 Inherited
エフェクトインスタンスにエフェクトのプロパティをコピーします。
Effect
イベント
 イベント 概要 定義元
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
 Inheritedエフェクトのインスタンスの 1 つが再生を停止したとき(インスタンスの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき)に送出されます。Effect
 Inherited複数回繰り返される任意のエフェクトにおいて、エフェクトが新しい繰り返し処理を開始すると送出されます。Animate
 Inheritedエフェクトの再生開始時に送出されます。Effect
 Inheritedエフェクトが停止されると送出されます。これが発生するのは、stop() メソッドの呼び出しによってエフェクトが中断された場合のみです。Effect
 Inheritedエフェクトでターゲットが更新されるたびに送出されます。Animate
プロパティの詳細

direction

プロパティ
public var direction:String = "right"

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4
ランタイムバージョン: Flash Player 10, AIR 1.5

アニメーション実行期間にワイプが移動する方向は、WipeDirection.RIGHTWipeDirection.LEFTWipeDirection.UP、または WipeDirection.DOWN です。

デフォルト値: WipeDirection.RIGHT。

関連する API エレメント

コンストラクターの詳細

Wipe

()コンストラクター
public function Wipe(target:Object = null)

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4
ランタイムバージョン: Flash Player 10, AIR 1.5

コンストラクターです。

パラメーター
target:Object (default = null) — このエフェクトでアニメーション化するオブジェクトを表します。
WipeExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<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">

    <s:states>
        <s:State name="default"/>
        <s:State name="flipped"/>
    </s:states>

    <s:transitions>
        <s:Transition id="t1">
            <s:Wipe id="wipe"
                direction="right"
                target="{holder}"
                duration="1000" />
        </s:Transition>
    </s:transitions>

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

        <s:HGroup width="100%" height="100%" left="5" top="5"
            horizontalCenter="0" verticalCenter="0">
            <s:Group id="holder">
                <s:BitmapImage
                    source="@Embed('assets/back2.png')"
                    visible="true" visible.flipped="false"/>
                <s:BitmapImage
                    source="@Embed('assets/c2.png')"
                    visible="false" visible.flipped="true"/>
            </s:Group>

            <!-- Directions -->
            <s:VGroup id="detailsBox"
                width="50%"
                left="0">
                <s:Label
                    width="99%"
                    color="blue"
                    text="Wipe wipes from bitmapFrom to the bitmapTo image in the given direction. Click the 'Wipe Right' button to see the effect."/>
            </s:VGroup>
        </s:HGroup>

        <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
            left="5" bottom="5"
            label="Wipe Right"
            click="currentState = (currentState == 'flipped') ? 'default' : 'flipped';"/>
    </s:Panel>

</s:Application>




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。