Wipe

包	spark.effects
类	public class Wipe
继承	Wipe AnimateTransitionShader Animate Effect EventDispatcher Object

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

Wipe 效果使用 Pixel Bender，不受 AIR 手机应用程序支持。

Wipe 效果通过在第一个和第二个位图之间运行定向划出来执行位图过渡效果。此划出操作会在动画过程中沿着 direction 属性所指定的方向展示第二个位图。

效果加载的像素着色器程序运行基础位图效果。如果希望使用不同的 Wipe 行为，可指定自定义像素着色器程序。像素着色器程序必须遵循为 AnimateTransitionShader 类的 shaderByteCode 属性指定的约束，并提供三个附加参数。Wipe 着色器需要的附加参数为：

一个整型 direction 参数，其值与 Wipe 类中相关 String 属性的含义相同。
两个浮点参数：imageWidth 和 imageHeight。

所有这些参数都会在开始播放效果时在着色器上设置，因此它们必须存在且进行某些适当的操作才能让效果正常运行。

MXML 语法

隐藏 MXML 语法

The <s:Wipe> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <s:Wipe
    Properties
    id="ID"
    direction="right"
  />

默认 MXML 属性motionPaths

查看示例

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		bitmapFrom : BitmapData 代表此效果的起始状态的位图数据。	AnimateTransitionShader
		bitmapTo : BitmapData 代表此效果的结束状态的位图数据。	AnimateTransitionShader
		className : String [只读] 效果类的名称，如“Fade”。	Effect
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		customFilter : mx.effects:EffectTargetFilter 指定一个 EffectTargetFilter 类型的自定义滤镜对象，效果将使用此对象来确定播放效果的目标。	Effect
		direction : String = "right" 在动画过程中划出的移动方向：WipeDirection.RIGHT、WipeDirection.LEFT、WipeDirection.UP 或 WipeDirection.DOWN。	Wipe
		disableLayout : Boolean 如果为 true，则效果通过将容器的 autoLayout 属性设置为 false 对其目标的父容器禁用布局，并同时对目标对象禁用任何布局约束。	Animate
		duration : Number 效果的持续时间（以毫秒为单位）。	Effect
		easer : IEaser 此效果的缓动行为。	Animate
		effectTargetHost : mx.effects:IEffectTargetHost 一个属性，您可以通过设置此属性访问数据效果基于列表的目标控件。	Effect
		filter : String 指定用于过滤效果目标的算法。	Effect
		hideFocusRing : Boolean 确定在开始播放效果时，效果是否应隐藏对焦环。	Effect
		instanceClass : Class 一个 Class 类型的对象，用于指定此效果类的效果实例类。	Effect
		interpolator : IInterpolator 此效果计算属性的起始值和结束值之间的值所用的插补器。	Animate
		isPlaying : Boolean [只读] 一个只读标志，如果当前正在播放效果的任一实例，则为 true；否则，则为 false。	Effect
		motionPaths : Vector.<MotionPath> MotionPath 对象的 Vector，其中的每个对象都带有正在设置动画的属性的名称以及该属性在动画过程中所采用的值。	Animate
		perElementOffset : Number 在效果的第一个目标之后，其他效果目标的附加延迟（以毫秒为单位）。	Effect
		playheadTime : Number 效果的当前时间位置。	Effect
		relevantProperties : Array 一个属性名称 Array，执行过滤时将使用这些名称。	Effect
		relevantStyles : Array 一个样式名称 Array，执行过滤时将使用这些名称。	Effect
		repeatBehavior : String 一种重复效果的行为，这意味着 repeatCount 等于 0 或大于 1 的效果。	Animate
		repeatCount : int = 1 效果的重复次数。	Effect
		repeatDelay : int = 0 重复播放效果前需要等待的时间（以毫秒为单位）。	Effect
		shaderByteCode : Object 效果在两个位图之间设置动画时使用的像素着色器程序的字节码。	AnimateTransitionShader
		shaderProperties : Object 在播放之前已传递到像素着色器程序的参数名/值对的映射。	AnimateTransitionShader
		startDelay : int = 0 开始播放效果前需要等待的时间（以毫秒为单位）。	Effect
		target : Object 要应用此效果的对象。	Effect
		targets : Array 一个对象 Array，这些对象都是效果的目标。	Effect
		triggerEvent : Event 如果触发了某个效果，则此项目是由 EffectManager 传递给此 Effect 的 Event 对象；如果 EffectManager 当前没有播放此效果，则为 null。	Effect

受保护的属性

隐藏继承的受保护属性

显示继承的受保护属性

	属性		由以下参数定义
		applyTransitionEndProperties : Boolean 此标志控制该效果（进行转换时）是否将根据结束状态自动应用属性值，这与将值保留为效果本身所设置的值相反。	Effect
		endValuesCaptured : Boolean = false 一个标志，如果已确定效果的结束值，则该标志中包含 true；如果需要在效果运行时从效果目标的当前属性捕获这些值，则其中包含 false。	Effect

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		Wipe(target:Object = null) 构造函数。	Wipe
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		captureEndValues():void 捕获效果目标上相关属性的当前值，并将这些值另存为结束值。	Effect
		captureMoreStartValues(targets:Array):void 捕获另一组目标相关属性的当前值。在运行数据更改效果时，Flex 将使用此函数。	Effect
		captureStartValues():void 捕获效果目标上相关属性的当前值。	Effect
		createInstance(target:Object = null):IEffectInstance 创建一个效果实例并对其进行初始化。	Effect
		createInstances(targets:Array = null):Array 获取一个目标对象 Array，并对每个目标调用 createInstance() 方法。	Effect
		deleteInstance(instance:IEffectInstance):void 删除实例中的事件侦听器，然后从实例列表中删除该实例。	Effect
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		end(effectInstance:IEffectInstance = null):void 中断当前正在播放的效果，立即跳转到该效果的末尾。	Effect
		getAffectedProperties():Array 返回一个字符串 Array，其中每个 String 都是被此效果更改的属性的名称。	Effect
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		pause():void 暂停效果，直到调用 resume() 方法。	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array 开始播放效果。	Effect
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		resume():void 在效果由 pause() 方法暂停后继续播放效果。	Effect
		reverse():void 逆序播放效果；如果当前正在播放效果，则从该效果的当前位置开始逆序播放。	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		stop():void 停止播放效果，使效果目标保持当前状态。	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 供 Effect 基础结构内部使用。	Effect
		effectEndHandler(event:EffectEvent):void 当效果实例完成播放时调用。	Effect
		effectStartHandler(event:EffectEvent):void 当效果实例开始播放时调用此方法。	Effect
		effectStopHandler(event:EffectEvent):void 当效果实例已被 stop() 方法调用停止时调用。	Effect
		filterInstance(propChanges:Array, target:Object):Boolean 确定筛选效果实例所用的逻辑。	Effect
		getValueFromTarget(target:Object, property:String):* 由 captureStartValues() 方法调用，用来从目标获得某个属性的值。	Effect
		initInstance(instance:IEffectInstance):void 将效果的属性复制到效果实例。	Effect

事件

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

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
effectEnd	在其中一个效果实例完成播放时（既可以是实例实际完成播放时，也可以是通过调用 end() 方法中断效果时）调度。	Effect
effectRepeat	对于任何重复次数超过一次的效果，当效果开始新的重复时调度。	Animate
effectStart	当效果开始播放时调度。	Effect
effectStop	在已停止效果时调度，仅当该效果已被 stop() 方法调用中断时才会发生。	Effect
effectUpdate	每当效果更新目标时调度。	Animate

属性详细信息

direction

属性

public var direction:String = "right"

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

在动画过程中划出的移动方向：WipeDirection.RIGHT、WipeDirection.LEFT、WipeDirection.UP 或 WipeDirection.DOWN。

默认值为 WipeDirection.RIGHT。

()

构造函数

public function Wipe(target:Object = null)

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

构造函数。

参数

target:Object (default = null) — 要使用此效果为其设置动画的 Object。

示例如何使用本示例

WipeExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<s:Application
    xmlns:fx="http://ns.adobe.com/mxml/2009"
    xmlns:mx="library://ns.adobe.com/flex/mx"
    xmlns:s="library://ns.adobe.com/flex/spark">

    <s:states>
        <s:State name="default"/>
        <s:State name="flipped"/>
    </s:states>

    <s:transitions>
        <s:Transition id="t1">
            <s:Wipe id="wipe"
                direction="right"
                target="{holder}"
                duration="1000" />
        </s:Transition>
    </s:transitions>

    <s:Panel title="Wipe Example"
        width="75%" height="75%">

        <s:HGroup width="100%" height="100%" left="5" top="5"
            horizontalCenter="0" verticalCenter="0">
            <s:Group id="holder">
                <s:BitmapImage
                    source="@Embed('assets/back2.png')"
                    visible="true" visible.flipped="false"/>
                <s:BitmapImage
                    source="@Embed('assets/c2.png')"
                    visible="false" visible.flipped="true"/>
            </s:Group>

            <!-- Directions -->
            <s:VGroup id="detailsBox"
                width="50%"
                left="0">
                <s:Label
                    width="99%"
                    color="blue"
                    text="Wipe wipes from bitmapFrom to the bitmapTo image in the given direction. Click the 'Wipe Right' button to see the effect."/>
            </s:VGroup>
        </s:HGroup>

        <s:Rect left="0" right="0" bottom="0" height="30">
            <s:fill>
                <s:LinearGradient rotation="90">
                    <s:GradientEntry color="0xE2E2E2" />
                    <s:GradientEntry color="0xD9D9D9" />
                </s:LinearGradient>
            </s:fill>
        </s:Rect>
        <s:Button
            left="5" bottom="5"
            label="Wipe Right"
            click="currentState = (currentState == 'flipped') ? 'default' : 'flipped';"/>
    </s:Panel>

</s:Application>

法律声明 | 在线隐私策略

Wipe - AS3 Flex

类 x

direction

Wipe