Packagegs.plugins
Classpublic class ColorMatrixFilterPlugin
InheritanceColorMatrixFilterPlugin Inheritance FilterPlugin Inheritance TweenPlugin

Public Properties
 PropertyDefined by
  changeFactor : Number
[write-only]
ColorMatrixFilterPlugin
 InheritedonComplete : Function
Called when the tween is complete.
TweenPlugin
 InheritedoverwriteProps : Array
Array containing the names of the properties that should be overwritten in OverwriteManager's AUTO mode.
TweenPlugin
 InheritedpropName : String
Name of the special property that the plugin should intercept/handle
TweenPlugin
 Inheritedround : Boolean
If the values should be rounded to the nearest integer, set this to true.
TweenPlugin
Protected Properties
 PropertyDefined by
 Inherited_changeFactor : Number = 0
TweenPlugin
 Inherited_filter : BitmapFilter
FilterPlugin
  _idMatrix : Array
[static]
ColorMatrixFilterPlugin
 Inherited_index : int
FilterPlugin
  _lumB : Number = 0.072169
[static]
ColorMatrixFilterPlugin
  _lumG : Number = 0.715160
[static]
ColorMatrixFilterPlugin
  _lumR : Number = 0.212671
[static]
ColorMatrixFilterPlugin
  _matrix : Array
ColorMatrixFilterPlugin
  _matrixTween : EndArrayPlugin
ColorMatrixFilterPlugin
 Inherited_remove : Boolean
FilterPlugin
 Inherited_target : Object
FilterPlugin
 Inherited_tweens : Array
TweenPlugin
 Inherited_type : Class
FilterPlugin
Public Methods
 MethodDefined by
  
ColorMatrixFilterPlugin
 Inherited
activate($plugins:Array):Boolean
[static] Handles integrating the plugin into the GreenSock tweening platform.
TweenPlugin
  
applyMatrix($m:Array, $m2:Array):Array
[static]
ColorMatrixFilterPlugin
  
colorize($m:Array, $color:Number, $amount:Number = 1):Array
[static]
ColorMatrixFilterPlugin
 Inherited
killProps($lookup:Object):void
Gets called on plugins that have multiple overwritable properties by OverwriteManager when in AUTO mode.
TweenPlugin
 Inherited
FilterPlugin
  
onInitTween($target:Object, $value:TweenLite, $tween:*):Boolean
ColorMatrixFilterPlugin
  
setBrightness($m:Array, $n:Number):Array
[static]
ColorMatrixFilterPlugin
  
setContrast($m:Array, $n:Number):Array
[static]
ColorMatrixFilterPlugin
  
setHue($m:Array, $n:Number):Array
[static]
ColorMatrixFilterPlugin
  
setSaturation($m:Array, $n:Number):Array
[static]
ColorMatrixFilterPlugin
  
setThreshold($m:Array, $n:Number):Array
[static]
ColorMatrixFilterPlugin
Protected Methods
 MethodDefined by
 Inherited
addTween($object:Object, $propName:String, $start:Number, $end:String, $overwriteProp:* = null):void
Offers a simple way to add tweening values to the plugin.
TweenPlugin
 Inherited
initFilter($props:Object, $default:BitmapFilter):void
FilterPlugin
 Inherited
updateTweens($changeFactor:Number):void
Updates all the tweens in the _tweens Array.
TweenPlugin
Public Constants
 ConstantDefined by
  API : Number = 1.0
[static]
ColorMatrixFilterPlugin
  VERSION : Number = 1.1
[static]
ColorMatrixFilterPlugin
Property detail
changeFactorproperty
changeFactor:Number  [write-only]Implementation
    public function set changeFactor(value:Number):void
_idMatrixproperty 
protected static var _idMatrix:Array
_lumBproperty 
protected static var _lumB:Number = 0.072169
_lumGproperty 
protected static var _lumG:Number = 0.715160
_lumRproperty 
protected static var _lumR:Number = 0.212671
_matrixproperty 
protected var _matrix:Array
_matrixTweenproperty 
protected var _matrixTween:EndArrayPlugin
Constructor detail
ColorMatrixFilterPlugin()constructor
public function ColorMatrixFilterPlugin() Init Parameters
Method detail
applyMatrix()method
public static function applyMatrix($m:Array, $m2:Array):Array Parameters
$m:Array
 
$m2:Array

Returns
Array
colorize()method 
public static function colorize($m:Array, $color:Number, $amount:Number = 1):Array Parameters
$m:Array
 
$color:Number
 
$amount:Number (default = 1)

Returns
Array
onInitTween()method 
public override function onInitTween($target:Object, $value:TweenLite, $tween:*):Boolean Parameters
$target:Object
 
$value:TweenLite
 
$tween:*

Returns
Boolean
setBrightness()method 
public static function setBrightness($m:Array, $n:Number):Array Parameters
$m:Array
 
$n:Number

Returns
Array
setContrast()method 
public static function setContrast($m:Array, $n:Number):Array Parameters
$m:Array
 
$n:Number

Returns
Array
setHue()method 
public static function setHue($m:Array, $n:Number):Array Parameters
$m:Array
 
$n:Number

Returns
Array
setSaturation()method 
public static function setSaturation($m:Array, $n:Number):Array Parameters
$m:Array
 
$n:Number

Returns
Array
setThreshold()method 
public static function setThreshold($m:Array, $n:Number):Array Parameters
$m:Array
 
$n:Number

Returns
Array
Constant detail
APIconstant
public static const API:Number = 1.0
VERSIONconstant 
public static const VERSION:Number = 1.1
Wiki link
Click to go to the wiki page for 'gs.plugins.ColorMatrixFilterPlugin'

Code examples

Comments