Package | spark.effects |
Class | public class Wipe |
Inheritance | Wipe ![]() ![]() ![]() ![]() ![]() |
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
andimageHeight
.
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
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
More examples
Using a pixel-shader effect in a transition
Applying a pixel-shader effect
Creating a custom pixel shader
Related API Elements
spark.effects.AnimateTransitionShader
spark.effects.AnimateTransitionShader.shaderByteCode
Property | Defined By | ||
---|---|---|---|
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object |
Method | Defined By | ||
---|---|---|---|
![]() | 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 | |
![]() |
Dispatches an event into the event flow. | EventDispatcher | |
![]() |
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
![]() |
Indicates whether an object has a specified property defined. | Object | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
![]() |
Indicates whether the specified property exists and is enumerable. | Object | |
![]() |
Removes a listener from the EventDispatcher object. | EventDispatcher | |
![]() |
Sets the availability of a dynamic property for loop operations. | Object | |
![]() |
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
![]() |
Returns the string representation of the specified object. | Object | |
![]() |
Returns the primitive value of the specified object. | Object | |
![]() |
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
<?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>
Wed Nov 21 2018, 06:34 AM -08:00