| Package | mx.effects.effectClasses |
| Classe | public class MaskEffectInstance |
| Héritage | MaskEffectInstance  EffectInstance EventDispatcher Object |
| Sous-classes | IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Chaque classe d’effet est une sous-classe de la classe TweenEffect qui prend en charge les événements suivants :
-
tweenEnd: distribué lorsque l’effet tween prend fin. -
tweenUpdate: distribué chaque fois qu’une classe calcule une nouvelle valeur.
L’objet d’événement transmis à l’écouteur d’événements pour ces événements est de type TweenEvent. La classe TweenEvent définit lavaleur de propriété qui contient la valeur tween calculée par l’effet. Pour l’effet Mask, la propriété TweenEvent.value contient un tableau à 4 éléments dans lequel :
- value[0]:Number correspond à la valeur de la propriété
xde la cible. - value[1]:Number correspond à la valeur de la propriété
yde la cible - value[2]:Number correspond à la valeur de la propriété
scaleXde la cible. - value[3]:Number correspond à la valeur de la propriété
scaleYde la cible.
Eléments de l’API associés
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
 | className : String [lecture seule]
Nom de la classe d’effet, tel que « FadeInstance ». | EffectInstance | |
| constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| createMaskFunction : Function
Fonction appelée lorsque l’effet crée le masque. | MaskEffectInstance | ||
| duration : Number
Durée de l’effet, en millisecondes. | EffectInstance | |
| effect : IEffect
Objet IEffect qui a créé cet objet IEffectInstance. | EffectInstance | |
| effectTargetHost : mx.effects:IEffectTargetHost
Propriété qui permet d’accéder au contrôle à base de liste de la cible d’un effet data. | EffectInstance | |
| hideFocusRing : Boolean
Détermine si l’effet doit masquer l’anneau de focus lors du démarrage. | EffectInstance | |
| moveEasingFunction : Function
Fonction d’accélération à utiliser pour déplacer le masque. | MaskEffectInstance | ||
| playheadTime : Number
Temps de position actuelle de l’effet. | EffectInstance | |
| propertyChanges : PropertyChanges
Spécifie l’objet PropertyChanges contenant les valeurs de départ et d’arrivée de l’ensemble des propriétés correspondant aux cibles de l’effet. | EffectInstance | |
| repeatCount : int
Nombre de fois que l’effet doit être répété. | EffectInstance | |
| repeatDelay : int
Intervalle (en millisecondes), qui s’écoule avant de répéter l’effet. | EffectInstance | |
| scaleEasingFunction : Function
Fonction d’accélération à utiliser pour la mise à l’échelle du masque. | MaskEffectInstance | ||
| scaleXFrom : Number
Propriété scaleX initiale du masque. | MaskEffectInstance | ||
| scaleXTo : Number
Propriété scaleX d’arrivée du masque. | MaskEffectInstance | ||
| scaleYFrom : Number
Propriété scaleY de départ du masque. | MaskEffectInstance | ||
| scaleYTo : Number
Propriété scaleY d’arrivée du masque. | MaskEffectInstance | ||
| showTarget : Boolean
Indique que le composant cible prend la valeur visible, false, invisible ou true. | MaskEffectInstance | ||
| startDelay : int
Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet. | EffectInstance | |
| suspendBackgroundProcessing : Boolean
Si la valeur est true, elle bloque tout le traitement en arrière-plan pendant l’exécution de l’effet. | EffectInstance | |
| target : Object
Objet UIComponent sur lequel cet effet est appliqué. | EffectInstance | |
| targetArea : Rectangle
Zone dans laquelle le masque est appliqué à la cible. | MaskEffectInstance | ||
| triggerEvent : Event
L’événement, le cas échéant, qui a déclenché la lecture de l’effet. | EffectInstance | |
| xFrom : Number
Coordonnée x de la position de départ du masque. | MaskEffectInstance | ||
| xTo : Number
Coordonnée x de la position d’arrivée du masque. | MaskEffectInstance | ||
| yFrom : Number
Coordonnée y de la position de départ du masque. | MaskEffectInstance | ||
| yTo : Number
Coordonnée y de la position d’arrivée du masque. | MaskEffectInstance | ||
| Propriété | Défini par | ||
|---|---|---|---|
| effectMask : Shape
Contient le masque de l’effet, soit le masque par défaut créé par la méthode defaultCreateMask() ou par celle spécifiée par la fonction transmise à la propriété createMaskFunction property. | MaskEffectInstance | ||
| playCount : int = 0
Nombre de fois que l’instance a été exécutée. | EffectInstance | |
| targetVisualBounds : Rectangle
Taille réelle de la cible de l’effet, y compris les ombres portées. | MaskEffectInstance | ||
| Méthode | Défini par | ||
|---|---|---|---|
MaskEffectInstance(target:Object)
Constructeur. | MaskEffectInstance | ||
| 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 | |
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
|
Interrompt une instance d’effet en cours de lecture et passe immédiatement à la fin de l’effet. | EffectInstance | |
|
Appelée par la méthode end() à la fin de la lecture de l’effet. | EffectInstance | |
|
Appelé à la fin de la lecture de chaque itération d’un effet répété. | EffectInstance | |
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
Cette méthode est appelée si l’effet a été déclenché par le gestionnaire EffectManager. | EffectInstance | |
|
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 | |
[override]
Interrompt momentanément l’effet jusqu’à un appel de la méthode resume(). | MaskEffectInstance | ||
|
Exécute l’instance d’effet sur la cible. | EffectInstance | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
[override]
Reprend l’effet après une interruption demandée par un appel de la méthode pause(). | MaskEffectInstance | ||
[override]
Exécute l’effet en sens inverse, à partir de sa position actuelle. | MaskEffectInstance | ||
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Exécute l’instance d’effet sur la cible, au terme de la période startDelay. | EffectInstance | |
|
Arrête l’effet, en laissant la cible dans son état actuel. | EffectInstance | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
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éthode | Défini par | ||
|---|---|---|---|
Crée le masque par défaut de l’effet. | MaskEffectInstance | ||
Initialise les propriétés de déplacement et de dimensionnement de l’effet. | MaskEffectInstance | ||
Méthode de rappel appelée lorsque les positions x et y du masque doivent être mises à jour par l’effet pour la dernière fois. | MaskEffectInstance | ||
Méthode de rappel appelée lorsque les positions x et y du masque doivent être mises à jour par l’effet. | MaskEffectInstance | ||
Méthode de rappel appelée lorsque les propriétés scaleX et scaleY du masque doivent être mises à jour par l’effet pour la dernière fois | MaskEffectInstance | ||
Méthode de rappel appelée lorsque les propriétés scaleX et scaleY du masque doivent être mises à jour par l’effet. | MaskEffectInstance | ||
createMaskFunction | propriété |
createMaskFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction appelée lorsque l’effet crée le masque. La valeur par défaut est une fonction qui renvoie un Rectangle avec les mêmes dimensions que celles de la cible de l’effet.
Vous pouvez utiliser cette propriété pour spécifier votre propre fonction de rappel afin de dessiner le masque. Cette fonction doit présenter la signature suivante :
public function createLargeMask(targ:Object, bounds:Rectangle):Shape {
var myMask:Shape = new Shape();
// Create mask.
return myMask;
}
Vous devez définir cette propriété sur le nom de la fonction, comme l’illustre l’exemple suivant pour l’effet WipeLeft :
<mx:WipeLeft id="showWL" createMaskFunction="createLargeMask" showTarget="false"/>
Implémentation
public function get createMaskFunction():Function public function set createMaskFunction(value:Function):voideffectMask | propriété |
protected var effectMask:Shape| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Contient le masque de l’effet, soit le masque par défaut créé par la méthode defaultCreateMask ou par celle spécifiée par la fonction transmise à la propriété createMaskFunction property.
moveEasingFunction | propriété |
public var moveEasingFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction d’accélération à utiliser pour déplacer le masque.
scaleEasingFunction | propriété |
public var scaleEasingFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction d’accélération à utiliser pour la mise à l’échelle du masque.
scaleXFrom | propriété |
public var scaleXFrom:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Propriété scaleX initiale du masque.
scaleXTo | propriété |
public var scaleXTo:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Propriété scaleX d’arrivée du masque.
scaleYFrom | propriété |
public var scaleYFrom:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Propriété scaleY de départ du masque.
scaleYTo | propriété |
public var scaleYTo:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Propriété scaleY d’arrivée du masque.
showTarget | propriété |
showTarget:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Indique que le composant cible prend la valeur visible, false, invisible ou true.
La valeur par défaut est true.
Implémentation
public function get showTarget():Boolean public function set showTarget(value:Boolean):voidtargetArea | propriété |
public var targetArea:Rectangle| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Zone dans laquelle le masque est appliqué à la cible. Les dimensions sont établies par rapport à la cible elle-même. Par défaut, la zone est la cible entière et est créée de la manière suivante :new Rectangle(0, 0, target.width, target.height);.
targetVisualBounds | propriété |
protected var targetVisualBounds:Rectangle| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Taille réelle de la cible de l’effet, y compris les ombres portées. Flex calcule la valeur de cette propriété. Vous n’avez pas à la définir.
xFrom | propriété |
public var xFrom:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Coordonnée x de la position de départ du masque.
xTo | propriété |
public var xTo:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Coordonnée x de la position d’arrivée du masque.
yFrom | propriété |
public var yFrom:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Coordonnée y de la position de départ du masque.
yTo | propriété |
public var yTo:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Coordonnée y de la position d’arrivée du masque.
MaskEffectInstance | () | Constructeur |
defaultCreateMask | () | méthode |
protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shape| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Crée le masque par défaut de l’effet.
Paramètres
targ:Object — Cible de l’effet.
| |
bounds:Rectangle — Les véritables limites de la cible qui inclut des ombres portées
|
Shape — Objet Shape qui définit le masque.
|
initMaskEffect | () | méthode |
protected function initMaskEffect():void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Initialise les propriétés move et scale de l’effet. Toutes les sous-classes doivent remplacer cette fonction. Flex appelle cette fonction une fois le masque créé, mais avant la création des tweens.
onMoveTweenEnd | () | méthode |
protected function onMoveTweenEnd(value:Object):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Méthode de rappel appelée lorsque les positions x et y du masque doivent être mises à jour par l’effet pour la dernière fois Vous n’appelez pas cette méthode directement. Cette méthode implémente la méthode de la super-classe.
Paramètres
value:Object — Contient la dernière valeur x et y pour la position du masque, où value[0] contient la position x du masque et value[1] contient sa position y.
|
onMoveTweenUpdate | () | méthode |
protected function onMoveTweenUpdate(value:Object):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Méthode de rappel appelée lorsque les positions x et y du masque doivent être mises à jour par l’effet. Vous n’appelez pas cette méthode directement. Cette méthode implémente la méthode de la super-classe.
Paramètres
value:Object — Contient une valeur interpolée x et y de la position du masque, où value[0] contient la nouvelle position x du masque et value[1] contient sa nouvelle position y.
|
onScaleTweenEnd | () | méthode |
protected function onScaleTweenEnd(value:Object):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Méthode de rappel appelée lorsque les propriétés scaleX et scaleY du masque doivent être mises à jour pour la dernière fois. Vous n’appelez pas cette méthode directement. Cette méthode implémente la méthode de la super-classe.
Paramètres
value:Object — Contient la dernière valeur scaleX et scaleY du masque, où value[0] contient la valeur scaleX du masque et value[1] contient la valeur scaleY.
|
onScaleTweenUpdate | () | méthode |
protected function onScaleTweenUpdate(value:Object):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Méthode de rappel appelée lorsque les propriétés scaleX et scaleY du masque doivent être mises à jour par l’effet. Vous n’appelez pas cette méthode directement. Cette méthode implémente la méthode de la super-classe.
Paramètres
value:Object — Contient une valeur interpoléescaleX et scaleY du masque, où value[0] contient la nouvelle valeur scaleX du masque et value[1] contient la nouvelle valeur scaleY.
|
pause | () | méthode |
override public function pause():void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Interrompt momentanément l’effet jusqu’à un appel de la méthode resume().
resume | () | méthode |
override public function resume():void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Reprend l’effet après une interruption demandée par un appel de la méthode pause().
reverse | () | méthode |
override public function reverse():void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Exécute l’effet en sens inverse, à partir de sa position actuelle.
Tue Jun 12 2018, 09:30 AM Z