flxanimate.filters.BevelFilter - Brainy Engine+ API documentation

The BevelFilter 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:

To apply filters to display objects use the filters property(inherited from DisplayObject). 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 value of 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 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.

Constructor

`@:value({ knockout : false, type : "inner", quality : 1, strength : 1, blurY : 4, blurX : 4, shadowAlpha : 1, shadowColor : 0x000000, highlightAlpha : 1, highlightColor : 0xFFFFFF, angle : 45, distance : 4 })new(distance:Float = 4, angle:Float = 45, highlightColor:Int = 0xFFFFFF, highlightAlpha:Float = 1, shadowColor:Int = 0x000000, shadowAlpha:Float = 1, blurX:Float = 4, blurY:Float = 4, strength:Float = 1, quality:Int = 1, type:String = "inner", knockout:Bool = false)`

Initializes a new BevelFilter instance with the specified parameters.

Parameters:

`distance`	The offset distance of the bevel, in pixels (floating point).
`angle`	The angle of the bevel, from 0 to 360 degrees.
`highlightColor`	The highlight color of the bevel, 0xRRGGBB.
`highlightAlpha`	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`	The shadow color of the bevel, 0xRRGGBB.
`shadowAlpha`	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`	The amount of horizontal blur in pixels. Valid values are 0 to 255.0 (floating point).
`blurY`	The amount of vertical blur in pixels. Valid values are 0 to 255.0 (floating point).
`strength`	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`	The quality of the bevel. Valid values are 0 to 15, but for most applications, you can use `BitmapFilterQuality` constants: - `BitmapFilterQuality.LOW` - `BitmapFilterQuality.MEDIUM` - `BitmapFilterQuality.HIGH` Filters with lower values render faster. You can use the other available numeric values to achieve different effects.
`type`	The type of bevel. Valid values are `BitmapFilterType` constants: `BitmapFilterType.INNER`, `BitmapFilterType.OUTER`, or `BitmapFilterType.FULL`.
`knockout`	Applies a knockout effect (`true`), which effectively makes the object's fill transparent and reveals the background color of the document.

Variables

`angle:Float`

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.

`blurX:Float`

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.

`blurY:Float`

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.

`distance:Float`

The offset distance for the bevel, in pixels. The default value is 4.0 (floating point).

`highlightAlpha:Float`

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.

`highlightColor:Int`

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

`knockout:Bool`

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

`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.

`shadowAlpha:Float`

The alpha transparency value of the shadow 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.

`shadowColor:Int`

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

`strength:Float`

The strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the shadow and the background. Valid values are from 0 to 255.0. The default is 1.0.

`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:

class BevelFilter

package flxanimate.filters

extends BitmapFilter