| 패키지 | 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:17 PM Z