Packagecom.gestureworks.cml.filters
Classpublic class Bevel
InheritanceBevel Inheritance Object

The Bevel class lets you add a bevel effect to display objects. A bevel effect gives objects such as buttons a three-dimensional look. You can customize the look of the bevel with different highlight and shadow colors, the amount of blur on the bevel, the angle of the bevel, the placement of the bevel, and a knockout effect. 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.

To create a new filter, use the constructor new BevelFilter(). The use of filters depends on the object to which you apply the filter:

If you apply a filter to a display object, the value of the cacheAsBitmap property of the object is set to true. If you remove 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 the scaleX and scaleY properties are not set to 100%), the filter 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.) In Flash Player 9 and earlier and AIR 1.1 and earlier, the limitation is 2,880 pixels in height and 2,880 pixels in width. If, for example, 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.


Public Properties
 PropertyDefined By
  angle : Number
The angle of the bevel.
Bevel
  blurX : Number
The amount of horizontal blur, in pixels.
Bevel
  blurY : Number
The amount of vertical blur, in pixels.
Bevel
  distance : Number
The offset distance of the bevel.
Bevel
  highlightAlpha : Number
The alpha transparency value of the highlight color.
Bevel
  highlightColor : uint
The highlight color of the bevel.
Bevel
  knockout : Boolean
Applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document.
Bevel
  quality : int
The number of times to apply the filter.
Bevel
  shadowAlpha : Number
The alpha transparency value of the shadow color.
Bevel
  shadowColor : uint
The shadow color of the bevel.
Bevel
  strength : Number
The strength of the imprint or spread.
Bevel
  type : String
The placement of the bevel on the object.
Bevel
Public Methods
 MethodDefined By
  
Bevel(distance:Number = 4, angle:Number = 45, highlightColor:uint = 16777215, highlightAlpha:Number = 1, shadowColor:uint = 0, shadowAlpha:Number = 1, blurX:Number = 4, blurY:Number = 4, strength:Number = 1, quality:int = 1, type:String = inner, knockout:Boolean = false)
Initializes a new Bevel instance with the specified parameters.
Bevel
  
getFilter():BevelFilter
Returns new bevel filter
Bevel
Property Detail
angleproperty
angle:Number

The angle of the bevel. Valid values are from 0 to 360°. The default value is 45°. The angle value represents the angle of the theoretical light source falling on the object and determines the placement of the effect relative to the object. If the distance property is set to 0, the effect is not offset from the object and, therefore, the angle property has no effect.


Implementation
    public function get angle():Number
    public function set angle(value:Number):void
blurXproperty 
blurX:Number

The amount of horizontal blur, in pixels. Valid values are from 0 to 255 (floating point). 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.


Implementation
    public function get blurX():Number
    public function set blurX(value:Number):void
blurYproperty 
blurY:Number

The amount of vertical blur, in pixels. Valid values are from 0 to 255 (floating point). 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.


Implementation
    public function get blurY():Number
    public function set blurY(value:Number):void
distanceproperty 
distance:Number

The offset distance of the bevel. Valid values are in pixels (floating point). The default is 4.


Implementation
    public function get distance():Number
    public function set distance(value:Number):void
highlightAlphaproperty 
highlightAlpha:Number

The alpha transparency value of the highlight color. The value is specified as a normalized value from 0 to 1. For example, .25 sets a transparency value of 25%. The default value is 1.


Implementation
    public function get highlightAlpha():Number
    public function set highlightAlpha(value:Number):void
highlightColorproperty 
highlightColor:uint

The highlight color of the bevel. Valid values are in hexadecimal format, 0xRRGGBB. The default is 0xFFFFFF.


Implementation
    public function get highlightColor():uint
    public function set highlightColor(value:uint):void
knockoutproperty 
knockout:Boolean

Applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document. The default value is false (no knockout).


Implementation
    public function get knockout():Boolean
    public function set knockout(value:Boolean):void
qualityproperty 
quality:int

The number of times to apply the filter. The default value is BitmapFilterQuality.LOW, which is equivalent to applying the filter once. The value BitmapFilterQuality.MEDIUM applies the filter twice; the value BitmapFilterQuality.HIGH applies it three times. Filters with lower values are rendered more quickly. For most applications, a quality value of low, medium, or high is sufficient. Although you can use additional numeric values up to 15 to achieve different effects, higher values are rendered more slowly. Instead of increasing the value of quality, you can often get a similar effect, and with faster rendering, by simply increasing the values of the blurX and blurY properties.You can use the following BitmapFilterQuality constants to specify values of the quality property: BitmapFilterQuality.LOWBitmapFilterQuality.MEDIUMBitmapFilterQuality.HIGH


Implementation
    public function get quality():int
    public function set quality(value:int):void
shadowAlphaproperty 
shadowAlpha:Number

The alpha transparency value of the shadow color. This value is specified as a normalized value from 0 to 1. For example, .25 sets a transparency value of 25%. The default is 1.


Implementation
    public function get shadowAlpha():Number
    public function set shadowAlpha(value:Number):void
shadowColorproperty 
shadowColor:uint

The shadow color of the bevel. Valid values are in hexadecimal format, 0xRRGGBB. The default is 0x000000.


Implementation
    public function get shadowColor():uint
    public function set shadowColor(value:uint):void
strengthproperty 
strength:Number

The strength of the imprint or spread. Valid values are from 0 to 255. The larger the value, the more color is imprinted and the stronger the contrast between the bevel and the background. The default value is 1.


Implementation
    public function get strength():Number
    public function set strength(value:Number):void
typeproperty 
type:String

The placement of the bevel on the object. Inner and outer bevels are placed on the inner or outer edge; a full bevel is placed on the entire object. Valid values are the BitmapFilterType constants: BitmapFilterType.INNER, BitmapFilterType.OUTER, BitmapFilterType.FULL


Implementation
    public function get type():String
    public function set type(value:String):void
Constructor Detail
Bevel()Constructor
public function Bevel(distance:Number = 4, angle:Number = 45, highlightColor:uint = 16777215, highlightAlpha:Number = 1, shadowColor:uint = 0, shadowAlpha:Number = 1, blurX:Number = 4, blurY:Number = 4, strength:Number = 1, quality:int = 1, type:String = inner, knockout:Boolean = false)

Initializes a new Bevel instance with the specified parameters.

Parameters
distance:Number (default = 4) — The offset distance of the bevel, in pixels (floating point).
 
angle:Number (default = 45) — The angle of the bevel, from 0 to 360 degrees.
 
highlightColor:uint (default = 16777215) — The highlight color of the bevel, 0xRRGGBB.
 
highlightAlpha:Number (default = 1) — The alpha transparency value of the highlight color. Valid values are 0.0 to 1.0. For example, .25 sets a transparency value of 25%.
 
shadowColor:uint (default = 0) — The shadow color of the bevel, 0xRRGGBB.
 
shadowAlpha:Number (default = 1) — The alpha transparency value of the shadow color. Valid values are 0.0 to 1.0. For example, .25 sets a transparency value of 25%.
 
blurX:Number (default = 4) — The amount of horizontal blur in pixels. Valid values are 0 to 255.0 (floating point).
 
blurY:Number (default = 4) — The amount of vertical blur in pixels. Valid values are 0 to 255.0 (floating point).
 
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.0.
 
quality:int (default = 1) — The quality of the bevel. Valid values are 0 to 15, but for most applications, you can use BitmapFilterQuality constants: BitmapFilterQuality.LOWBitmapFilterQuality.MEDIUMBitmapFilterQuality.HIGHFilters with lower values render faster. You can use the other available numeric values to achieve different effects.
 
type:String (default = inner) — The type of bevel. Valid values are BitmapFilterType constants: BitmapFilterType.INNER, BitmapFilterType.OUTER, or BitmapFilterType.FULL.
 
knockout:Boolean (default = false) — Applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document.
Method Detail
getFilter()method
public function getFilter():BevelFilter

Returns new bevel filter

Returns
BevelFilter




Tue Apr 16 2013, 03:24 PM -06:00