Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
spark.effects 

Animate  - AS3 Flex

Packagespark.effects
Classepublic class Animate
HéritageAnimate Inheritance Effect Inheritance EventDispatcher Inheritance Object
Sous-classes AnimateColor, AnimateFilter, AnimateTransform, AnimateTransitionShader, Fade, Resize

Version du langage: ActionScript 3.0
Version du produit: Flex 4
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Cet effet Animate anime un ensemble arbitraire de propriétés entre des valeurs. Spécifiez les propriétés et valeurs à animer en définissant la propriété motionPaths.

Syntaxe MXMLexpandedMasquer la syntaxe MXML

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

  <s:Animate
    Properties
    id="ID"
    disableLayout="false"
    easer="{spark.effects.easing.Sine(.5)}"
    interpolator="NumberInterpolator"
    motionPaths="no default"
    repeatBehavior="loop"
  />
  

Propriété MXML par défautmotionPaths

Consulter les exemples

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
 InheritedclassName : String
[lecture seule] Le nom de la classe d’effet, tel que « Fade ».
Effect
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
 InheritedcustomFilter : 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
  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
 Inheritedduration : Number
Durée de l’effet en millisecondes.
Effect
  easer : IEaser
Comportement d’accélération de cet effet.
Animate
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
Propriété qui permet d’accéder au contrôle à base de liste de la cible d’un effet data.
Effect
 Inheritedfilter : String
Spécifie un algorithme de filtrage des cibles d’un effet.
Effect
 InheritedhideFocusRing : Boolean
Détermine si l’effet doit masquer l’anneau de focus lors du démarrage.
Effect
 InheritedinstanceClass : 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
 InheritedisPlaying : 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
 InheritedperElementOffset : Number
Autre délai, en millisecondes, pour les cibles d’effet suivant la première cible de l’effet.
Effect
 InheritedplayheadTime : Number
Temps de position actuelle de l’effet.
Effect
 InheritedrelevantProperties : Array
Tableau de noms de propriété à utiliser pour effectuer le filtrage.
Effect
 InheritedrelevantStyles : 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
 InheritedrepeatCount : int = 1
Nombre de fois que l’effet doit être répété.
Effect
 InheritedrepeatDelay : int = 0
Intervalle (en millisecondes), qui s’écoule avant de répéter l’effet.
Effect
 InheritedstartDelay : int = 0
Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet.
Effect
 Inheritedtarget : Object
Objet auquel s’applique cet effet.
Effect
 Inheritedtargets : Array
Tableau d’objets représentant des cibles de l’effet.
Effect
 InheritedtriggerEvent : 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
 PropriétéDéfini par
 InheritedapplyTransitionEndProperties : 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
 InheritedendValuesCaptured : 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
 MéthodeDéfini par
  
Animate(target:Object = null)
Constructeur.
Animate
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet.
Effect
 Inherited
Crée une seule instance d’effet et l’initialise.
Effect
 Inherited
createInstances(targets:Array = null):Array
Prend un tableau d’objets cible et invoque la méthode createInstance() sur chaque cible.
Effect
 Inherited
Supprime les écouteurs d’événement d’une instance et les retire de la liste d’instances.
Effect
 Inherited
Distribue un événement dans le flux d’événements.
EventDispatcher
 Inherited
end(effectInstance:IEffectInstance = null):void
Interrompt un effet en cours de lecture et passe immédiatement à la fin de l’effet.
Effect
 Inherited
Renvoie un tableau de chaînes, où chaque chaîne correspond au nom d’une propriété modifiée par cet effet.
Effect
 Inherited
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
EventDispatcher
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
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
 Inherited
Interrompt momentanément l’effet jusqu’à un appel de la méthode resume().
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Commence la lecture de l’effet.
Effect
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
EventDispatcher
 Inherited
Reprend l’effet après une interruption demandée par un appel de la méthode pause().
Effect
 Inherited
Exécute l’effet en sens inverse, si l’effet est en cours de lecture, à partir de sa position actuelle.
Effect
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Arrête l’effet, en laissant les cibles de l’effet dans leur état actuel.
Effect
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
 Inherited
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
 MéthodeDéfini par
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
Utilisée en interne par l’infrastructure Effect.
Effect
 Inherited
Appelée à la fin de la lecture d’une instance d’effet.
Effect
 Inherited
Cette méthode est appelée lorsque l’instance d’effet commence.
Effect
 Inherited
Appelée lorsqu’une instance d’effet a été interrompue par un appel de la méthode stop().
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
Détermine la logique de filtrage d’une instance d’effet.
Effect
 Inherited
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
 Inherited
Copie les propriétés de l’effet vers l’instance d’effet.
Effect
Evénements
 Evénement Synthèse Défini par
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.EventDispatcher
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.EventDispatcher
 InheritedDistribué 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
  Distribué au début de chaque répétition de l’effet, dans le cas d’un effet répété.Animate
 InheritedDiffusé lorsque l’exécution de l’effet commence.Effect
 InheritedDistribué 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
  Distribué chaque fois que l’effet met à jour la cible.Animate
Détails de la propriété

disableLayout

propriété
disableLayout:Boolean

Version du langage: ActionScript 3.0
Version du produit: Flex 4
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Si la valeur est true, l’effet désactive la mise en page de son objet parent des cibles aux conteneurs, aux conteneurs la définition de la propriété autoLayout sur false, et désactive également une mise en page contrainte sur les objets cible. Ces propriétés seront restaurées lorsque l’effet se termine.

La valeur par défaut est false.



Implémentation
    public function get disableLayout():Boolean
    public function set disableLayout(value:Boolean):void

easer

propriété 
easer:IEaser

Version du langage: ActionScript 3.0
Version du produit: Flex 4
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Comportement d’accélération de cet effet. Cet objet IEaser est utilisé pour convertir la partie écoulée de l’animation en partie accélérée, qui est ensuite utilisée pour calculer la valeur au niveau de cette fraction écoulée accélérée.

Remarque : il est possible d’avoir une accélération au niveau de l’effet et au niveau de l’image-clé (où les images-clés contiennent les valeurs/heures utilisées dans les structures d’accélération). Ces comportements d’accélération se construisent les uns sur les autres. Le paramètre easier contrôle l’accélération de l’effet global. Keyframe contrôle l’accélération dans un intervalle de l’animation. Par défaut, l’accélération pour animer est non linéaire (Sine(.5)), tandis que l’option Accélération pour les images Keyframe est linéaire. Si vous souhaitez un effet avec l’accélération au niveau de l’image-clé, vous pouvez choisir de définir l’accélération de l’effet sur linéaire, puis définissez l’option Accélération spécifiquement sur les images Keyframe.

La valeur par défaut est spark.effects.easing.Sine(.5).



Implémentation
    public function get easer():IEaser
    public function set easer(value:IEaser):void

Eléments de l’API associés

interpolator

propriété 
interpolator:IInterpolator

Version du langage: ActionScript 3.0
Version du produit: Flex 4
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Interpolateur utilisé par cet effet pour calculer les valeurs situées entre les valeurs de début et de fin d’une propriété. Par défaut, la classe NumberInterpolator gère l’interpolation ou, dans les cas où les valeurs de début et de fin sont des tableaux ou des vecteurs, par la classe MultiValueInterpolator. L’interpolation d’autres types ou de valeurs Number devant être interpolées de façon différente, par exemple des valeurs uint contenant des informations de canal de couleur, peut être traitée en spécifiant un autre interpolateur.



Implémentation
    public function get interpolator():IInterpolator
    public function set interpolator(value:IInterpolator):void

Eléments de l’API associés

motionPaths

propriété 
motionPaths:Vector.<MotionPath>

Version du langage: ActionScript 3.0
Version du produit: Flex 4
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

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. Ce vecteur est prioritaire par rapport aux propriétés déclarées dans les sous-classes de la classe Animate. Par exemple, si ce tableau est défini directement sur un effet Move, toutes les propriétés de l’effet Move, par exemple xFrom, sont ignorées.



Implémentation
    public function get motionPaths():Vector.<MotionPath>
    public function set motionPaths(value:Vector.<MotionPath>):void

repeatBehavior

propriété 
repeatBehavior:String

Version du langage: ActionScript 3.0
Version du produit: Flex 4
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Comportement d’un effet répété, c’est-à-dire d’un effet dont la valeur repeatCount est égale à 0 ou supérieure à 1. Cette valeur doit être soit RepeatBehavior.LOOP, auquel cas l’animation est répétée systématiquement dans le même sens, soit RepeatBehavior.REVERSE, auquel cas l’animation est inversée à chaque répétition.

La valeur par défaut est RepeatBehavior.LOOP.



Implémentation
    public function get repeatBehavior():String
    public function set repeatBehavior(value:String):void
Détails du constructeur

Animate

()Constructeur
public function Animate(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.
Détails de l’événement

effectRepeat

Evénement
Type d’objet d’événement: mx.events.EffectEvent
propriété EffectEvent.type = mx.events.EffectEvent.EFFECT_REPEAT

Version du langage: ActionScript 3.0
Version du produit: Flex 4
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribué au début de chaque répétition de l’effet, dans le cas d’un effet répété. Flex distribue en même temps un événement effectUpdate pour l’effet.

La constante EffectEvent.EFFECT_REPEAT définit la valeur de la propriété type de l’objet d’événement d’un événement effectRepeat.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

PropriétéValeur
bubblesfalse
cancelablefalse
currentTargetObjet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget.
effectInstanceObjet d’instance d’effet de l’événement.
targetObjet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget.

effectUpdate

Evénement  
Type d’objet d’événement: mx.events.EffectEvent
propriété EffectEvent.type = mx.events.EffectEvent.EFFECT_UPDATE

Version du langage: ActionScript 3.0
Version du produit: Flex 4
Versions du moteur d’exécution: Flash Player 10, AIR 1.5

Distribué chaque fois que l’effet met à jour la cible.

La constante EffectEvent.EFFECT_UPDATE définit la valeur de la propriété type de l’objet d’événement d’un événement effectUpdate.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

PropriétéValeur
bubblesfalse
cancelablefalse
currentTargetObjet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget.
effectInstanceObjet d’instance d’effet de l’événement.
targetObjet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget.
AnimateEffectExample.mxml
<?xml version="1.0"?>
<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">

    <fx:Declarations>
        <s:Animate id="animateEffect"
            target="{targetBox}" repeatCount="2" repeatBehavior="reverse" disableLayout="true" effectStart="playButton.enabled=false" effectEnd="playButton.enabled=true;">
            <s:motionPaths>
                <s:SimpleMotionPath property="x" valueFrom="0" valueTo="100"/>
                <s:SimpleMotionPath property="alpha" valueFrom="1" valueTo="0"/>
            </s:motionPaths>
        </s:Animate>
    </fx:Declarations>

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

        <mx:HBox width="100%" height="100%">
            <!-- Our target to affect-->
            <mx:VBox id="targetBox" width="50%"  horizontalAlign="center">
                <mx:Label text="Nokia 9930" />
                <mx:Image id="targetImg" source="@Embed(source='assets/Nokia_6630.png')"/>
            </mx:VBox>
            <mx:VBox id="detailsBox" width="50%" left="0">
                <mx:Text width="99%" color="blue"
                    text="The Animate effect animates any property or style of an object over time using animationProperty arrays. Click 'Animate' to watch the effect."/>
            </mx:VBox>
        </mx:HBox>

        <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 id="playButton"
            left="5" bottom="5"
            label="Animate"
            click="animateEffect.play();"/>
    </s:Panel>
</s:Application>




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.