パッケージ | mx.effects |
クラス | public class MaskEffect |
継承 | MaskEffect Effect EventDispatcher Object |
サブクラス | Iris, WipeDown, WipeLeft, WipeRight, WipeUp |
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクエフェクトでは、マスクと呼ばれるオーバーレイによってエフェクトが実行されます。 デフォルトでは、マスクはターゲットコンポーネントと同じサイズの矩形です。
マスクエフェクトでは、エフェクト適用前または適用後のターゲットコンポーネントの状態を不可視にする必要があります。 つまり、マスクエフェクトを適用すると、ターゲットコンポーネントが常に画面上に表示されるか、非表示になります。
マスクの初期倍率と最終倍率は、scaleXFrom
、scaleYFrom
、scaleXTo
、scaleX
の各プロパティを使用して指定します。たとえば、1.0 を指定するとマスクのサイズはターゲットコンポーネントと同じになります。2.0 を指定するとマスクのサイズはコンポーネントの 2 倍になります。0.5 を指定するとマスクのサイズはコンポーネントの半分になります。 4 つのプロパティすべてを指定すると、どのプロパティも使用できるようになります。
ターゲットコンポーネントに対するマスクの初期相対位置と最終相対位置の座標は、xFrom
、yFrom
、xTo
、yTo
の各プロパティを使用して指定します。(0, 0)はターゲットの左上隅を表します。 4 つのプロパティすべてを指定すると、どのプロパティも使用できるようになります。
マスクの初期位置と最終位置の座標は、エフェクトの種類と、show
プロパティの値が true
と false
のどちらであるかによって異なります。 たとえば、WipeLeft エフェクトで show
の値が false
に設定されている場合、マスクの初期位置の座標は(0, 0)、つまりターゲットの左上隅になります。また、最終位置の座標はターゲットの右上の隅、つまり(ターゲットの幅, 0)になります。
WipeLeft エフェクトで show
の値が true
に設定されている場合、マスクの初期位置は(ターゲットの幅, 0)で、最終位置は(0, 0)になります。
The MaskEffect class defines the following properties, which all of its subclasses inherit:
<mx:tagname createMaskFunction="" moveEasingFunction="" scaleEasingFunction="" scaleXFrom="" scaleXTo="" scaleYFrom="" scaleYTo="" show="true|false" xFrom="" xTo="" yFrom="" yTo="" />
さらに例を参照
関連する API エレメント
プロパティ | 定義元 | ||
---|---|---|---|
className : String [読み取り専用]
このエフェクトクラスの名前です。たとえば、"Fade" などがあります。 | Effect | ||
constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | ||
createMaskFunction : Function
エフェクトによってマスクが作成される際に呼び出される関数を表します。 | MaskEffect | ||
customFilter : mx.effects:EffectTargetFilter
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルターオブジェクトを指定します。 | Effect | ||
duration : Number
エフェクトの継続時間を表します(ミリ秒単位)。 | Effect | ||
effectTargetHost : mx.effects:IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。 | Effect | ||
filter : String
エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。 | Effect | ||
hideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。 | Effect | ||
instanceClass : Class
このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。 | Effect | ||
isPlaying : Boolean [読み取り専用]
エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。 | Effect | ||
moveEasingFunction : Function
マスクを移動させるのに使用するイージング関数を表します。 | MaskEffect | ||
perElementOffset : Number
エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延(ミリ秒)です。 | Effect | ||
playheadTime : Number
エフェクトの現在の時間位置です。 | Effect | ||
relevantProperties : Array
フィルタリング実行時に使用するプロパティ名の配列を表します。 | Effect | ||
relevantStyles : Array
フィルタリング実行時に使用するスタイル名の配列を表します。 | Effect | ||
repeatCount : int = 1
エフェクトを繰り返す回数を表します。 | Effect | ||
repeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します(ミリ秒単位)。 | Effect | ||
scaleEasingFunction : Function
マスクの伸縮に使用するイージング関数を表します。 | MaskEffect | ||
scaleXFrom : Number
マスクの初期 scaleX を表します。 | MaskEffect | ||
scaleXTo : Number
マスクの終了 scaleX を表します。 | MaskEffect | ||
scaleYFrom : Number
マスクの初期 scaleY を表します。 | MaskEffect | ||
scaleYTo : Number
マスクの終了 scaleY を表します。 | MaskEffect | ||
showTarget : Boolean
ターゲットコンポーネントを可視にする場合は true に設定し、不可視にする場合は false に設定します。 | MaskEffect | ||
startDelay : int = 0
エフェクトを開始する前の待機時間を表します(ミリ秒単位)。 | Effect | ||
suspendBackgroundProcessing : Boolean = false
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。 | Effect | ||
target : Object
このエフェクトが適用されるオブジェクトを表します。 | Effect | ||
targets : Array
エフェクトのターゲットであるオブジェクトの配列を表します。 | Effect | ||
triggerEvent : Event
エフェクトがトリガーされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。 | Effect | ||
xFrom : Number
マスクの初期位置の x 座標を表します。 | MaskEffect | ||
xTo : Number
マスクの移動先の位置の x 座標を表します。 | MaskEffect | ||
yFrom : Number
マスクの初期位置の y 座標を表します。 | MaskEffect | ||
yTo : Number
マスクの移動先の位置の y 座標を表します。 | MaskEffect |
メソッド | 定義元 | ||
---|---|---|---|
MaskEffect(target:Object = null)
コンストラクターです。 | MaskEffect | ||
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 | ||
[オーバーライド]
このエフェクトによって変更されたコンポーネントプロパティを返します。 | MaskEffect | ||
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
resume() メソッドを呼び出すまで、エフェクトを一時停止します。 | Effect | ||
エフェクトの再生を開始します。 | Effect | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | ||
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。 | Effect | ||
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。 | Effect | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。 | Effect | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのプリミティブな値を返します。 | Object | ||
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher |
メソッド | 定義元 | ||
---|---|---|---|
エフェクトインフラストラクチャによって内部的に使用されます。 | Effect | ||
エフェクトインスタンスの再生終了時に呼び出されます。 | Effect | ||
このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。 | Effect | ||
エフェクトインスタンスが stop() メソッドの呼び出しによって停止されると呼び出されます。 | Effect | ||
エフェクトインスタンスをフィルタリングするために必要なロジックを決定します。 | Effect | ||
ターゲットからプロパティの値を取得するために captureStartValues() メソッドによって呼び出されます。 | Effect | ||
エフェクトインスタンスにエフェクトのプロパティをコピーします。 | Effect | ||
TweenEffect から TweenEvent が送出されたときに呼び出されます。 | MaskEffect |
イベント | 概要 | 定義元 | ||
---|---|---|---|---|
[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。 | EventDispatcher | |||
[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。 | EventDispatcher | |||
エフェクトのインスタンスの 1 つが再生を停止したとき(インスタンスの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき)に送出されます。 | Effect | |||
エフェクトの再生開始時に送出されます。 | Effect | |||
エフェクトが停止されると送出されます。これが発生するのは、stop() メソッドの呼び出しによってエフェクトが中断された場合のみです。 | Effect | |||
エフェクトの終了時に送出されます。 | MaskEffect | |||
エフェクトの開始時に送出されます。これは onMoveTweenUpdate() および onScaleTweenUpdate() メソッドの最初の呼び出しに対応します。 | MaskEffect | |||
エフェクトでターゲットが更新されるたびに送出されます。 | MaskEffect |
createMaskFunction | プロパティ |
public var 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 FlexShape(); // Create mask. return myMask; }
カスタムマスク関数は、エフェクトのターゲットコンポーネントに対応する引数を受け取ります。次に、ターゲットのサイズを定義する引数を受け取るため、正確にマスクのサイズを設定できます。 この引数を使用して、width
や height
などのターゲットコンポーネントのプロパティにアクセスすることができます。このため、正しいサイズのマスクを作成できます。
関数により、マスクを定義する 1 つの Shape オブジェクトが返されます。
moveEasingFunction | プロパティ |
public var moveEasingFunction:Function
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクを移動させるのに使用するイージング関数を表します。
デフォルト値: null。
scaleEasingFunction | プロパティ |
public var scaleEasingFunction:Function
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの伸縮に使用するイージング関数を表します。
デフォルト値: null。
scaleXFrom | プロパティ |
public var scaleXFrom:Number
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの初期 scaleX を表します。
このプロパティを指定するには、scaleXFrom
、scaleYFrom
、scaleXTo
およびscaleX
の 4 つのプロパティをすべて指定する必要があります。
scaleXTo | プロパティ |
public var scaleXTo:Number
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの終了 scaleX を表します。
このプロパティを指定するには、scaleXFrom
、scaleYFrom
、scaleXTo
およびscaleX
の 4 つのプロパティをすべて指定する必要があります。
scaleYFrom | プロパティ |
public var scaleYFrom:Number
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの初期 scaleY を表します。
このプロパティを指定するには、scaleXFrom
、scaleYFrom
、scaleXTo
およびscaleX
の 4 つのプロパティをすべて指定する必要があります。
scaleYTo | プロパティ |
public var scaleYTo:Number
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの終了 scaleY を表します。
このプロパティを指定するには、scaleXFrom
、scaleYFrom
、scaleXTo
およびscaleX
の 4 つのプロパティをすべて指定する必要があります。
showTarget | プロパティ |
showTarget:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ターゲットコンポーネントを可視にする場合は true
に設定し、不可視にする場合は false
に設定します。 このエフェクトを showEffect
または hideEffect
トリガーで使用するよう指定した場合、showTarget
プロパティが Flex により有効になります。コンポーネントが可視の場合は true
に、不可視の場合は false
に設定されます。 このエフェクトを異なるエフェクトトリガーで使用する場合は、startEffect
イベントのイベントリスナー内でこのエフェクトを設定する必要がある場合があります。
デフォルト値: true。
実装
public function get showTarget():Boolean
public function set showTarget(value:Boolean):void
xFrom | プロパティ |
public var xFrom:Number
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの初期位置の x 座標を表します。
このプロパティを指定するには、xFrom
、yFrom
、xTo
および yTo
の 4 つのプロパティをすべて指定する必要があります。
xTo | プロパティ |
public var xTo:Number
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの移動先の位置の x 座標を表します。
このプロパティを指定するには、xFrom
、yFrom
、xTo
および yTo
の 4 つのプロパティをすべて指定する必要があります。
yFrom | プロパティ |
public var yFrom:Number
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの初期位置の y 座標を表します。
このプロパティを指定するには、xFrom
、yFrom
、xTo
および yTo
の 4 つのプロパティをすべて指定する必要があります。
yTo | プロパティ |
public var yTo:Number
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マスクの移動先の位置の y 座標を表します。
このプロパティを指定するには、xFrom
、yFrom
、xTo
および yTo
の 4 つのプロパティをすべて指定する必要があります。
MaskEffect | () | コンストラクター |
getAffectedProperties | () | メソッド |
override public function getAffectedProperties():Array
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このエフェクトによって変更されたコンポーネントプロパティを返します。 このメソッドは、[ "visible", "width", "height" ]
を含む配列を返します。 WipeDown、WipeLeft、WipeRight、および WipeDown のすべてのエフェクトサブクラスが同一のプロパティを変更するため、これらのクラスではこのメソッドを実装しません。
MaskEffect をサブクラス化してカスタムエフェクトを作成し、ターゲットの別のプロパティ一式を変更する場合は、このメソッドをオーバーライドして、サブクラスで変更されたプロパティリストを含む配列を返す必要があります。
戻り値Array — このエフェクトで変更されたプロパティの名前を指定するストリングの配列を表します。
|
関連する API エレメント
tweenEventHandler | () | メソッド |
protected function tweenEventHandler(event:mx.events:TweenEvent):void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
TweenEffect から TweenEvent が送出されたときに呼び出されます。 このメソッドをオーバーライドする場合、必ずスーパーメソッドを呼び出すようにしてください。
パラメーター
event:mx.events:TweenEvent — TweenEvent 型のイベントオブジェクトを表します。
|
tweenEnd | イベント |
mx.events.TweenEvent
プロパティ TweenEvent.type =
mx.events.TweenEvent.TWEEN_END
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの終了時に送出されます。
エフェクトが 1 度だけ再生された場合、このイベントは effectEnd
イベントと同時に発生します。 エフェクトを繰り返し再生させる場合、このイベントはエフェクトが繰り返されるたびに発生し、最後のエフェクトの再生後に endEffect
イベントが発生します。
TweenEvent.TWEEN_END
定数により、イベントオブジェクトの type
プロパティ値が tweenEnd
イベント用に定義されます。
イベントオブジェクトの各プロパティには次の値が設定されています。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
value | onTweenEnd() メソッドに渡された値です。 |
tweenStart | イベント |
mx.events.TweenEvent
プロパティ TweenEvent.type =
mx.events.TweenEvent.TWEEN_START
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの開始時に送出されます。これは onMoveTweenUpdate()
および onScaleTweenUpdate()
メソッドの最初の呼び出しに対応します。 同時に、Flex によって、エフェクトの最初の tweenUpdate
イベントも送出されます。
Effect.effectStart
イベントは tweenStart
イベントの前に送出されます。
TweenEvent.TWEEN_START
定数により、イベントオブジェクトの type
プロパティ値が tweenStart
イベント用に定義されます。
イベントオブジェクトの各プロパティには次の値が設定されています。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
value | onTweenUpdate() メソッドに渡された値です。 |
tweenUpdate | イベント |
mx.events.TweenEvent
プロパティ TweenEvent.type =
mx.events.TweenEvent.TWEEN_UPDATE
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Flex 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトでターゲットが更新されるたびに送出されます。 このイベントの送出は、onMoveTweenUpdate()
および onScaleTweenUpdate()
メソッドの呼び出しに対応します。
TweenEvent.TWEEN_UPDATE
定数により、イベントオブジェクトの type
プロパティ値が tweenUpdate
イベント用に定義されます。
イベントオブジェクトの各プロパティには次の値が設定されています。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
value | onTweenUpdate() メソッドに渡された値です。 |
Tue Jun 12 2018, 10:34 AM Z