Function called when the effect creates the mask. The default value is a function that returns a Rectangle with the same dimensions as the target.

The custom mask function has the following signature:

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

Your custom mask function takes an argument corresponding to the target component of the effect, and a second argument that defines the dimensions of the target so that you can correctly size the mask. You use that argument to access properties of the target component, such as width and height, so that you can create a mask with the correct size.

The function returns a single Shape object that defines the mask.

Easing function to use for moving the mask.

The default value is null.

Easing function to use for scaling the mask.

The default value is null.

Initial scaleX for mask.

To specify this property, you must specify all four of these properties: scaleXFrom, scaleYFrom, scaleXTo, and scaleX.

Ending scaleX for mask.

To specify this property, you must specify all four of these properties: scaleXFrom, scaleYFrom, scaleXTo, and scaleX.

Initial scaleY for mask.

To specify this property, you must specify all four of these properties: scaleXFrom, scaleYFrom, scaleXTo, and scaleX.

Ending scaleY for mask.

To specify this property, you must specify all four of these properties: scaleXFrom, scaleYFrom, scaleXTo, and scaleX.

Specifies that the target component is becoming visible, true, or invisible, false. If you specify this effect for a showEffect or hideEffect trigger, Flex sets the showTarget property for you, either to true if the component becomes visible, or false if the component becomes invisible. If you use this effect with a different effect trigger, you should set it yourself, often within the event listener for the startEffect event.

The default value is true.

Initial position's x coordinate for mask.

To specify this property, you must specify all four of these properties: xFrom, yFrom, xTo, and yTo.

Destination position's x coordinate for mask.

To specify this property, you must specify all four of these properties: xFrom, yFrom, xTo, and yTo.

Initial position's y coordinate for mask.

To specify this property, you must specify all four of these properties: xFrom, yFrom, xTo, and yTo.

Destination position's y coordinate for mask.

To specify this property, you must specify all four of these properties: xFrom, yFrom, xTo, and yTo.

Constructor.

Returns the component properties modified by this effect. This method returns an Array containing: [ "visible", "width", "height" ]. Since the WipeDown, WipeLeft, WipeRight, and WipeDown effect subclasses all modify these same properties, those classes do not implement this method.

If you subclass the MaskEffect class to create a custom effect, and it modifies a different set of properties on the target, you must override this method and return an Array containing a list of the properties modified by your subclass.

See also

Called when the TweenEffect dispatches a TweenEvent. If you override this method, ensure that you call the super method.

Parameters

Dispatched when the effect ends.

When an effect plays a single time, this event occurs at the same time as an effectEnd event. If you configure the effect to repeat, it occurs at the end of every repetition of the effect, and the endEffect event occurs after the effect plays for the final time.

The properties of the event object have the following values:

Dispatched when the effect starts, which corresponds to the first call to the onMoveTweenUpdate() and onScaleTweenUpdate() methods. Flex also dispatches the first tweenUpdate event for the effect at the same time.

The Effect.effectStart event is dispatched before the tweenStart event.

The properties of the event object have the following values:

Dispatched every time the effect updates the target. The dispatching of this event corresponds to the calls to the onMoveTweenUpdate() and onScaleTweenUpdate() methods.

The properties of the event object have the following values: