| パッケージ | mx.effects.effectClasses |
| クラス | public class MaskEffectInstance |
| 継承 | MaskEffectInstance  EffectInstance EventDispatcher Object |
| サブクラス | IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
TweenEffect クラスのサブクラスであるすべてのエフェクトクラスは、以下のイベントをサポートします。
-
tweenEnd：トゥイーンエフェクトの終了時に送出されます。 -
tweenUpdate：TweenEffect クラスで新しい値が計算されるたびに送出されます。
これらのイベントのイベントリスナーに渡されるイベントオブジェクトのタイプは TweenEvent です。 TweenEvent クラスは、エフェクトで計算されたトゥイーン値を含む value プロパティを定義します。 Mask エフェクトの場合、TweenEvent.value プロパティには以下の 4 個のアイテムを持つ配列が含まれます。
- value[0]:Number ターゲットの
xプロパティの値です。 - value[1]:Number ターゲットの
yプロパティの値です。 - value[2]:Number ターゲットの
scaleXプロパティの値です。 - value[3]:Number ターゲットの
scaleYプロパティの値です。
関連する API エレメント
パブリックプロパティ
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
 | className : String [読み取り専用]
このエフェクトクラスの名前です。たとえば、"FadeInstance" などがあります。 | EffectInstance | |
| constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| createMaskFunction : Function
エフェクトによってマスクが作成される際に呼び出される関数を表します。 | MaskEffectInstance | ||
| duration : Number
エフェクトの持続時間を表します（ミリ秒単位）。 | EffectInstance | |
| effect : IEffect
この IEffectInstance オブジェクトを作成した IEffect オブジェクトを表します。 | EffectInstance | |
| effectTargetHost : mx.effects:IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。 | EffectInstance | |
| hideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。 | EffectInstance | |
| moveEasingFunction : Function
マスクを移動させるのに使用するイージング関数を表します。 | MaskEffectInstance | ||
| playheadTime : Number
エフェクトの現在の時間位置です。 | EffectInstance | |
| propertyChanges : PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。 | EffectInstance | |
| repeatCount : int
エフェクトを繰り返す回数を表します。 | EffectInstance | |
| repeatDelay : int
エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。 | EffectInstance | |
| scaleEasingFunction : Function
マスクの伸縮に使用するイージング関数を表します。 | MaskEffectInstance | ||
| scaleXFrom : Number
マスクの初期 scaleX を表します。 | MaskEffectInstance | ||
| scaleXTo : Number
マスクの終了 scaleX を表します。 | MaskEffectInstance | ||
| scaleYFrom : Number
マスクの初期 scaleY を表します。 | MaskEffectInstance | ||
| scaleYTo : Number
マスクの終了 scaleY を表します。 | MaskEffectInstance | ||
| showTarget : Boolean
ターゲットコンポーネントを表示状態にするか（false）、非表示状態にするか（true）を指定します。 | MaskEffectInstance | ||
| startDelay : int
エフェクトを開始する前の待機時間を表します（ミリ秒単位）。 | EffectInstance | |
| suspendBackgroundProcessing : Boolean
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。 | EffectInstance | |
| target : Object
このエフェクトが適用される UIComponent オブジェクトを表します。 | EffectInstance | |
| targetArea : Rectangle
ターゲットでマスクが適用される領域を表します。 | MaskEffectInstance | ||
| triggerEvent : Event
エフェクトの再生をトリガーしたイベントを表します（存在する場合）。 | EffectInstance | |
| xFrom : Number
マスクの初期位置の x 座標を表します。 | MaskEffectInstance | ||
| xTo : Number
マスクの移動先の位置の x 座標を表します。 | MaskEffectInstance | ||
| yFrom : Number
マスクの初期位置の y 座標を表します。 | MaskEffectInstance | ||
| yTo : Number
マスクの移動先の位置の y 座標を表します。 | MaskEffectInstance | ||
プロテクトプロパティ
| プロパティ | 定義元 | ||
|---|---|---|---|
| effectMask : Shape
defaultCreateMask() メソッドによって作成されたデフォルトマスク、または createMaskFunction プロパティに渡された関数で指定されたマスクのいずれかのエフェクトマスクが含まれます。 | MaskEffectInstance | ||
| playCount : int = 0
インスタンスが再生された回数です。 | EffectInstance | |
| targetVisualBounds : Rectangle
エフェクトターゲットの実際のサイズです。サイズにはドロップシャドウも含まれます。 | MaskEffectInstance | ||
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
MaskEffectInstance(target:Object)
コンストラクターです。 | MaskEffectInstance | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | |
|
イベントをイベントフローに送出します。 | EventDispatcher | |
|
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。 | EffectInstance | |
|
エフェクトの再生が完了すると、end() メソッドによって呼び出されます。 | EffectInstance | |
|
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。 | EffectInstance | |
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | |
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
このメソッドは、エフェクトが EffectManager によってトリガーされると呼び出されます。 | EffectInstance | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
[オーバーライド]
resume() メソッドを呼び出すまで、エフェクトを一時停止します。 | MaskEffectInstance | ||
|
ターゲットでエフェクトインスタンスを再生します。 | EffectInstance | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | |
[オーバーライド]
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。 | MaskEffectInstance | ||
[オーバーライド]
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。 | MaskEffectInstance | ||
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。 | EffectInstance | |
|
ターゲットを現在の状態にしたまま、エフェクトを停止します。 | EffectInstance | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
プロテクトメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
エフェクトのデフォルトマスクを作成します。 | MaskEffectInstance | ||
エフェクトの move プロパティと scale プロパティを初期化します。 | MaskEffectInstance | ||
マスクの x 位置と y 位置がエフェクトによって最終的に更新されるときに呼び出されるコールバックメソッドを表します。 | MaskEffectInstance | ||
マスクの x 位置と y 位置がエフェクトによって更新されるときに呼び出されるコールバックメソッドを表します。 | MaskEffectInstance | ||
マスクの scaleX プロパティと scaleY プロパティがエフェクトによって最終的に更新されるときに呼び出されるコールバックメソッドを表します。 | MaskEffectInstance | ||
マスクの scaleX プロパティと scaleY プロパティがエフェクトによって更新されるときに呼び出されるコールバックメソッドを表します。 | MaskEffectInstance | ||
プロパティの詳細
createMaskFunction | プロパティ |
createMaskFunction:Function| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトによってマスクが作成される際に呼び出される関数を表します。 デフォルト値は、エフェクトターゲットと同じサイズの矩形を返す関数です。
このプロパティを使用して、マスクを描画する独自のコールバック関数を指定できます。 この関数には次のシグネチャが必要です。
public function createLargeMask(targ:Object, bounds:Rectangle):Shape {
var myMask:Shape = new Shape();
// Create mask.
return myMask;
}
このプロパティは、関数の名前に設定します。WipeLeft エフェクトの場合の例を以下に示します。
<mx:WipeLeft id="showWL" createMaskFunction="createLargeMask" showTarget="false"/>
実装
public function get createMaskFunction():Function public function set createMaskFunction(value:Function):voideffectMask | プロパティ |
protected var effectMask:Shape| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
defaultCreateMask() メソッドによって作成されたデフォルトマスク、または createMaskFunction プロパティに渡された関数で指定されたマスクのいずれかのエフェクトマスクが含まれます。
moveEasingFunction | プロパティ |
public var moveEasingFunction:Function| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクを移動させるのに使用するイージング関数を表します。
scaleEasingFunction | プロパティ |
public var scaleEasingFunction:Function| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの伸縮に使用するイージング関数を表します。
scaleXFrom | プロパティ |
public var scaleXFrom:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの初期 scaleX を表します。
scaleXTo | プロパティ |
public var scaleXTo:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの終了 scaleX を表します。
scaleYFrom | プロパティ |
public var scaleYFrom:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの初期 scaleY を表します。
scaleYTo | プロパティ |
public var scaleYTo:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの終了 scaleY を表します。
showTarget | プロパティ |
targetArea | プロパティ |
public var targetArea:Rectangle| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ターゲットでマスクが適用される領域を表します。 サイズはターゲット自体のサイズに対応します。 デフォルトでは、この領域はターゲット全体であり、new Rectangle(0, 0, target.width, target.height); のように作成されます。
targetVisualBounds | プロパティ |
protected var targetVisualBounds:Rectangle| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトターゲットの実際のサイズです。サイズにはドロップシャドウも含まれます。 このプロパティの値は Flex によって計算されるため、この値を設定する必要はありません。
xFrom | プロパティ |
public var xFrom:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの初期位置の x 座標を表します。
xTo | プロパティ |
public var xTo:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの移動先の位置の x 座標を表します。
yFrom | プロパティ |
public var yFrom:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの初期位置の y 座標を表します。
yTo | プロパティ |
public var yTo:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの移動先の位置の y 座標を表します。
コンストラクターの詳細
MaskEffectInstance | () | コンストラクター |
メソッドの詳細
defaultCreateMask | () | メソッド |
protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shape| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトのデフォルトマスクを作成します。
パラメーター
targ:Object — エフェクトターゲットを表します。
| |
bounds:Rectangle — ターゲットの実際の視覚的境界です。これにはドロップシャドウも含まれます。
|
Shape — マスクを定義する Shape オブジェクトです。
|
initMaskEffect | () | メソッド |
protected function initMaskEffect():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの move プロパティと scale プロパティを初期化します。 すべてのサブクラスで、この関数をオーバーライドする必要があります。 これは、マスクが作成された後、トゥイーンの作成前に呼び出されます。
onMoveTweenEnd | () | メソッド |
protected function onMoveTweenEnd(value:Object):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの x 位置と y 位置がエフェクトによって最終的に更新されるときに呼び出されるコールバックメソッドを表します。 このメソッドは直接呼び出さないでください。 このメソッドは、スーパークラスのメソッドを実装します。
パラメーター
value:Object — マスク位置の最終的な x 値と y 値が含まれます。value[0] にマスクの x 位置が含まれ、value[1] に y 位置が含まれます。
|
onMoveTweenUpdate | () | メソッド |
protected function onMoveTweenUpdate(value:Object):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの x 位置と y 位置がエフェクトによって更新されるときに呼び出されるコールバックメソッドを表します。 このメソッドは直接呼び出さないでください。 このメソッドは、スーパークラスのメソッドを実装します。
パラメーター
value:Object — マスク位置の補間された x 値と y 値が含まれます。value[0] にマスクの新しい x 位置が含まれ、value[1] に新しい y 位置が含まれます。
|
onScaleTweenEnd | () | メソッド |
protected function onScaleTweenEnd(value:Object):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの scaleX プロパティと scaleY プロパティがエフェクトによって最終的に更新されるときに呼び出されるコールバックメソッドを表します。 このメソッドは直接呼び出さないでください。 このメソッドは、スーパークラスのメソッドを実装します。
パラメーター
value:Object — マスクの最終的な scaleX 値と scaleY 値が含まれます。value[0] にマスクの scaleX 値が含まれ、value[1] に scaleY 値が含まれます。
|
onScaleTweenUpdate | () | メソッド |
protected function onScaleTweenUpdate(value:Object):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの scaleX プロパティと scaleY プロパティがエフェクトによって更新されるときに呼び出されるコールバックメソッドを表します。 このメソッドは直接呼び出さないでください。 このメソッドは、スーパークラスのメソッドを実装します。
パラメーター
value:Object — マスクの補間された scaleX 値と scaleY 値が含まれます。value[0] にマスクの新しい scaleX 値が含まれ、value[1] に新しい scaleY 値が含まれます。
|
pause | () | メソッド |
override public function pause():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
resume | () | メソッド |
override public function resume():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
pause() メソッドを呼び出してエフェクトを一時停止した後、再開させます。
reverse | () | メソッド |
override public function reverse():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
Tue Jun 12 2018, 10:34 AM Z