パッケージmx.effects.effectClasses
クラスpublic class MaskEffectInstance
継承MaskEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object
サブクラス IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance

MaskEffectInstance クラスは、MaskEffect クラスのインスタンスクラスを実装する抽象基本クラスです。

TweenEffect クラスのサブクラスであるすべてのエフェクトクラスは、以下のイベントをサポートします。

これらのイベントのイベントリスナーに渡されるイベントオブジェクトのタイプは TweenEvent です。 TweenEvent クラスは、エフェクトで計算されたトゥイーン値を含む value プロパティを定義します。 Mask エフェクトの場合、TweenEvent.value プロパティには以下の 4 個のアイテムを持つ配列が含まれます。

関連項目

mx.effects.MaskEffect
mx.events.TweenEvent


パブリックプロパティ
 プロパティ定義元
 InheritedclassName : String
[読み取り専用] このエフェクトクラスの名前です。たとえば、"FadeInstance" などがあります。
EffectInstance
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  createMaskFunction : Function
エフェクトによってマスクが作成されるときに呼び出される関数を表します。
MaskEffectInstance
 Inheritedduration : Number
エフェクトの持続時間を表します(ミリ秒単位)。
EffectInstance
 Inheritedeffect : IEffect
この IEffectInstance オブジェクトを作成した IEffect オブジェクトを表します。
EffectInstance
 InheritedeffectTargetHost : IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。
EffectInstance
 InheritedhideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカスリングを非表示にするかどうかを指定します。
EffectInstance
  moveEasingFunction : Function
マスクの移動に使用するイージング関数を表します。
MaskEffectInstance
 InheritedplayheadTime : Number
[読み取り専用] エフェクト再生中の現在位置を表します。
EffectInstance
 InheritedpropertyChanges : PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。
EffectInstance
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 InheritedrepeatCount : int
エフェクトを繰り返す回数を表します。
EffectInstance
 InheritedrepeatDelay : 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
 InheritedstartDelay : int
エフェクトを開始する前の待機時間を表します(ミリ秒単位)。
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
EffectInstance
 Inheritedtarget : Object
このエフェクトが適用される UIComponent オブジェクトを表します。
EffectInstance
  targetArea : Rectangle
ターゲットでマスクが適用される領域を表します。
MaskEffectInstance
 InheritedtriggerEvent : 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
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。
EffectInstance
 Inherited
エフェクトの再生が完了すると、end() メソッドによって呼び出されます。
EffectInstance
 Inherited
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。
EffectInstance
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
このメソッドは、エフェクトが EffectManager によってトリガされると呼び出されます。
EffectInstance
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
[override] resume() メソッドを呼び出すまで、エフェクトを一時停止します。
MaskEffectInstance
 Inherited
ターゲットでエフェクトインスタンスを再生します。
EffectInstance
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  
[override] pause() メソッドを呼び出してエフェクトを一時停止した後、再開させます。
MaskEffectInstance
  
[override] エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
MaskEffectInstance
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。
EffectInstance
 Inherited
ターゲットを現在の状態にしたまま、エフェクトを停止します。
EffectInstance
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
  
エフェクトのデフォルトマスクを作成します。
MaskEffectInstance
  
エフェクトの move プロパティと scale プロパティを初期化します。
MaskEffectInstance
  
マスクの x 位置と y 位置がエフェクトによって最終的に更新されるときに呼び出されるコールバックメソッドを表します。
MaskEffectInstance
  
マスクの x 位置と y 位置がエフェクトによって更新されるときに呼び出されるコールバックメソッドを表します。
MaskEffectInstance
  
マスクの scaleX プロパティと scaleY プロパティがエフェクトによって最終的に更新されるときに呼び出されるコールバックメソッドを表します。
MaskEffectInstance
  
マスクの scaleX プロパティと scaleY プロパティがエフェクトによって更新されるときに呼び出されるコールバックメソッドを表します。
MaskEffectInstance
イベント
 イベント 概要 定義元
 Inherited[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
プロパティの詳細
createMaskFunctionプロパティ
createMaskFunction:Function

エフェクトによってマスクが作成されるときに呼び出される関数を表します。 デフォルト値は、エフェクトターゲットと同じサイズの矩形を返す関数です。

このプロパティを使用して、マスクを描画する独自のコールバック関数を指定できます。 この関数には次のシグネチャが必要です。

   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):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

ターゲットコンポーネントを可視にする場合は 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 function 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()メソッド 
override public function pause():void

resume() メソッドを呼び出すまで、エフェクトを一時停止します。

resume()メソッド 
override public function resume():void

pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。

reverse()メソッド 
override public function reverse():void

エフェクトの現在位置から開始して、逆順でエフェクトを再生します。





 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/effects/effectClasses/MaskEffectInstance.html