mx.effects.effectClasses

# MaskEffectInstance - AS3 Flex

Package | mx.effects.effectClasses
Class | public class MaskEffectInstance
Inheritance | MaskEffectInstance EffectInstance EventDispatcher Object
Subclasses | IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The MaskEffectInstance class is an abstract base class that implements the instance class for the MaskEffect class.

Every effect class that is a subclass of the TweenEffect class supports the following events:

- `tweenEnd`: Dispatched when the tween effect ends.
- `tweenUpdate`: Dispatched every time a TweenEffect class calculates a new value.

The event object passed to the event listener for these events is of type TweenEvent. The TweenEvent class defines the property `value`, which contains the tween value calculated by the effect. For the Mask effect, the `TweenEvent.value` property contains a 4-item Array, where:

- value[0]:Number The value of the target's `x` property.
- value[1]:Number The value of the target's `y` property.
- value[2]:Number The value of the target's `scaleX` property.
- value[3]:Number The value of the target's `scaleY` property.

Related API Elements

mx.effects.MaskEffect
mx.events.TweenEvent

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | className : String [read-only] The name of the effect class, such as "FadeInstance". | EffectInstance
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | createMaskFunction : Function Function called when the effect creates the mask. | MaskEffectInstance
|  | duration : Number The duration of the effect, in milliseconds. | EffectInstance
|  | effect : IEffect The IEffect object that created this IEffectInstance object. | EffectInstance
|  | effectTargetHost : mx.effects:IEffectTargetHost A property that lets you access the target list-based control of a data effect. | EffectInstance
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | EffectInstance
|  | moveEasingFunction : Function Easing function to use for moving the mask. | MaskEffectInstance
|  | playheadTime : Number Current time position of the effect. | EffectInstance
|  | propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets. | EffectInstance
|  | repeatCount : int Number of times to repeat the effect. | EffectInstance
|  | repeatDelay : int Amount of time, in milliseconds, to wait before repeating the effect. | EffectInstance
|  | scaleEasingFunction : Function Easing function to use for scaling the mask. | MaskEffectInstance
|  | scaleXFrom : Number Initial scaleX for mask. | MaskEffectInstance
|  | scaleXTo : Number Ending scaleX for mask. | MaskEffectInstance
|  | scaleYFrom : Number Initial scaleY for mask. | MaskEffectInstance
|  | scaleYTo : Number Ending scaleY for mask. | MaskEffectInstance
|  | showTarget : Boolean Specifies that the target component is becoming visible, false, or invisible, true. | MaskEffectInstance
|  | startDelay : int Amount of time, in milliseconds, to wait before starting the effect. | EffectInstance
|  | suspendBackgroundProcessing : Boolean If true, blocks all background processing while the effect is playing. | EffectInstance
|  | target : Object The UIComponent object to which this effect is applied. | EffectInstance
|  | targetArea : Rectangle The area where the mask is applied on the target. | MaskEffectInstance
|  | triggerEvent : Event The event, if any, which triggered the playing of the effect. | EffectInstance
|  | xFrom : Number Initial position's x coordinate for mask. | MaskEffectInstance
|  | xTo : Number Destination position's x coordinate for mask. | MaskEffectInstance
|  | yFrom : Number Initial position's y coordinate for mask. | MaskEffectInstance
|  | yTo : Number Destination position's y coordinate for mask. | MaskEffectInstance

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | effectMask : Shape Contains the effect mask, either the default mask created by the defaultCreateMask() method, or the one specified by the function passed to the createMaskFunction property. | MaskEffectInstance
|  | playCount : int = 0 Number of times that the instance has been played. | EffectInstance
|  | targetVisualBounds : Rectangle The actual size of the effect target, including any drop shadows. | MaskEffectInstance

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | MaskEffectInstance(target:Object) Constructor. | MaskEffectInstance
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | end():void Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect. | EffectInstance
|  | finishEffect():void Called by the end() method when the effect finishes playing. | EffectInstance
|  | finishRepeat():void Called after each iteration of a repeated effect finishes playing. | EffectInstance
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager. | EffectInstance
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | pause():void [override] Pauses the effect until you call the resume() method. | MaskEffectInstance
|  | play():void Plays the effect instance on the target. | EffectInstance
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | resume():void [override] Resumes the effect after it has been paused by a call to the pause() method. | MaskEffectInstance
|  | reverse():void [override] Plays the effect in reverse, starting from the current position of the effect. | MaskEffectInstance
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | startEffect():void Plays the effect instance on the target after the startDelay period has elapsed. | EffectInstance
|  | stop():void Stops the effect, leaving the target in its current state. | EffectInstance
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Protected Methods

| Method | Defined By
--- | --- | ---
|  | defaultCreateMask(targ:Object, bounds:Rectangle):Shape Creates the default mask for the effect. | MaskEffectInstance
|  | initMaskEffect():void Initializes the move and scale properties of the effect. | MaskEffectInstance
|  | onMoveTweenEnd(value:Object):void Callback method that is called when the x and y position of the mask should be updated by the effect for the last time. | MaskEffectInstance
|  | onMoveTweenUpdate(value:Object):void Callback method that is called when the x and y position of the mask should be updated by the effect. | MaskEffectInstance
|  | onScaleTweenEnd(value:Object):void Callback method that is called when the scaleX and scaleY properties of the mask should be updated by the effect for the last time. | MaskEffectInstance
|  | onScaleTweenUpdate(value:Object):void Callback method that is called when the scaleX and scaleY properties of the mask should be updated by the effect. | MaskEffectInstance

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher

Property Detail

### createMaskFunction

property

`createMaskFunction:Function`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

You can use this property to specify your own callback function to draw the mask. The function must have the following signature:

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

    	    return myMask;
    	  }

You set this property to the name of the function, as the following example shows for the WipeLeft effect:

    	    <mx:WipeLeft id="showWL" createMaskFunction="createLargeMask" showTarget="false"/>

Implementation
`public function get createMaskFunction():Function`
`public function set createMaskFunction(value:Function):void`

### effectMask

property

`protected var effectMask:Shape`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Contains the effect mask, either the default mask created by the `defaultCreateMask()` method, or the one specified by the function passed to the `createMaskFunction` property.

### moveEasingFunction

property

`public var moveEasingFunction:Function`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Easing function to use for moving the mask.

### scaleEasingFunction

property

`public var scaleEasingFunction:Function`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Easing function to use for scaling the mask.

### scaleXFrom

property

`public var scaleXFrom:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Initial scaleX for mask.

### scaleXTo

property

`public var scaleXTo:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Ending scaleX for mask.

### scaleYFrom

property

`public var scaleYFrom:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Initial scaleY for mask.

### scaleYTo

property

`public var scaleYTo:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Ending scaleY for mask.

### showTarget

property

`showTarget:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Specifies that the target component is becoming visible, `false`, or invisible, `true`.

The default value is `true.`

Implementation
`public function get showTarget():Boolean`
`public function set showTarget(value:Boolean):void`

### targetArea

property

`public var targetArea:Rectangle`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The area where the mask is applied on the target. The dimensions are relative to the target itself. By default, the area is the entire target and is created like this: `new Rectangle(0, 0, target.width, target.height);`

### targetVisualBounds

property

`protected var targetVisualBounds:Rectangle`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The actual size of the effect target, including any drop shadows. Flex calculates the value of this property; you do not have to set it.

### xFrom

property

`public var xFrom:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Initial position's x coordinate for mask.

### xTo

property

`public var xTo:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Destination position's x coordinate for mask.

### yFrom

property

`public var yFrom:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Initial position's y coordinate for mask.

### yTo

property

`public var yTo:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Destination position's y coordinate for mask.

Constructor Detail

### MaskEffectInstance

()
Constructor

`public function MaskEffectInstance(target:Object)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `target:Object` — The Object to animate with this effect.

Method Detail

### defaultCreateMask

()
method

`protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shape`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Creates the default mask for the effect.

Parameters

| `targ:Object` — The effect target.
| `bounds:Rectangle` — The actual visual bounds of the target which includes drop shadows

Returns

| `Shape` — A Shape object that defines the mask.

### initMaskEffect

()
method

`protected function initMaskEffect():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Initializes the `move` and `scale` properties of the effect. All subclasses should override this function. Flex calls it after the mask has been created, but before the tweens are created.

### onMoveTweenEnd

()
method

`protected function onMoveTweenEnd(value:Object):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Callback method that is called when the x and y position of the mask should be updated by the effect for the last time. You do not call this method directly. This method implements the method of the superclass.

Parameters

| `value:Object` — Contains the final x and y value for the mask position, where `value[0]` contains the x position of the mask, and `value[1]` contains the y position.

### onMoveTweenUpdate

()
method

`protected function onMoveTweenUpdate(value:Object):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Callback method that is called when the x and y position of the mask should be updated by the effect. You do not call this method directly. This method implements the method of the superclass.

Parameters

| `value:Object` — Contains an interpolated x and y value for the mask position, where `value[0]` contains the new x position of the mask, and `value[1]` contains the new y position.

### onScaleTweenEnd

()
method

`protected function onScaleTweenEnd(value:Object):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Callback method that is called when the `scaleX` and `scaleY` properties of the mask should be updated by the effect for the last time. You do not call this method directly. This method implements the method of the superclass.

Parameters

| `value:Object` — Contains the final `scaleX` and `scaleY` value for the mask, where `value[0]` contains the `scaleX` value of the mask, and `value[1]` contains the `scaleY` value.

### onScaleTweenUpdate

()
method

`protected function onScaleTweenUpdate(value:Object):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Callback method that is called when the `scaleX` and `scaleY` properties of the mask should be updated by the effect. You do not call this method directly. This method implements the method of the superclass.

Parameters

| `value:Object` — Contains an interpolated `scaleX` and `scaleY` value for the mask, where `value[0]` contains the new `scaleX` value of the mask, and `value[1]` contains the new `scaleY` value.

### pause

()
method

`override public function pause():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Pauses the effect until you call the `resume()` method.

### resume

()
method

`override public function resume():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Resumes the effect after it has been paused by a call to the `pause()` method.

### reverse

()
method

`override public function reverse():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Plays the effect in reverse, starting from the current position of the effect.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00