パッケージ | spark.effects |
クラス | public class Wipe |
継承 | Wipe AnimateTransitionShader Animate Effect EventDispatcher 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 シンタックスMXML シンタックスを隠す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
さらに例を参照
Spark pixel-shader effects
Using a pixel-shader effect in a transition
Applying a pixel-shader effect
Creating a custom pixel shader
Using a pixel-shader effect in a transition
Applying a pixel-shader effect
Creating a custom pixel shader
関連する API エレメント
spark.effects.WipeDirection
spark.effects.AnimateTransitionShader
spark.effects.AnimateTransitionShader.shaderByteCode
spark.effects.AnimateTransitionShader
spark.effects.AnimateTransitionShader.shaderByteCode
パブリックプロパティ
プロパティ | 定義元 | ||
---|---|---|---|
bitmapFrom : BitmapData
このエフェクトの開始ステートを表すビットマップデータです。 | AnimateTransitionShader | ||
bitmapTo : BitmapData
このエフェクトの終了ステートを表すビットマップデータです。 | AnimateTransitionShader | ||
className : String [読み取り専用]
このエフェクトクラスの名前です。たとえば、"Fade" などがあります。 | Effect | ||
constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | ||
customFilter : mx.effects:EffectTargetFilter
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。 | Effect | ||
direction : String = "right"
アニメーション実行期間にワイプが移動する方向は、WipeDirection.RIGHT、WipeDirection.LEFT、WipeDirection.UP、または WipeDirection.DOWN です。 | Wipe | ||
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 | ||
shaderByteCode : Object
2 つのビットマップ間をアニメーション化するためにエフェクトが使用する、ピクセルシェーダープログラムのバイトコードです。 | AnimateTransitionShader | ||
shaderProperties : Object
再生の前にピクセルシェーダープログラムに渡される、パラメーターの名前と値のペアを表すマップです。 | AnimateTransitionShader | ||
startDelay : int = 0
エフェクトを開始する前の待機時間を表します(ミリ秒単位)。 | Effect | ||
target : Object
このエフェクトが適用されるオブジェクトを表します。 | Effect | ||
targets : Array
エフェクトのターゲットであるオブジェクトの配列を表します。 | Effect | ||
triggerEvent : Event
エフェクトがトリガーされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。 | Effect |
プロテクトプロパティ
パブリックメソッド
メソッド | 定義元 | ||
---|---|---|---|
コンストラクターです。 | Wipe | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | ||
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。 | Effect | ||
ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。
| Effect | ||
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。 | Effect | ||
1 つのエフェクトインスタンスを作成し、それを初期化します。 | Effect | ||
ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。 | Effect | ||
インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。 | Effect | ||
イベントをイベントフローに送出します。 | EventDispatcher | ||
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。 | Effect | ||
ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。 | Effect | ||
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
resume() メソッドを呼び出すまで、エフェクトを一時停止します。 | Effect | ||
エフェクトの再生を開始します。 | Effect | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | ||
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。 | Effect | ||
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。 | Effect | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。 | Effect | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのプリミティブな値を返します。 | Object | ||
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher |
プロテクトメソッド
プロパティの詳細
direction | プロパティ |
public var direction:String = "right"
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 4 |
ランタイムバージョン: | Flash Player 10, AIR 1.5 |
アニメーション実行期間にワイプが移動する方向は、WipeDirection.RIGHT
、WipeDirection.LEFT
、WipeDirection.UP
、または WipeDirection.DOWN
です。
デフォルト値: WipeDirection.RIGHT。
関連する API エレメント
コンストラクターの詳細
Wipe | () | コンストラクター |
例 この例の使用方法
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>
Tue Jun 12 2018, 10:34 AM Z