Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
GradientBevelFilter

Package | spark.filters
Class | public class GradientBevelFilter
Inheritance | GradientBevelFilter GradientFilter BaseDimensionFilter BaseFilter flash.events.EventDispatcher
Implements | IBitmapFilter

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The GradientBevelFilter class lets you apply a gradient bevel effect to display objects. A gradient bevel is a beveled edge, enhanced with gradient color, on the outside, inside, or top of an object. Beveled edges make objects look three-dimensional. You can apply the filter to any display object (that is, objects that inherit from the DisplayObject class), such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects.

The use of filters depends on the object to which you apply the filter:

- To apply filters to display objects, use the `filters` property. Setting the `filters` property of an object does not modify the object, and you can remove the filter by clearing the `filters` property.
- To apply filters to BitmapData objects, use the `BitmapData.applyFilter()` method. Calling `applyFilter()` on a BitmapData object takes the source BitmapData object and the filter object and generates a filtered image as a result.

If you apply a filter to a display object, the `cacheAsBitmap` property of the display object is set to `true`. If you clear all filters, the original value of `cacheAsBitmap` is restored.

This filter supports Stage scaling. However, it does not support general scaling, rotation, and skewing; if the object itself is scaled (if `scaleX` and `scaleY` are set to a value other than 1.0), the filter effect is not scaled. It is scaled only when the user zooms in on the Stage.

A filter is not applied if the resulting image exceeds the maximum dimensions. In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels wide, it can only be 2,048 pixels high.) For example, if you zoom in on a large movie clip with a filter applied, the filter is turned off if the resulting image exceeds the maximum dimensions.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<s:GradientBevelFilter>` tag inherits all of the tag attributes of its superclass and adds no tag attributes:

      <s:GradientBevelFilter/>

Default MXML Property `entries`

View the examples

See also

spark.filters.BevelFilter
flash.filters.GradientBevelFilter
GradientBevelFilter.ratios
flash.display.BitmapData.applyFilter()
flash.display.DisplayObject.filters
flash.display.DisplayObject.cacheAsBitmap

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | angle : Number The angle, in degrees. | GradientFilter
|  | blurX : Number The amount of horizontal blur. | BaseDimensionFilter
|  | blurY : Number The amount of vertical blur. | BaseDimensionFilter
|  | distance : Number The offset distance of the glow. | GradientFilter
|  | entries : Array An Array of GradientEntry objects defining the fill patterns for the gradient fill. | GradientFilter
|  | knockout : Boolean Specifies whether the object has a knockout effect. | BaseDimensionFilter
|  | quality : int The number of times to apply the filter. | BaseDimensionFilter
|  | strength : Number The strength of the imprint or spread. | BaseDimensionFilter
|  | type : String The placement of the filter effect. | GradientFilter

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | GradientBevelFilter(distance:Number = 4.0, angle:Number = 45, colors:Array = null, alphas:Array = null, ratios:Array = null, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = inner, knockout:Boolean = false) Constructor. | GradientBevelFilter
|  | clone():BitmapFilter Returns a copy of this filter object. | GradientBevelFilter
|  | notifyFilterChanged():void Propagates a change event when the filter has changed. | BaseFilter

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | CHANGE : String = change [static] The string "change". | BaseFilter

Constructor Detail

GradientBevelFilter | () | Constructor

`public function GradientBevelFilter(distance:Number = 4.0, angle:Number = 45, colors:Array = null, alphas:Array = null, ratios:Array = null, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = inner, knockout:Boolean = false)`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `distance:Number` (default = `4.0`)`` — The offset distance. Valid values are 0 to 8.
| `angle:Number` (default = `45`)`` — The angle, in degrees. Valid values are 0 to 360.
| `colors:Array` (default = `null`)`` — An array of RGB hexadecimal color values to use in the gradient. For example, red is 0xFF0000, blue is 0x0000FF, and so on.
| `alphas:Array` (default = `null`)`` — An array of alpha transparency values for the corresponding colors in the `colors` array. Valid values for each element in the array are 0 to 1. For example, .25 sets a transparency value of 25%.
| `ratios:Array` (default = `null`)`` — An array of color distribution ratios; valid values are 0 to 255.
| `blurX:Number` (default = `4.0`)`` — The amount of horizontal blur. Valid values are 0 to 255. A blur of 1 or less means that the original image is copied as is. The default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
| `blurY:Number` (default = `4.0`)`` — The amount of vertical blur. Valid values are 0 to 255. A blur of 1 or less means that the original image is copied as is. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
| `strength:Number` (default = `1`)`` — The strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the bevel and the background. Valid values are 0 to 255. A value of 0 means that the filter is not applied.
| `quality:int` (default = `1`)`` — The quality of the filter. Use BitmapFilterQuality constants: `BitmapFilterQuality.LOW` `BitmapFilterQuality.MEDIUM` `BitmapFilterQuality.HIGH` For more information, see the description of the `quality` property.
| `type:String` (default = `inner`)`` — The placement of the bevel effect. Possible values are BitmapFilterType constants: `BitmapFilterType.OUTER` — Bevel on the outer edge of the object `BitmapFilterType.INNER` — Bevel on the inner edge of the object `BitmapFilterType.FULL` — Bevel on top of the object
| `knockout:Boolean` (default = `false`)`` — Specifies whether a knockout effect is applied. The value `true` makes the object's fill transparent and reveals the background color of the document.

Method Detail

clone | () | method

`public function clone():BitmapFilter`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns a copy of this filter object.

Returns

| `BitmapFilter` — A new GradientBevelFilter instance with all the same properties as the original GradientBevelFilter instance.

Examples
GradientBevelFilterExample.mxml

    <?xml version="1.0"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <!-- filters/examples/BevelFilterExample.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 myGradientBevelFilter:GradientBevelFilter;
         private var colors:Array = [0xFFFFFF, 0xCCCCCC, 0x000000];
         private var alphas:Array = [1, 0, 1];
         private var ratios:Array = [0, 128, 255];

         public function createFilters():void {
            myGradientBevelFilter = new GradientBevelFilter(5, 45, colors, alphas, ratios, 8, 8, 2, BitmapFilterQuality.MEDIUM, BitmapFilterType.INNER, false);
            b1.filters = [myGradientBevelFilter];
         }

      ]]></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:GradientBevelFilter
                        distance="5"
                        angle="45"
                        blurX="8"
                        blurY="8"
                        strength="2"
                        quality="{BitmapFilterQuality.MEDIUM}"
                        type="{BitmapFilterType.INNER}"
                        knockout="false">
                            <s:entries>
                                <s:GradientEntry alpha="1" color="0xFFFFFF" ratio="0"/>
                                <s:GradientEntry alpha="0" color="0xCCCCCC" ratio="128"/>
                                <s:GradientEntry alpha="1" color="0x000000" ratio="255"/>
                            </s:entries>
                    </s:GradientBevelFilter>
                </s:filters>
            </s:Button>

        </s:VGroup>
    </s:Application>

Wed Nov 15 2017, 09:50 AM +01:00