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

カスタムマスク関数には、次のシグネチャがあります。

      public function createLargeMask(targ:Object, bounds:Rectangle):Shape
      {
          var myMask:Shape = new FlexShape();
               // Create mask.
               return myMask;
      }
      

カスタムマスク関数は、エフェクトのターゲットコンポーネントに対応する引数を受け取ります。次に、ターゲットのサイズを定義する引数を受け取るため、正確にマスクのサイズを設定できます。 この引数を使用して、width や height などのターゲットコンポーネントのプロパティにアクセスすることができます。このため、正しいサイズのマスクを作成できます。

関数により、マスクを定義する 1 つの Shape オブジェクトが返されます。

マスクの移動に使用するイージング関数を表します。

デフォルト値 : null.

マスクの伸縮に使用するイージング関数を表します。

デフォルト値 : null.

マスクの初期 scaleX を表します。

このプロパティを指定するには、scaleXFrom、scaleYFrom、scaleXTo、および scaleX の 4 つのプロパティをすべて指定する必要があります。

マスクの終了 scaleX を表します。

このプロパティを指定するには、scaleXFrom、scaleYFrom、scaleXTo、および scaleX の 4 つのプロパティをすべて指定する必要があります。

マスクの初期 scaleY を表します。

このプロパティを指定するには、scaleXFrom、scaleYFrom、scaleXTo、および scaleX の 4 つのプロパティをすべて指定する必要があります。

マスクの終了 scaleY を表します。

このプロパティを指定するには、scaleXFrom、scaleYFrom、scaleXTo、および scaleX の 4 つのプロパティをすべて指定する必要があります。

ターゲットコンポーネントを可視にする場合は true に設定し、不可視にする場合は false に設定します。 このエフェクトを showEffect または hideEffect トリガで使用するよう指定した場合、showTarget プロパティが Flex により有効になります。コンポーネントが可視の場合は true に、不可視の場合は false に設定されます。 このエフェクトを異なるエフェクトトリガで使用する場合は、startEffect イベントのイベントリスナー内でこのエフェクトを設定する必要がある場合があります。

デフォルト値 : true.

マスクの初期位置の x 座標を表します。

このプロパティを指定するには、xFrom、yFrom、xTo、および yTo の 4 つのプロパティをすべて指定する必要があります。

マスクの移動先の位置の x 座標を表します。

このプロパティを指定するには、xFrom、yFrom、xTo、および yTo の 4 つのプロパティをすべて指定する必要があります。

マスクの初期位置の y 座標を表します。

このプロパティを指定するには、xFrom、yFrom、xTo、および yTo の 4 つのプロパティをすべて指定する必要があります。

マスクの移動先の位置の y 座標を表します。

このプロパティを指定するには、xFrom、yFrom、xTo、および yTo の 4 つのプロパティをすべて指定する必要があります。

コンストラクタです。

このエフェクトによって変更されたコンポーネントプロパティを返します。 このメソッドで返される配列には、[ "visible", "width", "height" ] があります。WipeDown、WipeLeft、WipeRight、および WipeDown のすべてのエフェクトサブクラスが同一のプロパティを変更するため、これらのクラスではこのメソッドを実装しません。

MaskEffect をサブクラス化してカスタムエフェクトを作成し、ターゲットの別のプロパティ一式を変更する場合は、このメソッドをオーバーライドして、サブクラスで変更されたプロパティリストを含む配列を返す必要があります。

関連項目

TweenEffect から TweenEvent が送出されたときに呼び出されます。 このメソッドをオーバーライドする場合、必ずスーパーメソッドを呼び出すようにしてください。

パラメータ

エフェクトの終了時に送出されます。

エフェクトが 1 度だけ再生された場合、このイベントは effectEnd イベントと同時に発生します。 エフェクトを繰り返し再生させる場合、このイベントはエフェクトが繰り返されるたびに発生し、最後のエフェクトの再生後に endEffect イベントが発生します。

イベントオブジェクトの各プロパティには次の値が設定されています。

エフェクトの開始時に送出されます。これは onMoveTweenUpdate() および onScaleTweenUpdate() メソッドの最初の呼び出しに対応します。同時に、Flex によって、エフェクトの最初の tweenUpdate イベントも送出されます。

Effect.effectStart イベントは tweenStart イベントの前に送出されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

エフェクトでターゲットが更新されるたびに送出されます。 このイベントの送出は、onMoveTweenUpdate() および onScaleTweenUpdate() メソッドの呼び出しに対応します。

イベントオブジェクトの各プロパティには次の値が設定されています。