Packagecom.gestureworks.cml.filters
Classpublic class DropShadow
InheritanceDropShadow Inheritance Object

The DropShadow class 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 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:

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.


Public Properties
 PropertyDefined By
  alpha : Number
The alpha transparency value for the shadow color.
DropShadow
  angle : Number
The angle of the shadow.
DropShadow
  blurX : Number
The amount of horizontal blur.
DropShadow
  blurY : Number
The amount of vertical blur.
DropShadow
  color : uint
The color of the shadow.
DropShadow
  distance : Number
The offset distance for the shadow, in pixels.
DropShadow
  hideObject : Boolean
Indicates whether or not the object is hidden.
DropShadow
  inner : Boolean
Indicates whether or not the shadow is an inner shadow.
DropShadow
  knockout : Boolean
Applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document.
DropShadow
  quality : int
The number of times to apply the filter.
DropShadow
  strength : Number
The strength of the imprint or spread.
DropShadow
Public Methods
 MethodDefined By
  
DropShadow(distance:Number = 4, angle:Number = 45, color:uint = 0, alpha:Number = 1, blurX:Number = 4, blurY:Number = 4, strength:Number = 1, quality:int = 1, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false)
Creates a new DropShadow instance with the specified parameters.
DropShadow
  
getFilter():DropShadowFilter
Returns new drop shadow filter
DropShadow
Property Detail
alphaproperty
alpha:Number

The alpha transparency value for the shadow color. Valid values are 0.0 to 1.0. For example, .25 sets a transparency value of 25%. The default value is 1.0.


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
angleproperty 
angle:Number

The angle of the shadow. Valid values are 0 to 360 degrees (floating point). The default value is 45.


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

The amount of horizontal blur. Valid values are 0 to 255.0 (floating point). The default value is 4.0.


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

The amount of vertical blur. Valid values are 0 to 255.0 (floating point). The default value is 4.0.


Implementation
    public function get blurY():Number
    public function set blurY(value:Number):void
colorproperty 
color:uint

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


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

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


Implementation
    public function get distance():Number
    public function set distance(value:Number):void
hideObjectproperty 
hideObject:Boolean

Indicates whether or not the object is hidden. The value true indicates that the object itself is not drawn; only the shadow is visible. The default is false (the object is shown).


Implementation
    public function get hideObject():Boolean
    public function set hideObject(value:Boolean):void
innerproperty 
inner:Boolean

Indicates whether or not the shadow is an inner shadow. The value true indicates an inner shadow. The default is false, an outer shadow (a shadow around the outer edges of the object).


Implementation
    public function get inner():Boolean
    public function set inner(value:Boolean):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 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.


Implementation
    public function get quality():int
    public function set quality(value:int):void
strengthproperty 
strength:Number

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.


Implementation
    public function get strength():Number
    public function set strength(value:Number):void
Constructor Detail
DropShadow()Constructor
public function DropShadow(distance:Number = 4, angle:Number = 45, color:uint = 0, alpha:Number = 1, blurX:Number = 4, blurY:Number = 4, strength:Number = 1, quality:int = 1, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false)

Creates a new DropShadow instance with the specified parameters.

Parameters
distance:Number (default = 4) — Offset distance for the shadow, in pixels.
 
angle:Number (default = 45) — Angle of the shadow, 0 to 360 degrees (floating point).
 
color:uint (default = 0) — Color of the shadow, in hexadecimal format 0xRRGGBB. The default value is 0x000000.
 
alpha:Number (default = 1) — 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:Number (default = 4) — Amount of horizontal blur. Valid values are 0 to 255.0 (floating point).
 
blurY:Number (default = 4) — Amount of vertical blur. 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 shadow and the background. Valid values are 0 to 255.0.
 
quality:int (default = 1) — The number of times to apply the filter. Use the BitmapFilterQuality constants: BitmapFilterQuality.LOWBitmapFilterQuality.MEDIUMBitmapFilterQuality.HIGHFor more information about these values, see the quality property description.
 
inner:Boolean (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:Boolean (default = false) — Applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document.
 
hideObject:Boolean (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.
Method Detail
getFilter()method
public function getFilter():DropShadowFilter

Returns new drop shadow filter

Returns
DropShadowFilter




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