The DropShadowFilter object lets you add a drop shadow to display objects. The shadow algorithm is based on the same box filter that the blur filter uses. You have several options for the style of the drop shadow, including inner or outer shadow and knockout mode. You can apply the filter to any display object (that is, objects that inherit from the DisplayObject object), such as TextField, 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 (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.


Can be created with method new:

Lib.Media.Filters.DropShadowFilter.new(distance, angle, color, alpha, blurX, blurY, strength, quality, inner, knockout, hideObject)

Creates a new DropShadowFilter instance with the specified parameters.

distance - (default = 4.0) - Offset distance for the shadow, in pixels.

angle - (default = 45) - Angle of the shadow, 0 to 360 degrees (floating point).

color - (default = 0) - Color of the shadow, in hexadecimal format 0xRRGGBB. The default value is 0x000000.

alpha - (default = 1.0) - Alpha transparency value for the shadow color. Valid values are 0.0 to 1.0. For example, .25 sets a transparency value of 25%.

blurX - (default = 4.0) - Amount of horizontal blur. Valid values are 0 to 255.0 (floating point).

blurY - (default = 4.0) - Amount of vertical blur. Valid values are 0 to 255.0 (floating point).

strength - (default = 1.0) - 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 0 to 255.0.

quality - (default = 1) - The number of times to apply the filter. Use the BitmapFilterQuality constants:

Lib.Media.Filters.BitmapFilterQuality.LOW (1)

Lib.Media.Filters.BitmapFilterQuality.MEDIUM (2)

Lib.Media.Filters.BitmapFilterQuality.HIGH (3)

For more information about these values, see the quality property description.

inner - (default = false) - Indicates whether or not the shadow is an inner shadow. A value of true specifies an inner shadow. A value of false specifies an outer shadow (a shadow around the outer edges of the object).

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

hideObject - (default = false) - Indicates whether or not the object is hidden. A value of true indicates that the object itself is not drawn; only the shadow is visible.


Created DropShadowFilter object has properties:

alpha

The alpha transparency value for the shadow color.

angle

The angle of the shadow.

blurX

The amount of horizontal blur.

blurY

The amount of vertical blur.

color

The color of the shadow.

distance

The offset distance for the shadow, in pixels.

hideObject

Indicates whether or not the object is hidden.

inner

Indicates whether or not the shadow is an inner shadow.

knockout

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

quality

The number of times to apply the filter.

strength

The strength of the imprint or spread.


methods:

clone()

Returns a copy of this filter object.

Created with the Personal Edition of HelpNDoc: Write eBooks for the Kindle