| 套件 | mx.effects.effectClasses |
| 類別 | public class MaskEffectInstance |
| 繼承 | MaskEffectInstance  EffectInstance EventDispatcher Object |
| 子類別 | IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance |
| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
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
xproperty. - value[1]:Number The value of the target's
yproperty. - value[2]:Number The value of the target's
scaleXproperty. - value[3]:Number The value of the target's
scaleYproperty.
相關 API 元素
隱藏繼承公用屬性
顯示繼承公用屬性| 屬性 | 定義自 | ||
|---|---|---|---|
 | className : String [唯讀]
The name of the effect class, such as "FadeInstance". | EffectInstance | |
| constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | 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 | ||
| 屬性 | 定義自 | ||
|---|---|---|---|
| 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 | ||
| 方法 | 定義自 | ||
|---|---|---|---|
MaskEffectInstance(target:Object)
Constructor. | MaskEffectInstance | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。 | EventDispatcher | |
|
會將事件傳送到事件流程。 | EventDispatcher | |
|
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect. | EffectInstance | |
|
Called by the end() method when the effect
finishes playing. | EffectInstance | |
|
Called after each iteration of a repeated effect finishes playing. | EffectInstance | |
|
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | EventDispatcher | |
|
指出物件是否有已定義的指定屬性。 | Object | |
|
This method is called if the effect was triggered by the EffectManager. | EffectInstance | |
|
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | |
[覆寫]
Pauses the effect until you call the resume() method. | MaskEffectInstance | ||
|
Plays the effect instance on the target. | EffectInstance | |
|
指出指定的屬性是否存在，以及是否可列舉。 | Object | |
|
會從 EventDispatcher 物件移除偵聽程式。 | EventDispatcher | |
[覆寫]
Resumes the effect after it has been paused
by a call to the pause() method. | MaskEffectInstance | ||
[覆寫]
Plays the effect in reverse,
starting from the current position of the effect. | MaskEffectInstance | ||
|
為迴圈作業設定動態屬性的可用性。 | Object | |
|
Plays the effect instance on the target after the
startDelay period has elapsed. | EffectInstance | |
|
Stops the effect, leaving the target in its current state. | EffectInstance | |
|
傳回代表此物件的字串，根據地區特定慣例進行格式化。 | Object | |
|
會傳回指定之物件的字串形式。 | Object | |
|
會傳回指定之物件的基本值。 | Object | |
|
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | EventDispatcher | |
| 方法 | 定義自 | ||
|---|---|---|---|
Creates the default mask for the effect. | MaskEffectInstance | ||
Initializes the move and scale
properties of the effect. | MaskEffectInstance | ||
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 | ||
Callback method that is called when the x and y position
of the mask should be updated by the effect. | MaskEffectInstance | ||
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 | ||
Callback method that is called when the
scaleX and scaleY properties
of the mask should be updated by the effect. | MaskEffectInstance | ||
createMaskFunction | 屬性 |
createMaskFunction:Function| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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"/>
實作
public function get createMaskFunction():Function public function set createMaskFunction(value:Function):voideffectMask | 屬性 |
protected var effectMask:Shape| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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 | 屬性 |
public var moveEasingFunction:Function| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Easing function to use for moving the mask.
scaleEasingFunction | 屬性 |
public var scaleEasingFunction:Function| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Easing function to use for scaling the mask.
scaleXFrom | 屬性 |
public var scaleXFrom:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Initial scaleX for mask.
scaleXTo | 屬性 |
public var scaleXTo:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Ending scaleX for mask.
scaleYFrom | 屬性 |
public var scaleYFrom:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Initial scaleY for mask.
scaleYTo | 屬性 |
public var scaleYTo:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Ending scaleY for mask.
showTarget | 屬性 |
targetArea | 屬性 |
public var targetArea:Rectangle| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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 | 屬性 |
protected var targetVisualBounds:Rectangle| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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 | 屬性 |
public var xFrom:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Initial position's x coordinate for mask.
xTo | 屬性 |
public var xTo:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Destination position's x coordinate for mask.
yFrom | 屬性 |
public var yFrom:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Initial position's y coordinate for mask.
yTo | 屬性 |
public var yTo:Number| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Destination position's y coordinate for mask.
MaskEffectInstance | () | 建構函式 |
defaultCreateMask | () | 方法 |
protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shape| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Creates the default mask for the effect.
參數
targ:Object — The effect target.
| |
bounds:Rectangle — The actual visual bounds of the target which includes drop shadows
|
Shape — A Shape object that defines the mask.
|
initMaskEffect | () | 方法 |
protected function initMaskEffect():void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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 | () | 方法 |
protected function onMoveTweenEnd(value:Object):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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.
參數
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 | () | 方法 |
protected function onMoveTweenUpdate(value:Object):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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.
參數
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 | () | 方法 |
protected function onScaleTweenEnd(value:Object):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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.
參數
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 | () | 方法 |
protected function onScaleTweenUpdate(value:Object):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | 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.
參數
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 | () | 方法 |
override public function pause():void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Pauses the effect until you call the resume() method.
resume | () | 方法 |
override public function resume():void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Resumes the effect after it has been paused
by a call to the pause() method.
reverse | () | 方法 |
override public function reverse():void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Plays the effect in reverse, starting from the current position of the effect.
Tue Jun 12 2018, 03:47 PM Z