Wipe

Package	spark.effects
Classe	public class Wipe
Héritage	Wipe AnimateTransitionShader Animate Effect EventDispatcher Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

L’effet Wipe utilise Pixel Bender, qui n’est pas pris en charge par les applications mobile AIR.

L’effet Wipe réalise un effet de transition bitmap en opérant un balayage directionnel entre la première et la deuxième image bitmap. Ce balayage fait entrer la deuxième image bitmap pendant l’animation, dans le sens indiqué par la propriété direction.

Un programme pixel shader chargé par l’effet exécute l’effet de l’image bitmap sous-jacente. Si vous souhaitez utiliser une autre comportement Wipe, vous pouvez spécifier un programme pixel shader. Le programme pixel shader doit se conformer aux contraintes spécifiée pour la propriété shaderByteCode de la classe AnimateTransitionShader et indiquer trois paramètres supplémentaires. Les paramètres supplémentaires requis par le shader Wipe sont les suivants :

un paramètre int direction, dont la valeur a la même signification que la propriété String de la classe Wipe.
Deux paramètres à virgule flottante : imageWidth et imageHeight.

Tous ces paramètres sont définis sur le shader lorsque la lecture de l’effet commence. Par conséquent, les paramètres doivent exister et réaliser une action appropriée pour que l’effet puisse fonctionner correctement.

Syntaxe MXML expanded

Masquer la syntaxe 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"
  />

Propriété MXML par défautmotionPaths

Consulter les exemples

Eléments de l’API associés

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

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		bitmapFrom : BitmapData Données bitmap représentant l’état de départ de cet effet.	AnimateTransitionShader
		bitmapTo : BitmapData Données bitmap représentant l’état de fin de cet effet.	AnimateTransitionShader
		className : String [lecture seule] Le nom de la classe d’effet, tel que « Fade ».	Effect
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		customFilter : mx.effects:EffectTargetFilter Spécifie un objet filtre personnalisé, de type EffectTargetFilter, utilisé par l’effet pour déterminer les cibles sur lequel lire l’effet.	Effect
		direction : String = "right" Sens dans lequel le balayage est réalisé pendant l’animation : WipeDirection.RIGHT, WipeDirection.LEFT, WipeDirection.UP ou WipeDirection.DOWN.	Wipe
		disableLayout : Boolean Si la valeur est true, l’effet désactive la mise en page des conteneurs parent de ses cibles, définissant la propriété autoLayout des conteneurs sur false, et désactive également toute contrainte de mise en page sur les objets cible.	Animate
		duration : Number Durée de l’effet en millisecondes.	Effect
		easer : IEaser Comportement d’accélération de cet effet.	Animate
		effectTargetHost : mx.effects:IEffectTargetHost Propriété qui permet d’accéder au contrôle à base de liste de la cible d’un effet data.	Effect
		filter : String Spécifie un algorithme de filtrage des cibles d’un effet.	Effect
		hideFocusRing : Boolean Détermine si l’effet doit masquer l’anneau de focus lors du démarrage.	Effect
		instanceClass : Class Objet de type Class qui spécifie la classe de l’instance d’effet de cette classe d’effets.	Effect
		interpolator : IInterpolator Interpolateur utilisé par cet effet pour calculer les valeurs situées entre les valeurs de début et de fin d’une propriété.	Animate
		isPlaying : Boolean [lecture seule] Indicateur de lecture seule défini sur true si les instances de l’effet sont en cours de lecture et sur false si aucune instance n’est définie.	Effect
		motionPaths : Vector.<MotionPath> Un vecteur d’objets MotionPath contenant chacun le nom d’une propriété animée et les valeurs prises par la propriété au cours de l’animation.	Animate
		perElementOffset : Number Autre délai, en millisecondes, pour les cibles d’effet suivant la première cible de l’effet.	Effect
		playheadTime : Number Temps de position actuelle de l’effet.	Effect
		relevantProperties : Array Tableau de noms de propriété à utiliser pour effectuer le filtrage.	Effect
		relevantStyles : Array Tableau des noms de style à utiliser pour effectuer le filtrage.	Effect
		repeatBehavior : String Comportement d’un effet répété, c’est-à-dire d’un effet dont la valeur repeatCount est égale à 0 ou supérieure à 1.	Animate
		repeatCount : int = 1 Nombre de fois que l’effet doit être répété.	Effect
		repeatDelay : int = 0 Intervalle (en millisecondes), qui s’écoule avant de répéter l’effet.	Effect
		shaderByteCode : Object Pseudo-code binaire du programme pixel shader utilisé par l’effet pour réaliser l’animation entre les deux images bitmap.	AnimateTransitionShader
		shaderProperties : Object Mappage de paires de paramètres nom/valeur transmis au programme pixel shader avant la lecture.	AnimateTransitionShader
		startDelay : int = 0 Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet.	Effect
		target : Object Objet auquel s’applique cet effet.	Effect
		targets : Array Tableau d’objets représentant des cibles de l’effet.	Effect
		triggerEvent : Event Objet Evénement transmis à cet Effet par le gestionnaire EffectManager lorsqu’un effet est déclenché, ou nul si l’effet n’est pas exécuté par le gestionnaire EffectManager.	Effect

Propriétés protégées

Masquer les propriétés protégées héritées

Afficher les propriétés protégées héritées

	Propriété		Défini par
		applyTransitionEndProperties : Boolean Cet indicateur contrôle si l’effet, lorsqu’il est exécuté dans une transition, applique automatiquement les valeurs de propriété conformément à l’état d’arrivée, au lieu de conserver ces valeurs comme l’a défini l’effet lui-même.	Effect
		endValuesCaptured : Boolean = false Drapeau contenant la valeur true si les valeurs d’arrivée d’un effet ont déjà été déterminées, ou false si elles doivent être acquises à partir des propriétés actuelles des cibles de l’effet lorsque l’effet s’exécute.	Effect

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		Wipe(target:Object = null) Constructeur.	Wipe
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.	EventDispatcher
		captureEndValues():void Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet et les enregistre en tant que valeurs d’arrivée.	Effect
		captureMoreStartValues(targets:Array):void Capture les valeurs actuelles des propriétés correspondantes d’un autre ensemble de cibles. Flex utilise cette fonction lorsqu’un effet de modifications de données est exécuté.	Effect
		captureStartValues():void Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet.	Effect
		createInstance(target:Object = null):IEffectInstance Crée une seule instance d’effet et l’initialise.	Effect
		createInstances(targets:Array = null):Array Prend un tableau d’objets cible et invoque la méthode createInstance() sur chaque cible.	Effect
		deleteInstance(instance:IEffectInstance):void Supprime les écouteurs d’événement d’une instance et les retire de la liste d’instances.	Effect
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrompt un effet en cours de lecture et passe immédiatement à la fin de l’effet.	Effect
		getAffectedProperties():Array Renvoie un tableau de chaînes, où chaque chaîne correspond au nom d’une propriété modifiée par cet effet.	Effect
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.	Object
		pause():void Interrompt momentanément l’effet jusqu’à un appel de la méthode resume().	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Commence la lecture de l’effet.	Effect
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		resume():void Reprend l’effet après une interruption demandée par un appel de la méthode pause().	Effect
		reverse():void Exécute l’effet en sens inverse, si l’effet est en cours de lecture, à partir de sa position actuelle.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		stop():void Arrête l’effet, en laissant les cibles de l’effet dans leur état actuel.	Effect
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.	EventDispatcher

Méthodes protégées

Masquer les méthodes protégées héritées

Afficher les méthodes protégées héritées

	Méthode		Défini par
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Utilisée en interne par l’infrastructure Effect.	Effect
		effectEndHandler(event:EffectEvent):void Appelée à la fin de la lecture d’une instance d’effet.	Effect
		effectStartHandler(event:EffectEvent):void Cette méthode est appelée lorsque l’instance d’effet commence.	Effect
		effectStopHandler(event:EffectEvent):void Appelée lorsqu’une instance d’effet a été interrompue par un appel de la méthode stop().	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Détermine la logique de filtrage d’une instance d’effet.	Effect
		getValueFromTarget(target:Object, property:String):* Appelée par la méthode captureStartValues() pour obtenir la valeur d’une propriété à partir de la cible.	Effect
		initInstance(instance:IEffectInstance):void Copie les propriétés de l’effet vers l’instance d’effet.	Effect

Evénements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Synthèse	Défini par
activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher
effectEnd	Distribué lorsque la lecture de l’une des instances de l’effet s’arrête, soit lorsque la lecture de l’instance s’arrête, soit lorsque l’effet est interrompu par un appel de la méthode end().	Effect
effectRepeat	Distribué au début de chaque répétition de l’effet, dans le cas d’un effet répété.	Animate
effectStart	Diffusé lorsque l’exécution de l’effet commence.	Effect
effectStop	Distribué lorsque l’effet a été interrompu, ce qui se produit uniquement lorsque l’effet est interrompu par un appel de la méthode stop().	Effect
effectUpdate	Distribué chaque fois que l’effet met à jour la cible.	Animate

Détails de la propriété

direction

propriété

public var direction:String = "right"

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Sens dans lequel le balayage est réalisé pendant l’animation : WipeDirection.RIGHT, WipeDirection.LEFT, WipeDirection.UP ou WipeDirection.DOWN.

La valeur par défaut est WipeDirection.RIGHT.

Eléments de l’API associés

WipeDirection.RIGHT
WipeDirection.UP
WipeDirection.LEFT
WipeDirection.DOWN

Détails du constructeur

()

Constructeur

public function Wipe(target:Object = null)

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Constructeur.

Paramètres

target:Object (default = null) — Objet à animer à l’aide de cet effet.

Exemples Comment utiliser cet exemple

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>

Informations juridiques | Politique de confidentialité en ligne

Wipe - AS3 Flex

Classes x

direction

Wipe