MaskEffect

패키지	mx.effects
클래스	public class MaskEffect
상속	MaskEffect Effect EventDispatcher Object
하위 클래스	Iris, WipeDown, WipeLeft, WipeRight, WipeUp

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

The MaskEffect class is an abstract base class for all effects that animate a mask, such as the wipe effects and the Iris effect. This class encapsulates methods and properties that are common among all mask-based effects.

A mask effect uses an overlay, called a mask, to perform the effect. By default, the mask is a rectangle with the same size as the target component.

The before or after state of the target component of a mask effect must be invisible. That means a mask effect always makes a target component appear on the screen, or disappear from the screen.

You use the scaleXFrom, scaleYFrom, scaleXTo, and scaleX properties to specify the initial and final scale of the mask, where a value of 1.0 corresponds to scaling the mask to the size of the target component, 2.0 scales the mask to twice the size of the component, 0.5 scales the mask to half the size of the component, and so on. To use any one of these properties, you must specify all four.

You use the xFrom, yFrom, xTo, and yTo properties to specify the coordinates of the initial position and final position of the mask relative to the target component, where (0, 0) corresponds to the upper left corner of the target. To use any one of these properties, you must specify all four.

The coordinates of the initial and final position of the mask depend on the type of effect and whether the show property is true or false. For example, for the WipeLeft effect with a show value of false, the coordinates of the initial mask position are (0, 0),corresponding to the upper-left corner of the target, and the coordinates of the final position are the upper-right corner of the target (width, 0), where width is the width of the target.

For a show value of true for the WipeLeft effect, the coordinates of the initial mask position are (width, 0), and the coordinates of the final position are (0, 0).

MXML 구문

MXML 구문 숨기기

The MaskEffect class defines the following properties, which all of its subclasses inherit:

  <mx:tagname
    createMaskFunction=""
    moveEasingFunction=""
    scaleEasingFunction=""
    scaleXFrom=""
    scaleXTo=""
    scaleYFrom=""
    scaleYTo=""
    show="true|false"
    xFrom=""
    xTo=""
    yFrom=""
    yTo=""
  />

기타 예제

Using a MX mask effect
Creating a custom mask function

공용 속성

상속되는 공용 속성 숨기기

상속되는 공용 속성 표시

	속성		정의 주체
		className : String [읽기 전용] The name of the effect class, such as "Fade".	Effect
		constructor : Object 지정된 객체 인스턴스의 클래스 객체 또는 생성자 함수에 대한 참조입니다.	Object
		createMaskFunction : Function Function called when the effect creates the mask.	MaskEffect
		customFilter : mx.effects:EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.	Effect
		duration : Number Duration of the effect in milliseconds.	Effect
		effectTargetHost : mx.effects:IEffectTargetHost A property that lets you access the target list-based control of a data effect.	Effect
		filter : String Specifies an algorithm for filtering targets for an effect.	Effect
		hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect.	Effect
		instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class.	Effect
		isPlaying : Boolean [읽기 전용] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.	Effect
		moveEasingFunction : Function Easing function to use for moving the mask.	MaskEffect
		perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect.	Effect
		playheadTime : Number Current time position of the effect.	Effect
		relevantProperties : Array An Array of property names to use when performing filtering.	Effect
		relevantStyles : Array An Array of style names to use when performing filtering.	Effect
		repeatCount : int = 1 Number of times to repeat the effect.	Effect
		repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect.	Effect
		scaleEasingFunction : Function Easing function to use for scaling the mask.	MaskEffect
		scaleXFrom : Number Initial scaleX for mask.	MaskEffect
		scaleXTo : Number Ending scaleX for mask.	MaskEffect
		scaleYFrom : Number Initial scaleY for mask.	MaskEffect
		scaleYTo : Number Ending scaleY for mask.	MaskEffect
		showTarget : Boolean Specifies that the target component is becoming visible, true, or invisible, false.	MaskEffect
		startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect.	Effect
		suspendBackgroundProcessing : Boolean = false If true, blocks all background processing while the effect is playing.	Effect
		target : Object The object to which this effect is applied.	Effect
		targets : Array An Array of objects that are targets for the effect.	Effect
		triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager.	Effect
		xFrom : Number Initial position's x coordinate for mask.	MaskEffect
		xTo : Number Destination position's x coordinate for mask.	MaskEffect
		yFrom : Number Initial position's y coordinate for mask.	MaskEffect
		yTo : Number Destination position's y coordinate for mask.	MaskEffect

보호 속성

상속되는 보호 속성 숨기기

상속되는 보호 속성 표시

	속성		정의 주체
		applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.	Effect
		endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.	Effect

공용 메서드

상속되는 공용 메서드 숨기기

상속되는 공용 메서드 표시

	메서드		정의 주체
		MaskEffect(target:Object = null) Constructor.	MaskEffect
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 리스너에서 이벤트 알림을 받을 수 있도록 EventDispatcher 객체에 이벤트 리스너 객체를 등록합니다.	EventDispatcher
		captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values.	Effect
		captureMoreStartValues(targets:Array):void Captures the current values of the relevant properties of an additional set of targets Flex uses this function when a data change effect is run.	Effect
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target.	Effect
		deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances.	Effect
		dispatchEvent(event:Event):Boolean 이벤트를 이벤트 흐름으로 전달합니다.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array [재정의] Returns the component properties modified by this effect.	MaskEffect
		hasEventListener(type:String):Boolean EventDispatcher 객체에 특정 유형의 이벤트에 대한 리스너가 등록되어 있는지 여부를 확인합니다.	EventDispatcher
		hasOwnProperty(name:String):Boolean 지정된 속성이 객체에 정의되어 있는지 여부를 나타냅니다.	Object
		isPrototypeOf(theClass:Object):Boolean Object 클래스의 인스턴스가 매개 변수로 지정된 객체의 프로토타입 체인에 있는지 여부를 나타냅니다.	Object
		pause():void Pauses the effect until you call the resume() method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		propertyIsEnumerable(name:String):Boolean 지정된 속성이 존재하고 열거 가능한지 여부를 나타냅니다.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher 객체에서 리스너를 제거합니다.	EventDispatcher
		resume():void Resumes the effect after it has been paused by a call to the pause() method.	Effect
		reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 루프 작업에서 동적 속성을 사용할 수 있는지 여부를 설정합니다.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String 로캘별 규칙에 따라 서식이 지정된 이 객체의 문자열 표현을 반환합니다.	Object
		toString():String 지정된 객체의 문자열 표현을 반환합니다.	Object
		valueOf():Object 지정된 객체의 프리미티브 값을 반환합니다.	Object
		willTrigger(type:String):Boolean 이 EventDispatcher 객체 또는 조상 객체에 지정한 이벤트 유형에 대한 이벤트 리스너가 등록되어 있는지 여부를 확인합니다.	EventDispatcher

보호 메서드

상속되는 보호 메서드 숨기기

상속되는 보호 메서드 표시

	메서드		정의 주체
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect
		tweenEventHandler(event:mx.events:TweenEvent):void Called when the TweenEffect dispatches a TweenEvent.	MaskEffect

이벤트

이벤트에 대한 자세한 내용을 보려면 클릭하십시오.

상속되는 이벤트 숨기기

상속되는 이벤트 표시

	요약	정의 주체
activate	[브로드캐스트 이벤트] Flash Player 또는 AIR 응용 프로그램이 운영 체제 포커스를 얻어 활성화될 때 전달됩니다.	EventDispatcher
deactivate	[브로드캐스트 이벤트] Flash Player 또는 AIR 응용 프로그램이 운영 체제 포커스를 잃고 비활성화될 때 전달됩니다.	EventDispatcher
effectEnd	Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method.	Effect
effectStart	Dispatched when the effect starts playing.	Effect
effectStop	Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.	Effect
tweenEnd	Dispatched when the effect ends.	MaskEffect
tweenStart	Dispatched when the effect starts, which corresponds to the first call to the onMoveTweenUpdate() and onScaleTweenUpdate() methods.	MaskEffect
tweenUpdate	Dispatched every time the effect updates the target.	MaskEffect

속성 세부 정보

createMaskFunction

속성

public var 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 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.

moveEasingFunction

속성

public var moveEasingFunction:Function

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Easing function to use for moving the mask.

기본값: null.

scaleEasingFunction

속성

public var scaleEasingFunction:Function

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Easing function to use for scaling the mask.

기본값: null.

scaleXFrom

속성

public var scaleXFrom:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Initial scaleX for mask.

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

scaleXTo

속성

public var scaleXTo:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Ending scaleX for mask.

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

scaleYFrom

속성

public var scaleYFrom:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Initial scaleY for mask.

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

scaleYTo

속성

public var scaleYTo:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Ending scaleY for mask.

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

showTarget

속성

showTarget:Boolean

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

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.

기본값: true.

구현
public function get showTarget():Boolean
public function set showTarget(value:Boolean):void

xFrom

속성

public var xFrom:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Initial position's x coordinate for mask.

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

xTo

속성

public var xTo:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Destination position's x coordinate for mask.

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

yFrom

속성

public var yFrom:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Initial position's y coordinate for mask.

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

yTo

속성

public var yTo:Number

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Destination position's y coordinate for mask.

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

생성자 세부 정보

()

생성자

public function MaskEffect(target:Object = null)

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

Constructor.

매개 변수

target:Object (default = null) — The Object to animate with this effect.

메서드 세부 정보

getAffectedProperties

()

메서드

override public function getAffectedProperties():Array

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

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.

반환값

Array — An Array of Strings specifying the names of the properties modified by this effect.

tweenEventHandler

()

메서드

protected function tweenEventHandler(event:mx.events:TweenEvent):void

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

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

매개 변수

event:mx.events:TweenEvent — An event object of type TweenEvent.

이벤트 세부 정보

tweenEnd

이벤트

이벤트 객체 유형: mx.events.TweenEvent
속성 TweenEvent.type = mx.events.TweenEvent.TWEEN_END

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

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 TweenEvent.TWEEN_END constant defines the value of the event object's type property for a tweenEnd event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`value`	The value passed to the `onTweenEnd()` method.

tweenStart

이벤트

이벤트 객체 유형: mx.events.TweenEvent
속성 TweenEvent.type = mx.events.TweenEvent.TWEEN_START

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

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 TweenEvent.TWEEN_START constant defines the value of the event object's type property for a tweenStart event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`value`	The value passed to the `onTweenUpdate()` method.

tweenUpdate

이벤트

이벤트 객체 유형: mx.events.TweenEvent
속성 TweenEvent.type = mx.events.TweenEvent.TWEEN_UPDATE

언어 버전:

ActionScript 3.0

제품 버전:

Flex 3

런타임 버전:

Flash Player 9, AIR 1.1

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

The TweenEvent.TWEEN_UPDATE constant defines the value of the event object's type property for a tweenUpdate event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`value`	The value passed to the `onTweenUpdate()` method.

법적 고지 사항 | 온라인 개인 정보 보호 정책

MaskEffect - AS3 Flex

패키지x

언어 요소

부록

패키지 mx.effects

createMaskFunction

moveEasingFunction

scaleEasingFunction

scaleXFrom

scaleXTo

scaleYFrom

scaleYTo

showTarget

xFrom

xTo

yFrom

yTo

MaskEffect

getAffectedProperties

tweenEventHandler

tweenEnd

tweenStart

tweenUpdate