Wipe

(Preview)

Package	spark.effects
Class	public class Wipe
Inheritance	Wipe AnimateTransitionShader Animate Effect EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The Wipe effect uses Pixel Bender, which is not supported for AIR mobile applications.

The Wipe effect performs a bitmap transition effect by running a directional wipe between the first and second bitmaps. This wipe exposes the second bitmap over the course of the animation in a direction indicated by the direction property.

A pixel-shader program loaded by the effect runs the underlying bitmap effect. If you want to use a different Wipe behavior, you can specify a custom pixel-shader program. The pixel-shader program must adhere to the constraints specified for the shaderByteCode property of AnimateTransitionShader class, and supply three additional parameters. The extra parameters required by the Wipe shader are:

An int direction parameter, whose value means the same as the related String property in the Wipe class.
Two floating point parameters: imageWidth and imageHeight.

All of these parameters are set on the shader when the effect starts playing, so the parameters need to exist and do something appropriate in order for the effect to function correctly.

MXML Syntax expanded

Hide MXML Syntax

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"
  />

Default MXML PropertymotionPaths

View the examples

More examples

Spark pixel-shader effects
Using a pixel-shader effect in a transition
Applying a pixel-shader effect
Creating a custom pixel shader

Related API Elements

spark.effects.WipeDirection
spark.effects.AnimateTransitionShader
spark.effects.AnimateTransitionShader.shaderByteCode

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bitmapFrom : BitmapData The bitmap data representing the start state of this effect.	AnimateTransitionShader
		bitmapTo : BitmapData The bitmap data representing the end state of this effect.	AnimateTransitionShader
		className : String [read-only] The name of the effect class, such as "Fade".	Effect
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		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
		direction : String = "right" The direction that the wipe moves during the animation: WipeDirection.RIGHT, WipeDirection.LEFT, WipeDirection.UP, or WipeDirection.DOWN.	Wipe
		disableLayout : Boolean If true, the effect disables layout on its targets' parent containers, setting the containers autoLayout property to false, and also disables any layout constraints on the target objects.	Animate
		duration : Number Duration of the effect in milliseconds.	Effect
		easer : IEaser The easing behavior for this effect.	Animate
		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
		interpolator : IInterpolator The interpolator used by this effect to calculate values between the start and end values of a property.	Animate
		isPlaying : Boolean [read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.	Effect
		motionPaths : Vector.<MotionPath> A Vector of MotionPath objects, each of which holds the name of a property being animated and the values that the property takes during the animation.	Animate
		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
		repeatBehavior : String The behavior of a repeating effect, which means an effect with repeatCount equal to either 0 or > 1.	Animate
		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
		shaderByteCode : Object The bytecode for the pixel-shader program that the effect uses to animate between the two bitmaps.	AnimateTransitionShader
		shaderProperties : Object A map of parameter name/value pairs passed to the pixel-shader program before playing.	AnimateTransitionShader
		startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect.	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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Wipe(target:Object = null) Constructor.	Wipe
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	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 Dispatches an event into the event flow.	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 an Array of Strings, where each String is the name of a property changed by this effect.	Effect
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	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 Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	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 Sets the availability of a dynamic property for loop operations.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		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

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	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
effectRepeat	Dispatched when the effect begins a new repetition, for any effect that is repeated more than once.	Animate
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
effectUpdate	Dispatched every time the effect updates the target.	Animate

Property Detail

Constructor Detail

Examples How to use this example

WipeExample.mxml

Copy

<?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>

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Wipe - AS3 Flex

Packagesx

Language Elements

Appendixes

Package spark.effects

direction