| パッケージ | mx.effects.effectClasses |
| public class MaskEffectInstance | |
| 継承 | MaskEffectInstance  EffectInstance EventDispatcher Object |
| Subclasses | IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance |
TweenEffect クラスのサブクラスであるすべてのエフェクトクラスは、以下のイベントをサポートします。
tweenEnd: トゥーンエフェクトの終了時に送出されます。 tweenUpdate: TweenEffect クラスで新しい値が計算されるたびに送出されます。これらのイベントのイベントリスナーに渡されるイベントオブジェクトのタイプは TweenEvent です。TweenEvent クラスは、エフェクトで計算されたトゥイーン値を含む value プロパティを定義します。Mask エフェクトの場合、TweenEvent.value プロパティには以下の 4 個のアイテムを持つ配列が含まれます。
x プロパティの値。y プロパティの値。scaleX プロパティの値。scaleY プロパティの値。関連項目
| プロパティ | 定義 | ||
|---|---|---|---|
 | className : String
このエフェクトクラスの名前です。たとえば、
"FadeInstance" などがあります。 | EffectInstance | |
| constructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
| Object | |
| createMaskFunction : Function
エフェクトによってマスクが作成される際に呼び出される関数を表します。
| MaskEffectInstance | ||
| duration : Number
エフェクトの継続時間を表します (ミリ秒単位)。
| EffectInstance | |
| effect : Effect
この EffectInstance オブジェクトを作成した Effect オブジェクトを表します。
| EffectInstance | |
| moveEasingFunction : Function
マスクを移動させるのに使用するイージング関数を表します。
| MaskEffectInstance | ||
| playheadTime : Number
エフェクト再生中の現在位置を表します。
| EffectInstance | |
| propertyChanges : PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。
| EffectInstance | |
| prototype : Object
[static]
クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
| Object | |
| repeatCount : int = 1
エフェクトを繰り返す回数を表します。
| EffectInstance | |
| repeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します (ミリ秒単位)。
| 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 = 0
エフェクトを開始する前の待機時間を表します (ミリ秒単位)。
| EffectInstance | |
| suspendBackgroundProcessing : Boolean = falsetrue の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。 | 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 | ||
| targetVisualBounds : Rectangle
エフェクトターゲットの実際のサイズ。サイズにはドロップシャドウも含まれます。
| MaskEffectInstance | ||
| メソッド | 定義 | ||
|---|---|---|---|
| MaskEffectInstance(target:Object)
コンストラクタ。
| MaskEffectInstance | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
| EventDispatcher | |
| dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
| EventDispatcher | |
| end():void
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。
| EffectInstance | |
| finishEffect():void
エフェクトの再生が完了すると、
end() メソッドによって呼び出されます。 | EffectInstance | |
| finishRepeat():void
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。
| EffectInstance | |
| hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
| EventDispatcher | |
| hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
| Object | |
| initEffect(event:Event):void
このメソッドは、エフェクトが EffectManager によってトリガされると、呼び出されます。
| EffectInstance | |
| isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
| Object | |
pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。 | MaskEffectInstance | ||
| play():void
ターゲットでエフェクトインスタンスを再生します。
| EffectInstance | |
| propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
| Object | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
| EventDispatcher | |
resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。 | MaskEffectInstance | ||
| reverse():void
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
| MaskEffectInstance | ||
| setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
| Object | |
| startEffect():void
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。 | EffectInstance | |
| toString():String
指定されたオブジェクトのストリング表現を返します。
| Object | |
| valueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
| Object | |
| willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
| EventDispatcher | |
| メソッド | 定義 | ||
|---|---|---|---|
| defaultCreateMask(targ:Object, bounds:Rectangle):Shape
エフェクトのデフォルトマスクを作成します。
| MaskEffectInstance | ||
| initMaskEffect():void
エフェクトの
move プロパティおよび scale プロパティを初期化します。 | MaskEffectInstance | ||
| onMoveTweenEnd(value:Object):void
マスクの x 位置および y 位置がエフェクトによって最終的に更新される際に呼び出されるコールバックメソッドを表します。
| MaskEffectInstance | ||
| onMoveTweenUpdate(value:Object):void
マスクの x 位置および y 位置がエフェクトによって更新される際に呼び出されるコールバックメソッドを表します。
| MaskEffectInstance | ||
| onScaleTweenEnd(value:Object):void
マスクの
scaleX プロパティおよび scaleY プロパティがエフェクトによって最終的に更新される際に呼び出されるコールバックメソッドを表します。 | MaskEffectInstance | ||
| onScaleTweenUpdate(value:Object):void
マスクの
scaleX プロパティおよび scaleY プロパティがエフェクトによって更新される際に呼び出されるコールバックメソッドを表します。 | MaskEffectInstance | ||
| createMaskFunction | プロパティ |
継承されるパブリックプロパティの非表示
継承されるパブリックプロパティの表示createMaskFunction:Function [read-write]エフェクトによってマスクが作成される際に呼び出される関数を表します。デフォルト値は、エフェクトターゲットと同じサイズの矩形を返す関数です。
このプロパティを使用して、マスクを描画する独自のコールバック関数を指定できます。この関数には次のシグネチャが必要です。
public function createLargeMask(targ:Object, bounds:Rectangle):Shape {
var myMask:Shape = new Shape();
// マスクを作成する。
return myMask;
}
このプロパティは、関数の名前に設定します。以下に、WipeLeft エフェクトの場合の例を示します。
<mx:WipeLeft id="showWL" createMaskFunction="createLargeMask" showTarget="false"/>実装
public function get createMaskFunction():Function
public function set createMaskFunction(value:Function):void
| effectMask | プロパティ |
protected var effectMask:Shape
defaultCreateMask() メソッドで作成されたデフォルトマスク、または createMaskFunction プロパティに渡された関数によって指定されたマスクのいずれかのマスクエフェクトが含まれます。
| moveEasingFunction | プロパティ |
public var moveEasingFunction:Functionマスクを移動させるのに使用するイージング関数を表します。
| scaleEasingFunction | プロパティ |
public var scaleEasingFunction:Functionマスクを伸縮させるのに使用するイージング関数を表します。
| scaleXFrom | プロパティ |
public var scaleXFrom:Numberマスクの初期 scaleX を表します。
| scaleXTo | プロパティ |
public var scaleXTo:Numberマスクの終了 scaleX を表します。
| scaleYFrom | プロパティ |
public var scaleYFrom:Numberマスクの初期 scaleY を表します。
| scaleYTo | プロパティ |
public var scaleYTo:Numberマスクの終了 scaleY を表します。
| showTarget | プロパティ |
showTarget:Boolean [read-write]
ターゲットコンポーネントを見えるようにする場合は false に設定し、見えなくなるようにする場合は true に設定します。
デフォルト値true.
public function get showTarget():Boolean
public function set showTarget(value:Boolean):void
| targetArea | プロパティ |
public var targetArea:Rectangle
マスクがターゲットで適用される領域を表します。サイズはターゲットそのもののサイズに対応します。デフォルトでは、領域はターゲット全体で、次のように作成されます。 new Rectangle(0, 0, target.width, target.height);
| targetVisualBounds | プロパティ |
protected var targetVisualBounds:Rectangleエフェクトターゲットの実際のサイズ。サイズにはドロップシャドウも含まれます。このプロパティの値は Flex によって計算されるため、この値を設定する必要はありません。
| xFrom | プロパティ |
public var xFrom:Numberマスクの初期位置の x 座標を表します。
| xTo | プロパティ |
public var xTo:Numberマスクの移動先の位置の x 座標を表します。
| yFrom | プロパティ |
public var yFrom:Numberマスクの初期位置の y 座標を表します。
| yTo | プロパティ |
public var yTo:Numberマスクの移動先の位置の y 座標を表します。
| MaskEffectInstance | () | コンストラクタ |
public 関数 MaskEffectInstance(target:Object)コンストラクタ。
パラメータtarget:Object — このエフェクトでアニメーション化するオブジェクトを表します。
|
| defaultCreateMask | () | メソッド |
protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shapeエフェクトのデフォルトマスクを作成します。
パラメータtarg:Object — エフェクトターゲットを表します。
|
|
bounds:Rectangle — ターゲットの実際の可視の視覚的境界。これにはドロップシャドウも含まれます。
|
Shape —
マスクを定義する Shape オブジェクトです。
|
| initMaskEffect | () | メソッド |
protected function initMaskEffect():void
エフェクトの move プロパティおよび scale プロパティを初期化します。すべてのサブクラスではこの関数を必ずオーバーライドする必要があります。これは、マスクの作成後で、トゥイーンの作成前に呼び出されます。
| onMoveTweenEnd | () | メソッド |
protected function onMoveTweenEnd(value:Object):voidマスクの x 位置および y 位置がエフェクトによって最終的に更新される際に呼び出されるコールバックメソッドを表します。このメソッドは直接呼び出さないでください。このメソッドによって、スーパークラスのメソッドが実装されます。
パラメータvalue:Object — マスク位置の最終 x および y 値が含まれます。このとき、value[0] にはマスクの x 位置が含まれ、value[1] には y 位置が含まれています。
|
| onMoveTweenUpdate | () | メソッド |
protected function onMoveTweenUpdate(value:Object):voidマスクの x 位置および y 位置がエフェクトによって更新される際に呼び出されるコールバックメソッドを表します。このメソッドは直接呼び出さないでください。このメソッドによって、スーパークラスのメソッドが実装されます。
パラメータvalue:Object — マスク位置の補間 x および y 値が含まれます。このとき、value[0] にはマスクの新しい x 位置が含まれ、value[1] には新しい y 位置が含まれています。
|
| onScaleTweenEnd | () | メソッド |
protected function onScaleTweenEnd(value:Object):void
マスクの scaleX プロパティおよび scaleY プロパティがエフェクトによって最終的に更新される際に呼び出されるコールバックメソッドを表します。このメソッドは直接呼び出さないでください。このメソッドによって、スーパークラスのメソッドが実装されます。
value:Object — マスクの最終 scaleX および scaleY 値が含まれます。このとき、value[0] にはマスクの scaleX 値が含まれ、value[1] には scaleY 値が含まれています。
|
| onScaleTweenUpdate | () | メソッド |
protected function onScaleTweenUpdate(value:Object):void
マスクの scaleX プロパティおよび scaleY プロパティがエフェクトによって更新される際に呼び出されるコールバックメソッドを表します。このメソッドは直接呼び出さないでください。このメソッドによって、スーパークラスのメソッドが実装されます。
value:Object — value マスクの補間 scaleX および scaleY 値が含まれます。このとき、value[0] にはマスクの新しい scaleX 値が含まれ、value[1] には新しい scaleY 値が含まれています。
|
| pause | () | メソッド |
public override function pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
| resume | () | メソッド |
public override function resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
| reverse | () | メソッド |
public override function reverse():voidエフェクトの現在位置から開始して、逆順でエフェクトを再生します。