Packageflash.filters
Classepublic final class BevelFilter
HéritageBevelFilter Inheritance BitmapFilter Inheritance Object

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

La classe BevelFilter permet d'appliquer un effet de biseau à des objets d'affichage. L'effet de biseau donne aux objets tels que des boutons un aspect tridimensionnel. Vous pouvez personnaliser l'aspect du biseau grâce à différentes couleurs d'éclairage et d'ombre, à la quantité de flou sur le biseau, à l'angle du biseau, au positionnement du biseau et à un effet 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.

Pour créer un filtre, utilisez le constructeur new BevelFilter(). L'utilisation de filtres dépend de l'objet auquel vous appliquez le 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 lui-même est redimensionné (si les propriétés scaleX et scaleY ne sont pas définies sur 100 %), l'effet de filtre n'est pas redimensionné. 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 192 pixels en largeur ou en hauteur, et le nombre total de pixels ne peut pas excéder 16 777 216 pixels. (Ainsi, si la largeur d'une image est de 8 192 pixels, sa hauteur maximale doit être de 2 048 pixels.) Dans Flash Player 9 et les versions antérieures, ainsi que dans AIR 1.1 et les versions antérieures, la limite est de 2 880 pixels de haut sur 2 880 pixels de large. 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.

Consulter les exemples

Voir aussi

flash.display.DisplayObject.filters
flash.display.DisplayObject.cacheAsBitmap
flash.display.BitmapData.applyFilter()


Propriétés publiques
 PropriétéDéfini par
  angle : Number
Angle du biseau.
BevelFilter
  blurX : Number
Quantité de flou horizontal, en pixels.
BevelFilter
  blurY : Number
Quantité de flou vertical, en pixels.
BevelFilter
 Inheritedconstructor : 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.
BevelFilter
  highlightAlpha : Number
Valeur de transparence alpha de la couleur d'éclairage.
BevelFilter
  highlightColor : uint
Couleur d'éclairage du biseau.
BevelFilter
  knockout : Boolean
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.
BevelFilter
 Inheritedprototype : Object
[statique] Référence à l'objet prototype d'un objet de classe ou fonction.
Object
  quality : int
Nombre d'applications du filtre.
BevelFilter
  shadowAlpha : Number
Valeur de transparence alpha de la couleur d'ombre.
BevelFilter
  shadowColor : uint
La couleur d'ombre du biseau.
BevelFilter
  strength : Number
Intensité de l'empreinte ou recouvrement.
BevelFilter
  type : String
Positionnement de l'effet de biseau sur l'objet.
BevelFilter
Méthodes publiques
 MéthodeDéfini par
  
BevelFilter(distance:Number = 4.0, angle:Number = 45, highlightColor:uint = 0xFFFFFF, highlightAlpha:Number = 1.0, shadowColor:uint = 0x000000, shadowAlpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = "inner", knockout:Boolean = false)
Initialise une nouvelle occurrence de BevelFilter avec les paramètres spécifiés.
BevelFilter
  
Renvoie une copie de cet objet filtre.
BevelFilter
 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
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d'une propriété dynamique pour les opérations en boucle.
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
Détails de la propriété
anglepropriété
angle:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Angle du biseau. Les valeurs valides sont comprises entre 0 et 360°. La valeur par défaut est 45°.

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.



Implémentation
    public function get angle():Number
    public function set angle(value:Number):void
blurXpropriété 
blurX:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Quantité de flou horizontal, en pixels. Les valeurs valides sont comprises entre 0 et 255 (virgule flottante). La valeur par défaut est 4. Les valeurs correspondant à une puissance de 2 (telles que 2, 4, 8, 16 et 32) sont optimisées pour obtenir un rendu plus rapide qu'avec les autres valeurs.



Implémentation
    public function get blurX():Number
    public function set blurX(value:Number):void
blurYpropriété 
blurY:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Quantité de flou vertical, en pixels. Les valeurs valides sont comprises entre 0 et 255 (virgule flottante). La valeur par défaut est 4. Les valeurs correspondant à une puissance de 2 (telles que 2, 4, 8, 16 et 32) sont optimisées pour obtenir un rendu plus rapide qu'avec les autres valeurs.



Implémentation
    public function get blurY():Number
    public function set blurY(value:Number):void
distancepropriété 
distance:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

La distance de décalage du biseau. Les valeurs valides sont en pixels (virgule flottante). La valeur par défaut est de 4.



Implémentation
    public function get distance():Number
    public function set distance(value:Number):void
highlightAlphapropriété 
highlightAlpha:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Valeur de transparence alpha de la couleur d'éclairage. Cette valeur est spécifiée en tant que valeur normalisée comprise 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 highlightAlpha():Number
    public function set highlightAlpha(value:Number):void
highlightColorpropriété 
highlightColor:uint  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Couleur d'éclairage du biseau. Les valeurs valides sont au format hexadécimal, 0xRRGGBB. La valeur par défaut est 0xFFFFFF.



Implémentation
    public function get highlightColor():uint
    public function set highlightColor(value:uint):void
knockoutpropriété 
knockout:Boolean  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

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. La valeur par défaut est false (pas de masquage).



Implémentation
    public function get knockout():Boolean
    public function set knockout(value:Boolean):void
qualitypropriété 
quality:int  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Nombre d'applications du filtre. La valeur par défaut est BitmapFilterQuality.LOW, ce qui revient à appliquer le filtre une seule fois. La valeur BitmapFilterQuality.MEDIUM applique le filtre deux fois. La valeur BitmapFilterQuality.HIGH l'applique trois fois. Les rendus des filtres de valeurs faibles sont obtenus plus rapidement.

Pour la plupart des applications, une valeur de quality faible, moyenne ou élevée est suffisante. Il est possible d'utiliser des valeurs numériques allant jusqu'à 15 pour obtenir différents effets, mais le rendu des valeurs les plus élevées est moins rapide. Sans augmenter la valeur de quality, vous pouvez généralement obtenir un effet similaire, avec un rendu plus rapide, en augmentant simplement les valeurs des propriétés blurX et blurY.

Vous pouvez utiliser les constantes BitmapFilterQuality suivantes pour spécifier les valeurs de la propriété quality :



Implémentation
    public function get quality():int
    public function set quality(value:int):void
shadowAlphapropriété 
shadowAlpha:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Valeur de transparence alpha de la couleur d'ombre. Cette valeur est spécifiée en tant que valeur normalisée comprise entre 0 et 1. Par exemple, 0,25 définit une valeur de transparence de 25 %. La valeur par défaut est de 1.



Implémentation
    public function get shadowAlpha():Number
    public function set shadowAlpha(value:Number):void
shadowColorpropriété 
shadowColor:uint  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

La couleur d'ombre du biseau. Les valeurs valides sont au format hexadécimal, 0xRRGGBB. La valeur par défaut est 0x000000.



Implémentation
    public function get shadowColor():uint
    public function set shadowColor(value:uint):void
strengthpropriété 
strength:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Intensité de l'empreinte ou recouvrement. Les valeurs valides sont comprises entre 0 et 255. Plus la valeur est élevée, plus l'intensité des couleurs apparaît à l'impression et plus le contraste est important entre le biseau et l'arrière-plan. La valeur par défaut est 1.



Implémentation
    public function get strength():Number
    public function set strength(value:Number):void
typepropriété 
type:String  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Positionnement de l'effet de biseau sur l'objet. Les biseaux intérieurs et extérieurs sont placés au niveau des bords intérieurs ou extérieurs. Un biseau complet recouvre tout l'objet. Les valeurs gérées sont les constantes BitmapFilterType :



Implémentation
    public function get type():String
    public function set type(value:String):void

Valeur émise
TypeError — La chaîne prend la valeur null lors de sa définition.
Détails du constructeur
BevelFilter()Constructeur
public function BevelFilter(distance:Number = 4.0, angle:Number = 45, highlightColor:uint = 0xFFFFFF, highlightAlpha:Number = 1.0, shadowColor:uint = 0x000000, shadowAlpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = "inner", knockout:Boolean = false)

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Initialise une nouvelle occurrence de BevelFilter avec les paramètres spécifiés.

Paramètres
distance:Number (default = 4.0) — Distance de décalage du biseau, en pixels (virgule flottante).
 
angle:Number (default = 45) — Angle du biseau, de 0 à 360 degrés.
 
highlightColor:uint (default = 0xFFFFFF) — Couleur de surbrillance du biseau, 0xRRGGBB.
 
highlightAlpha:Number (default = 1.0) — Valeur de transparence alpha de la couleur d'éclairage. Les valeurs valides sont comprises entre 0.0 et 1.0. Par exemple, 0,25 définit une valeur de transparence de 25 %.
 
shadowColor:uint (default = 0x000000) — Couleur d'ombre du biseau, 0xRRGGBB.
 
shadowAlpha: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, en pixels. Les valeurs valides sont comprises entre 0 et 255.0 (virgule flottante).
 
blurY:Number (default = 4.0) — Quantité de flou vertical en pixels. Les valeurs valides sont comprises entre 0 et 255.0 (virgule flottante).
 
strength:Number (default = 1) — Intensité de l'empreinte ou recouvrement. Plus la valeur est élevée, plus le recouvrement est intense et plus le contraste est important entre le biseau et l'arrière-plan. Les valeurs valides sont comprises entre 0 et 255.0.
 
quality:int (default = 1) — Qualité du biseau. Les valeurs gérées sont comprises entre 0 et 15, mais pour la plupart des applications, vous pouvez utiliser les constantes BitmapFilterQuality :
  • BitmapFilterQuality.LOW
  • BitmapFilterQuality.MEDIUM
  • BitmapFilterQuality.HIGH

Le rendu des filtres de valeur faible est plus rapide. Vous pouvez utiliser les autres valeurs numériques disponibles pour obtenir des effets différents.

 
type:String (default = "inner") — Le type de biseau. Les valeurs gérées sont les constantes BitmapFilterType : BitmapFilterType.INNER, BitmapFilterType.OUTER ou BitmapFilterType.FULL.
 
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.

Voir aussi

Détails de la méthode
clone()méthode
override public function clone():BitmapFilter

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Renvoie une copie de cet objet filtre.

Valeur renvoyée
BitmapFilter — Nouvelle occurrence de BevelFilter dont toutes les propriétés sont identiques à celles de l'occurrence de BevelFilter d'origine.
Exemples Utilisation des exemples
BevelFilterExample.as

L'exemple suivant crée un carré jaune foncé et applique un biseau d'une couleur de surbrillance (0xFFFF00) jaune vif avec une ombre (0x0000FF) bleue. La séquence des principales tâches de cet exemple s'organise comme suit :
  1. Importation des classes requises.
  2. Déclaration des trois propriétés utilisées dans la fonction draw() qui dessine l'objet auquel le filtre de biseau est appliqué.
  3. Création de la fonction constructeur BevelFilterExample() qui effectue les actions suivantes :
    • Appel de la fonction draw() qui est déclarée ultérieurement.
    • Déclaration d'une variable filter comme objet BitmapFilter et attribution de celui-ci à la valeur renvoyée d'un appel à getBitmapFilter().
    • Création d'un nouvel objet Array myFilters, ajout de filter au tableau, puis attribution de myFilters à la propriété filters de l'objet BevelFilterExample. Ceci a pour effet d'appliquer tous les filtres trouvés dans myFilters, en l'occurrence filter uniquement.
  4. Création de la fonction getBitmapFilter afin de créer et de définir des propriétés pour le filtre.
  5. Création de la fonction draw(). Cette fonction utilise des méthodes de la classe Graphics, accessibles par le biais de la propriété graphics de la classe Sprite, pour dessiner le carré.
package {
    import flash.display.Sprite;
    import flash.filters.BevelFilter;
    import flash.filters.BitmapFilter;
    import flash.filters.BitmapFilterQuality;
    import flash.filters.BitmapFilterType;

    public class BevelFilterExample extends Sprite {
        private var bgColor:uint = 0xFFCC00;
        private var size:uint    = 80;
        private var offset:uint  = 50;

        public function BevelFilterExample() {
            draw();
            var filter:BitmapFilter = getBitmapFilter();
            var myFilters:Array = new Array();
            myFilters.push(filter);
            filters = myFilters;
        }

        private function getBitmapFilter():BitmapFilter {
            var distance:Number       = 5;
            var angleInDegrees:Number = 45;
            var highlightColor:Number = 0xFFFF00;
            var highlightAlpha:Number = 0.8;
            var shadowColor:Number    = 0x0000FF;
            var shadowAlpha:Number    = 0.8;
            var blurX:Number          = 5;
            var blurY:Number          = 5;
            var strength:Number       = 5;
            var quality:Number        = BitmapFilterQuality.HIGH;
            var type:String           = BitmapFilterType.INNER;
            var knockout:Boolean      = false;

            return new BevelFilter(distance,
                                   angleInDegrees,
                                   highlightColor,
                                   highlightAlpha,
                                   shadowColor,
                                   shadowAlpha,
                                   blurX,
                                   blurY,
                                   strength,
                                   quality,
                                   type,
                                   knockout);
        }

        private function draw():void {
            graphics.beginFill(bgColor);
            graphics.drawRect(offset, offset, size, size);
            graphics.endFill();
        }
    }
}