Packagegraphics.filters
Classpublic class TwirlFilter
InheritanceTwirlFilter Inheritance ShaderCustomFilter Inheritance flash.filters.ShaderFilter

The HoleFilter class applies a hole mask over a display or a bitmap. The Shader must be defines with the Hole pixelbender implementation.



Public Properties
 PropertyDefined By
  angle : Number
The angle in degrees of the twirl filter.
TwirlFilter
  center : Point
The center of the twirl filter.
TwirlFilter
 Inheriteddescription : String
[read-only] The description of the filter (defines in the Shader).
ShaderCustomFilter
  gaussian : Boolean
The gaussian flag indicates if a gaussian calcul is used to defines the filter or not.
TwirlFilter
 Inheritedname : String
[read-only] The name of the filter (defines in the Shader).
ShaderCustomFilter
 Inheritednamespace : String
[read-only] The namespace of the filter (defines in the Shader).
ShaderCustomFilter
  radius : Number
The radius of the twirl filter.
TwirlFilter
 Inheritedversion : String
[read-only] The version of the filter (defines in the Shader).
ShaderCustomFilter
Public Methods
 MethodDefined By
  
TwirlFilter(shader:Shader = null, init:Object = null)
Creates a new TwirlFilter instance.
TwirlFilter
  
clone():BitmapFilter
[override] Returns a shallow copy of the object.
TwirlFilter
Property Detail
angleproperty
angle:Number

The angle in degrees of the twirl filter.


Implementation
    public function get angle():Number
    public function set angle(value:Number):void
centerproperty 
center:Point

The center of the twirl filter.


Implementation
    public function get center():Point
    public function set center(value:Point):void
gaussianproperty 
gaussian:Boolean

The gaussian flag indicates if a gaussian calcul is used to defines the filter or not.


Implementation
    public function get gaussian():Boolean
    public function set gaussian(value:Boolean):void
radiusproperty 
radius:Number

The radius of the twirl filter.


Implementation
    public function get radius():Number
    public function set radius(value:Number):void
Constructor Detail
TwirlFilter()Constructor
public function TwirlFilter(shader:Shader = null, init:Object = null)

Creates a new TwirlFilter instance.

Parameters
shader:Shader (default = null) — The Shader reference with the Twirl pixel bender filter inside.
 
init:Object (default = null) — The optional dynamic object to initialize the filter.
Method Detail
clone()method
override public function clone():BitmapFilter

Returns a shallow copy of the object.

Returns
BitmapFilter — a shallow copy of the object.