Packagemx.graphics
Classpublic class RectangularDropShadow

Drop shadows are typically created using the DropShadowFilter class. However, the DropShadowFilter, like all bitmap filters, can be computationally expensive. If the DropShadowFilter is applied to a DisplayObject, then the drop shadow is recalculated whenever the appearance of the object changes. If the DisplayObject is animated (using a Resize effect, for example), then the presence of drop shadows hurts the animation refresh rate.

This class optimizes drop shadows for a common case. If you are applying a drop shadow to a rectangularly-shaped object whose edges fall on pixel boundaries, then this class should be used instead of using the DropShadowFilter directly.

This class accepts the first four parameters that are passed to DropShadowFilter: alpha, angle, color, and distance. In addition, this class accepts the corner radii for each of the four corners of the rectangularly-shaped object that is casting a shadow.

Once those 8 values have been set, this class pre-computes the drop shadow in an offscreen Bitmap. When the drawShadow() method is called, pieces of the precomputed drop shadow are copied onto the passed-in Graphics object.

See also

flash.filters.DropShadowFilter
flash.display.DisplayObject


Public Properties
 PropertyDefined by
  alpha : Number
RectangularDropShadow
  angle : Number
RectangularDropShadow
  blRadius : Number
The corner radius of the bottom left corner of the rounded rectangle that is casting the shadow.
RectangularDropShadow
  brRadius : Number
The corner radius of the bottom right corner of the rounded rectangle that is casting the shadow.
RectangularDropShadow
  color : int
RectangularDropShadow
  distance : Number
RectangularDropShadow
  tlRadius : Number
The corner radius of the top left corner of the rounded rectangle that is casting the shadow.
RectangularDropShadow
  trRadius : Number
The corner radius of the top right corner of the rounded rectangle that is casting the shadow.
RectangularDropShadow
Public Methods
 MethodDefined by
  
Constructor.
RectangularDropShadow
  
drawShadow(g:Graphics, x:Number, y:Number, width:Number, height:Number):void
Renders the shadow on the screen.
RectangularDropShadow
Property detail
alphaproperty
alpha:Number  [read-write]

Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
angleproperty 
angle:Number  [read-write]

Implementation
    public function get angle():Number
    public function set angle(value:Number):void
blRadiusproperty 
blRadius:Number  [read-write]

The corner radius of the bottom left corner of the rounded rectangle that is casting the shadow. May be zero for non-rounded rectangles.

Implementation
    public function get blRadius():Number
    public function set blRadius(value:Number):void
brRadiusproperty 
brRadius:Number  [read-write]

The corner radius of the bottom right corner of the rounded rectangle that is casting the shadow. May be zero for non-rounded rectangles.

Implementation
    public function get brRadius():Number
    public function set brRadius(value:Number):void
colorproperty 
color:int  [read-write]

Implementation
    public function get color():int
    public function set color(value:int):void
distanceproperty 
distance:Number  [read-write]

Implementation
    public function get distance():Number
    public function set distance(value:Number):void
tlRadiusproperty 
tlRadius:Number  [read-write]

The corner radius of the top left corner of the rounded rectangle that is casting the shadow. May be zero for non-rounded rectangles.

Implementation
    public function get tlRadius():Number
    public function set tlRadius(value:Number):void
trRadiusproperty 
trRadius:Number  [read-write]

The corner radius of the top right corner of the rounded rectangle that is casting the shadow. May be zero for non-rounded rectangles.

Implementation
    public function get trRadius():Number
    public function set trRadius(value:Number):void
Constructor detail
RectangularDropShadow()constructor
public function RectangularDropShadow()

Constructor.

Method detail
drawShadow()method
public function drawShadow(g:Graphics, x:Number, y:Number, width:Number, height:Number):void

Renders the shadow on the screen.

Parameters
g:Graphics — The Graphics object on which to draw the shadow.
 
x:Number — The horizontal offset of the drop shadow, based on the Graphics object's position.
 
y:Number — The vertical offset of the drop shadow, based on the Graphics object's position.
 
width:Number — The width of the shadow, in pixels.
 
height:Number — The height of the shadow, in pixels.