Packagenet.guttershark.util.filters
Classpublic class FilterUtils

The FilterUtilities class is a singleton that provides common filter generation and filter management for a display object.



Public Methods
 MethodDefined by
  
addBevel(target:DisplayObject, filter:BevelFilter):BevelFilter
Adds a new bevel filter to the display object.
FilterUtils
  
addBlur(target:DisplayObject, filter:BlurFilter):BlurFilter
Adds a new blur filter the the display object.
FilterUtils
  
addColorMatrix(target:DisplayObject, filter:ColorMatrixFilter):ColorMatrixFilter
Adds a new color matrix filter to the display object.
FilterUtils
  
addFilter(target:DisplayObject = null, filter:BitmapFilter = null):void
Add a filter of any type, to the target display object.
FilterUtils
  
addGlow(target:DisplayObject, filter:GlowFilter):GlowFilter
Adds a new glow filter to the display object.
FilterUtils
  
addGradientBevel(target:DisplayObject, filter:GradientBevelFilter):GradientBevelFilter
Adds a new gradient bevel filter to the display object.
FilterUtils
  
addGradientGlow(target:DisplayObject, filter:GradientGlowFilter):GradientGlowFilter
Adds a new gradient glow filter to the display object.
FilterUtils
  
addShadow(target:DisplayObject, filter:DropShadowFilter):DropShadowFilter
Adds a new shadow filter to the display object.
FilterUtils
  
clean(target:DisplayObject):void
Remove all filters from a target display object.
FilterUtils
  
cleanBevel(target:DisplayObject):void
Remove all bevel filters.
FilterUtils
  
cleanBlur(target:DisplayObject):void
Remove all blur filters.
FilterUtils
  
cleanGlow(target:DisplayObject):void
Remove all glow filters.
FilterUtils
  
cleanGradientBevel(target:DisplayObject):void
Remove all gradient bevel filters.
FilterUtils
  
cleanGradientGlow(target:DisplayObject):void
Remove all gradient glow filters.
FilterUtils
  
cleanShadow(target:DisplayObject):void
Remove all shadow filters.
FilterUtils
  
clearFilterType(target:DisplayObject = null, filterType:Class = null):void
Removes all filters of a certain type.
FilterUtils
  
getFilterIndex(target:DisplayObject = null, filter:BitmapFilter = null):int
Finds the last index of a filter and returns that index, or -1 if not found.
FilterUtils
  
getFilterTypeIndex(target:DisplayObject = null, filterType:Class = null):int
Finds the last index of a filter type, and returns that index, or -1 if not found.
FilterUtils
  
getSoftShadowFilter():DropShadowFilter
Return a default DropShadowFilter.
FilterUtils
  
[static] Singleton access.
FilterUtils
  
luminanceTransform():ColorMatrixFilter
Returns a predefined greyscale color matrix.
FilterUtils
  
removeFilter(target:DisplayObject = null, filter:BitmapFilter = null):void
Remove a filter of any type.
FilterUtils
  
setBevel(target:DisplayObject, filter:BevelFilter):BevelFilter
Clears any current bevel filters, and applies a new one.
FilterUtils
  
setBlur(target:DisplayObject, filter:BlurFilter):BlurFilter
Clears any blur filters, and applies a new one.
FilterUtils
  
setColorMatrix(target:DisplayObject, filter:ColorMatrixFilter):ColorMatrixFilter
Clears any current color filters, and applies a new one.
FilterUtils
  
setGlow(target:DisplayObject, filter:GlowFilter):GlowFilter
Clears any current glow filters, and applies a new one.
FilterUtils
  
setGradientBevel(target:DisplayObject, filter:GradientBevelFilter):GradientBevelFilter
Clears any gradient bevel filters, and applies a new one.
FilterUtils
  
setGradientGlow(target:DisplayObject, filter:GradientGlowFilter):GradientGlowFilter
Clears any gradient glow filters, and applies a new one.
FilterUtils
  
setShadow(target:DisplayObject, filter:DropShadowFilter):DropShadowFilter
Clears any current shadow filters, and applies a new one.
FilterUtils
Method detail
addBevel()method
public function addBevel(target:DisplayObject, filter:BevelFilter):BevelFilter

Adds a new bevel filter to the display object.

Parameters
target:DisplayObject — The target display object.
 
filter:BevelFilter — A bevel filter.

Returns
BevelFilter
addBlur()method 
public function addBlur(target:DisplayObject, filter:BlurFilter):BlurFilter

Adds a new blur filter the the display object.

Parameters
target:DisplayObject — The target display object.
 
filter:BlurFilter — A blur filter.

Returns
BlurFilter
addColorMatrix()method 
public function addColorMatrix(target:DisplayObject, filter:ColorMatrixFilter):ColorMatrixFilter

Adds a new color matrix filter to the display object.

Parameters
target:DisplayObject — The target display object.
 
filter:ColorMatrixFilter — A color matrix filter.

Returns
ColorMatrixFilter
addFilter()method 
public function addFilter(target:DisplayObject = null, filter:BitmapFilter = null):void

Add a filter of any type, to the target display object.

Parameters
target:DisplayObject (default = null) — The target display object.
 
filter:BitmapFilter (default = null) — A bitmap filter.
addGlow()method 
public function addGlow(target:DisplayObject, filter:GlowFilter):GlowFilter

Adds a new glow filter to the display object.

Parameters
target:DisplayObject — The target display object.
 
filter:GlowFilter — A glow filter.

Returns
GlowFilter
addGradientBevel()method 
public function addGradientBevel(target:DisplayObject, filter:GradientBevelFilter):GradientBevelFilter

Adds a new gradient bevel filter to the display object.

Parameters
target:DisplayObject — The target display object.
 
filter:GradientBevelFilter — A gradient bevel filter.

Returns
GradientBevelFilter
addGradientGlow()method 
public function addGradientGlow(target:DisplayObject, filter:GradientGlowFilter):GradientGlowFilter

Adds a new gradient glow filter to the display object.

Parameters
target:DisplayObject — The target display object.
 
filter:GradientGlowFilter — A gradient glow filter.

Returns
GradientGlowFilter
addShadow()method 
public function addShadow(target:DisplayObject, filter:DropShadowFilter):DropShadowFilter

Adds a new shadow filter to the display object.

Parameters
target:DisplayObject — The target display object.
 
filter:DropShadowFilter — A drop shadow filter.

Returns
DropShadowFilter
clean()method 
public function clean(target:DisplayObject):void

Remove all filters from a target display object.

Parameters
target:DisplayObject — The target display object.
cleanBevel()method 
public function cleanBevel(target:DisplayObject):void

Remove all bevel filters.

Parameters
target:DisplayObject — The target display object.
cleanBlur()method 
public function cleanBlur(target:DisplayObject):void

Remove all blur filters.

Parameters
target:DisplayObject — The target display object.
cleanGlow()method 
public function cleanGlow(target:DisplayObject):void

Remove all glow filters.

Parameters
target:DisplayObject — The target display object.
cleanGradientBevel()method 
public function cleanGradientBevel(target:DisplayObject):void

Remove all gradient bevel filters.

Parameters
target:DisplayObject — The target display object.
cleanGradientGlow()method 
public function cleanGradientGlow(target:DisplayObject):void

Remove all gradient glow filters.

Parameters
target:DisplayObject — The target display object.
cleanShadow()method 
public function cleanShadow(target:DisplayObject):void

Remove all shadow filters.

Parameters
target:DisplayObject — target display object.
clearFilterType()method 
public function clearFilterType(target:DisplayObject = null, filterType:Class = null):void

Removes all filters of a certain type.

Parameters
target:DisplayObject (default = null) — The target display object.
 
filterType:Class (default = null) — The class type of the filters to remove.
getFilterIndex()method 
public function getFilterIndex(target:DisplayObject = null, filter:BitmapFilter = null):int

Finds the last index of a filter and returns that index, or -1 if not found.

Parameters
target:DisplayObject (default = null) — The target display object.
 
filter:BitmapFilter (default = null) — A bitmap filter.

Returns
int
getFilterTypeIndex()method 
public function getFilterTypeIndex(target:DisplayObject = null, filterType:Class = null):int

Finds the last index of a filter type, and returns that index, or -1 if not found.

Parameters
target:DisplayObject (default = null) — The target display object.
 
filterType:Class (default = null) — The class type of the filter to find.

Returns
int
getSoftShadowFilter()method 
public function getSoftShadowFilter():DropShadowFilter

Return a default DropShadowFilter.

Returns
DropShadowFilter
gi()method 
public static function gi():FilterUtils

Singleton access.

Returns
FilterUtils
luminanceTransform()method 
public function luminanceTransform():ColorMatrixFilter

Returns a predefined greyscale color matrix.

Returns
ColorMatrixFilter
removeFilter()method 
public function removeFilter(target:DisplayObject = null, filter:BitmapFilter = null):void

Remove a filter of any type.

Parameters
target:DisplayObject (default = null) — The target display object.
 
filter:BitmapFilter (default = null) — A bitmap filter.
setBevel()method 
public function setBevel(target:DisplayObject, filter:BevelFilter):BevelFilter

Clears any current bevel filters, and applies a new one.

Parameters
target:DisplayObject — The target display object.
 
filter:BevelFilter — A bevel filter.

Returns
BevelFilter
setBlur()method 
public function setBlur(target:DisplayObject, filter:BlurFilter):BlurFilter

Clears any blur filters, and applies a new one.

Parameters
target:DisplayObject — The taget display object.
 
filter:BlurFilter — A blur filter.

Returns
BlurFilter
setColorMatrix()method 
public function setColorMatrix(target:DisplayObject, filter:ColorMatrixFilter):ColorMatrixFilter

Clears any current color filters, and applies a new one.

Parameters
target:DisplayObject — The target display object.
 
filter:ColorMatrixFilter — A color matrix filter.

Returns
ColorMatrixFilter
setGlow()method 
public function setGlow(target:DisplayObject, filter:GlowFilter):GlowFilter

Clears any current glow filters, and applies a new one.

Parameters
target:DisplayObject — The target display object.
 
filter:GlowFilter — A glow filter.

Returns
GlowFilter
setGradientBevel()method 
public function setGradientBevel(target:DisplayObject, filter:GradientBevelFilter):GradientBevelFilter

Clears any gradient bevel filters, and applies a new one.

Parameters
target:DisplayObject — The target display object.
 
filter:GradientBevelFilter — A gradient bevel filter.

Returns
GradientBevelFilter
setGradientGlow()method 
public function setGradientGlow(target:DisplayObject, filter:GradientGlowFilter):GradientGlowFilter

Clears any gradient glow filters, and applies a new one.

Parameters
target:DisplayObject — The target display object.
 
filter:GradientGlowFilter — A gradient glow filter.

Returns
GradientGlowFilter
setShadow()method 
public function setShadow(target:DisplayObject, filter:DropShadowFilter):DropShadowFilter

Clears any current shadow filters, and applies a new one.

Parameters
target:DisplayObject — The target display object.
 
filter:DropShadowFilter — A drop shadow filter.

Returns
DropShadowFilter