DropShadowFilter

Package	spark.filters
Classe	public class DropShadowFilter
Héritage	DropShadowFilter BaseDimensionFilter BaseFilter EventDispatcher Object
Implémente	IBitmapFilter

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La classe DropShadowFilter permet d’ajouter un effet d’ombre portée aux objets d’affichage. L’algorithme d’ombre est dérivé du même filtre que celui utilisé par le filtre de flou. Vous disposez de plusieurs options pour définir le style de l’ombre portée, notamment l’ombre intérieure ou extérieure et le mode de masquage. Vous pouvez appliquer le filtre à tout objet d’affichage (autrement dit, aux objets héritant des propriétés de la classe DisplayObject), tels que MovieClip, SimpleButton, TextField et Video, ainsi qu’aux objets BitmapData.

L’utilisation de filtres dépend de l’objet auquel vous appliquez le filtre.

Pour appliquer des filtres aux objets d’affichage, utilisez la propriété filters (héritée de DisplayObject). Lorsque vous définissez la propriété filters d’un objet, celui-ci n’est pas modifié. En outre, vous pouvez supprimer la propriété filters pour enlever le filtre.
Pour appliquer des filtres aux objets BitmapData, utilisez la méthode BitmapData.applyFilter(). L’appel de applyFilter() pour un objet BitmapData génère une image filtrée à partir de l’objet BitmapData source et de l’objet filtre.

Si vous appliquez un filtre à un objet d’affichage, la valeur de la propriété cacheAsBitmap de cet objet est définie sur true. Si vous supprimez tous les filtres, la valeur d’origine de cacheAsBitmap est restaurée.

Ce filtre prend en charge le redimensionnement de la scène. Cependant, il ne prend pas en charge le redimensionnement général, la rotation ni l’inclinaison. Si l’objet est redimensionné (si les propriétés scaleX et scaleY ne sont pas réglées sur 1,0), le filtre ne l’est pas. Le redimensionnement est effectué uniquement en cas de zoom avant sur la scène.

Aucun filtre n’est appliqué si l’image obtenue dépasse les dimensions maximales. Dans AIR 1.5 et Flash Player 10, la taille maximale est de 8 191 pixels en largeur ou en hauteur, et le nombre total de pixels ne peut pas excéder 16 777 215 pixels (ainsi, si la largeur d’une image est de 8 191 pixels, sa hauteur maximale doit être de 2 048 pixels). Par exemple, si vous effectuez un zoom avant sur un clip de grande taille auquel un filtre est appliqué, le filtre sera désactivé si l’image obtenue dépasse les dimensions maximales.

Syntaxe MXML expanded

Masquer la syntaxe MXML

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

  <s:DropShadowFilter 
    Properties
    alpha="1"
    angle="45"
    color="0xFF0000"
    distance="4"
    hideObject="false"
    inner="false"
  />

Consulter les exemples

Eléments de l’API associés

flash.filters.DropShadowFilter

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
		alpha : Number Valeur de transparence alpha de la couleur.	DropShadowFilter
		angle : Number Angle du biseau.	DropShadowFilter
		blurX : Number Quantité de flou horizontal.	BaseDimensionFilter
		blurY : Number Quantité de flou vertical.	BaseDimensionFilter
		color : uint Couleur du rayonnement.	DropShadowFilter
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		distance : Number La distance de décalage du biseau.	DropShadowFilter
		hideObject : Boolean Indique si l’objet est caché ou non.	DropShadowFilter
		inner : Boolean Spécifie si le rayonnement est interne.	DropShadowFilter
		knockout : Boolean Spécifie si l’objet a un effet de masquage.	BaseDimensionFilter
		quality : int Nombre d’applications du filtre.	BaseDimensionFilter
		strength : Number Intensité de l’empreinte ou recouvrement.	BaseDimensionFilter

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		DropShadowFilter(distance:Number = 4.0, angle:Number = 45, color:uint = 0, alpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1.0, quality:int = 1, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false) Constructeur.	DropShadowFilter
		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
		clone():BitmapFilter Renvoie une copie de cet objet filtre.	DropShadowFilter
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		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
		notifyFilterChanged():void Propage un événement change lorsque le filtre a été modifié.	BaseFilter
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		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

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

	Evénement		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

Constantes publiques

Masquer les constantes publiques héritées

Afficher les constantes publiques héritées

	Constante		Défini par

Détails de la propriété

alpha

propriété

alpha:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Valeur de transparence alpha de la couleur. Les valeurs possibles sont comprises entre 0 et 1. Par exemple, 0,25 définit une valeur de transparence de 25 %.

La valeur par défaut est 1.

Implémentation
public function get alpha():Number
public function set alpha(value:Number):void

angle

propriété

angle:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Angle du biseau. Les valeurs possibles sont comprises entre 0 et 360°. La valeur d’angle représente l’angle de la source lumineuse théorique éclairant l’objet et détermine l’emplacement de l’effet par rapport à ce dernier. Si la valeur de la propriété distance est définie sur 0, il n’y a pas d’effet de décalage par rapport à l’objet. La propriété angle n’a donc aucun effet.

La valeur par défaut est 45.

Implémentation
public function get angle():Number
public function set angle(value:Number):void

color

propriété

color:uint

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Couleur du rayonnement. Les valeurs disponibles sont au format hexadécimal 0xRRGGBB.

La valeur par défaut est 0xFF0000.

Implémentation
public function get color():uint
public function set color(value:uint):void

distance

propriété

distance:Number

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

La distance de décalage du biseau. Les valeurs possibles sont en pixels (virgule flottante).

La valeur par défaut est 4.

Implémentation
public function get distance():Number
public function set distance(value:Number):void

hideObject

propriété

hideObject:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Indique si l’objet est caché ou non. Une valeur true indique que l’objet lui-même n’est pas tracé et que seule l’ombre est visible. La valeur par défaut est false, soit montrer l’objet.

La valeur par défaut est false.

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

inner

propriété

inner:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Spécifie si le rayonnement est interne. La valeur true indique un rayonnement interne. La valeur par défaut est false, créant un rayonnement externe (au niveau des bords extérieurs de l’objet).

La valeur par défaut est false.

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

Détails du constructeur

()

Constructeur

public function DropShadowFilter(distance:Number = 4.0, angle:Number = 45, color:uint = 0, alpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1.0, quality:int = 1, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false)

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

	`distance:Number` (default = `4.0`) — Distance de décalage de l’ombre, en pixels.

	`angle:Number` (default = `45`) — Angle de l’ombre, de 0 à 360° (virgule flottante).

	`color:uint` (default = `0`) — Couleur de l’ombre, au format hexadécimal 0xRRGGBB. La valeur par défaut est 0x000000.

	`alpha:Number` (default = `1.0`) — Valeur de transparence alpha de la couleur d’ombre. Les valeurs valides sont comprises entre 0.0 et 1.0. Par exemple, 0,25 définit une valeur de transparence de 25 %.

	`blurX:Number` (default = `4.0`) — Quantité de flou horizontal. Les valeurs possibles sont comprises entre 0 et 255.0 (virgule flottante).

	`blurY:Number` (default = `4.0`) — Quantité de flou vertical. Les valeurs possibles sont comprises entre 0 et 255.0 (virgule flottante).

	`strength:Number` (default = `1.0`) — Intensité de l’empreinte ou recouvrement. Plus la valeur est élevée, plus le recouvrement est intense et plus le contraste est important entre l’ombre et l’arrière-plan. Les valeurs possibles sont comprises entre 0 et 255.0.

	`quality:int` (default = `1`) — Nombre d’applications du filtre. Utilisez les constantes BitmapFilterQuality : `BitmapFilterQuality.LOW` `BitmapFilterQuality.MEDIUM` `BitmapFilterQuality.HIGH` Pour plus d’informations sur ces valeurs, voir la description de la propriété `quality`.

	`inner:Boolean` (default = `false`) — Indique si l’ombre est intérieure ou non. La valeur `true` spécifie une ombre intérieure. La valeur `false` renvoie une ombre extérieure au niveau des bords extérieurs de l’objet.

	`knockout:Boolean` (default = `false`) — Applique un effet de masquage (`true`) qui, en réalité, rend le remplissage de l’objet transparent et révèle la couleur d’arrière-plan du document.

	`hideObject:Boolean` (default = `false`) — Indique si l’objet est caché ou non. La valeur `true` indique que l’objet lui-même n’est pas tracé et que seule l’ombre est visible.

Eléments de l’API associés

flash.filters.BitmapFilterQuality

Détails de la méthode

clone

()

méthode

public function clone():BitmapFilter

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie une copie de cet objet filtre.

Valeur renvoyée

BitmapFilter — Nouvelle occurrence de DropShadowFilter dont les propriétés sont toutes identiques à celles de l’occurrence de DropShadowFilter d’origine.

Exemples Comment utiliser cet exemple

DropShadowFilterExample.mxml

<?xml version="1.0"?>
<!-- filters/examples/DropShadowFilterExample.mxml -->
<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" 
    creationComplete="createFilters()">
    
  <fx:Script><![CDATA[ 
     import spark.filters.*;
     import flash.filters.BitmapFilterQuality;
     import flash.filters.BitmapFilterType;
  
     private var myDropShadowFilter:DropShadowFilter;  
     private var color:Number = 0xFF33FF;
  
     public function createFilters():void {        
        myDropShadowFilter = new DropShadowFilter(15, 45, 
            color, 0.8, 8, 8, 0.65, BitmapFilterQuality.MEDIUM, false, false);
        b1.filters = [myDropShadowFilter];
     }
  
  ]]></fx:Script>

    <s:VGroup>
        <!-- This button has a filter applied in ActionScript. -->
        <s:Button id="b1" label="Click me"/>
        
        <!-- This button has a filter applied in MXML. -->
        <s:Button id="b2" label="Click me">
            <s:filters>
                <s:DropShadowFilter 
                    distance="15" 
                    angle="45" 
                    color="0xFF33FF" 
                    alpha=".8" 
                    blurX="8" 
                    blurY="8" 
                    strength=".65" 
                    quality="{BitmapFilterQuality.MEDIUM}"
                    inner="false" 
                    knockout="false"/>
            </s:filters>
        </s:Button>
        
    </s:VGroup>        
</s:Application>

Informations juridiques | Politique de confidentialité en ligne

DropShadowFilter - AS3 Flex

Classes x

alpha

angle

color

distance

hideObject

inner

DropShadowFilter

clone