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.
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.
Callback method that is called when the
scaleX and scaleY properties
of the mask should be updated by the effect.
MaskEffectInstance
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:
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.