MaskEffectInstance

包	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

MaskEffectInstance 类是一个抽象基类，用于实现 MaskEffect 类的实例类。

属于 TweenEffect 类的子类的所有效果类均支持下列事件：

tweenEnd：当补间效果结束时调度。
tweenUpdate：当 TweenEffect 类每次计算新值时调度。

向这两个事件的事件侦听器传递的对象是 TweenEvent 类型的。TweenEvent 类用于定义 value 属性，该属性中包含由效果计算的补间值。对于 Mask 效果，TweenEvent.value 属性中包含一个具有四个项的 Array，其中：

value[0]:Number 这是目标的 x 属性的值。
value[1]:Number 这是目标的 y 属性的值。
value[2]:Number 这是目标的 scaleX 属性的值。
value[3]:Number 这是目标的 scaleY 属性的值。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		className : String [只读] 效果类的名称，如“FadeInstance”。	EffectInstance
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		createMaskFunction : Function 效果创建遮罩时调用的函数。	MaskEffectInstance
		duration : Number 效果的持续时间（以毫秒为单位）。	EffectInstance
		effect : IEffect 创建此 IEffectInstance 对象的 IEffect 对象。	EffectInstance
		effectTargetHost : mx.effects:IEffectTargetHost 一个属性，您可以通过设置此属性访问数据效果基于列表的目标控件。	EffectInstance
		hideFocusRing : Boolean 确定在开始播放效果时，效果是否应隐藏对焦环。	EffectInstance
		moveEasingFunction : Function 要用于移动遮罩的缓动函数。	MaskEffectInstance
		playheadTime : Number 效果的当前时间位置。	EffectInstance
		propertyChanges : PropertyChanges 指定包含一组属性的初始值和结束值的 PropertyChanges 对象，这些属性与效果的目标相关。	EffectInstance
		repeatCount : int 效果的重复次数。	EffectInstance
		repeatDelay : int 重复播放效果前需要等待的时间（以毫秒为单位）。	EffectInstance
		scaleEasingFunction : Function 要用于缩放遮罩的缓动函数。	MaskEffectInstance
		scaleXFrom : Number 遮罩最初的 scaleX。	MaskEffectInstance
		scaleXTo : Number 遮罩最终的 scaleX。	MaskEffectInstance
		scaleYFrom : Number 遮罩最初的 scaleY。	MaskEffectInstance
		scaleYTo : Number 遮罩最终的 scaleY。	MaskEffectInstance
		showTarget : Boolean 指定如果为 false，则目标组件可见；如果为 true，则不可见。	MaskEffectInstance
		startDelay : int 开始播放效果前需要等待的时间（以毫秒为单位）。	EffectInstance
		suspendBackgroundProcessing : Boolean 如果为 true，则在播放效果时阻止所有背景处理。	EffectInstance
		target : Object 要应用此效果的 UIComponent 对象。	EffectInstance
		targetArea : Rectangle 目标上应用遮罩的区域。	MaskEffectInstance
		triggerEvent : Event 触发播放效果的事件（如果有）。	EffectInstance
		xFrom : Number 遮罩初始位置的 x 坐标。	MaskEffectInstance
		xTo : Number 遮罩目标位置的 x 坐标。	MaskEffectInstance
		yFrom : Number 遮罩初始位置的 y 坐标。	MaskEffectInstance
		yTo : Number 遮罩目标位置的 y 坐标。	MaskEffectInstance

受保护的属性

隐藏继承的受保护属性

显示继承的受保护属性

	属性		由以下参数定义
		effectMask : Shape 包含效果遮罩，可以是由 defaultCreateMask() 方法创建的默认遮罩，也可以是由传递给 createMaskFunction 属性的函数指定的遮罩。	MaskEffectInstance
		playCount : int = 0 已播放实例的次数。	EffectInstance
		targetVisualBounds : Rectangle 效果目标的实际大小（包含所有投影）。	MaskEffectInstance

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		MaskEffectInstance(target:Object) 构造函数。	MaskEffectInstance
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		end():void 中断当前播放的效果实例，立即跳转到效果的结束位置。	EffectInstance
		finishEffect():void 在完成效果播放时由 end() 方法调用。	EffectInstance
		finishRepeat():void 每次完成重复效果的迭代播放后调用。	EffectInstance
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		initEffect(event:Event):void 如果由 EffectManager 触发效果，则会调用此方法。	EffectInstance
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		pause():void [覆盖] 暂停效果，直到调用 resume() 方法。	MaskEffectInstance
		play():void 在目标上播放效果实例。	EffectInstance
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		resume():void [覆盖] 在效果由 pause() 方法暂停后继续播放效果。	MaskEffectInstance
		reverse():void [覆盖] 从效果的当前位置开始反向播放效果。	MaskEffectInstance
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		startEffect():void 经过 startDelay 所占用的这段时间后，在目标上播放效果实例。	EffectInstance
		stop():void 停止播放效果，使目标保持当前状态。	EffectInstance
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

受保护的方法

	方法		由以下参数定义
		defaultCreateMask(targ:Object, bounds:Rectangle):Shape 为效果创建默认遮罩。	MaskEffectInstance
		initMaskEffect():void 初始化效果的 move 和 scale 属性。	MaskEffectInstance
		onMoveTweenEnd(value:Object):void 当应最后一次使用效果更新遮罩的 x 和 y 位置时，要调用的回调方法。	MaskEffectInstance
		onMoveTweenUpdate(value:Object):void 当应使用效果更新遮罩的 x 和 y 位置时，要调用的回调方法。	MaskEffectInstance
		onScaleTweenEnd(value:Object):void 当应最后一次使用效果更新遮罩的 scaleX 和 scaleY 属性时，要调用的回调方法。	MaskEffectInstance
		onScaleTweenUpdate(value:Object):void 当应使用效果更新遮罩的 scaleX 和 scaleY 属性时，要调用的回调方法。	MaskEffectInstance

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	事件		摘要	由以下参数定义
		activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
		deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher

属性详细信息

createMaskFunction

属性

createMaskFunction:Function

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

效果创建遮罩时调用的函数。默认值是一个函数，返回与效果目标大小相同的 Rectangle。

您可以使用此属性来指定自己的回调函数，用于绘制遮罩。此函数必须具有以下特征：

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

您需要将此属性设置为该函数的名称，如以下的 WipeLeft 效果示例所示：

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

实现
public function get createMaskFunction():Function
public function set createMaskFunction(value:Function):void

effectMask

属性

protected var effectMask:Shape

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

包含效果遮罩，可以是由 defaultCreateMask() 方法创建的默认遮罩，也可以是由传递给 createMaskFunction 属性的函数指定的遮罩。

moveEasingFunction

属性

public var moveEasingFunction:Function

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

要用于移动遮罩的缓动函数。

scaleEasingFunction

属性

public var scaleEasingFunction:Function

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

要用于缩放遮罩的缓动函数。

scaleXFrom

属性

public var scaleXFrom:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

遮罩最初的 scaleX。

scaleXTo

属性

public var scaleXTo:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

遮罩最终的 scaleX。

scaleYFrom

属性

public var scaleYFrom:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

遮罩最初的 scaleY。

scaleYTo

属性

public var scaleYTo:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

遮罩最终的 scaleY。

showTarget

属性

showTarget:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

指定如果为 false，则目标组件可见；如果为 true，则不可见。

默认值为 true。

实现
public function get showTarget():Boolean
public function set showTarget(value:Boolean):void

targetArea

属性

public var targetArea:Rectangle

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

目标上应用遮罩的区域。其尺寸随目标自身而改变。默认情况下，此区域是整个目标，并以如下方式创建：new Rectangle(0, 0, target.width, target.height);

targetVisualBounds

属性

protected var targetVisualBounds:Rectangle

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

效果目标的实际大小（包含所有投影）。Flex 会自动计算此属性的值；您不必设置它。

xFrom

属性

public var xFrom:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

遮罩初始位置的 x 坐标。

xTo

属性

public var xTo:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

遮罩目标位置的 x 坐标。

yFrom

属性

public var yFrom:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

遮罩初始位置的 y 坐标。

yTo

属性

public var yTo:Number

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

遮罩目标位置的 y 坐标。

构造函数详细信息

()

构造函数

public function MaskEffectInstance(target:Object)

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

构造函数。

参数

target:Object — 要使用此效果为其设置动画的 Object。

方法详细信息

defaultCreateMask

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

为效果创建默认遮罩。

参数

	`targ:Object` — 效果目标。

	`bounds:Rectangle` — 包含投影的目标的实际可视范围

()

方法

override public function pause():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

暂停效果，直到调用 resume() 方法。

resume

()

方法

override public function resume():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

在效果由 pause() 方法暂停后继续播放效果。

reverse

()

方法

override public function reverse():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

从效果的当前位置开始反向播放效果。

法律声明 | 在线隐私策略

MaskEffectInstance - AS3 Flex

包x

语言元素

附录

包 mx.effects.effectClasses

createMaskFunction

effectMask

moveEasingFunction

scaleEasingFunction

scaleXFrom

scaleXTo

scaleYFrom

scaleYTo

showTarget

targetArea

targetVisualBounds

xFrom

xTo

yFrom

yTo