ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
fl.motion 

AdjustColor  - AS3 Flash
Packagefl.motion
Classpublic class AdjustColor
InheritanceAdjustColor Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

The AdjustColor class defines various color properties, such as brightness, contrast, hue, and saturation, to support the ColorMatrixFilter class. You can apply the AdjustColor filter to any display object, and also generate a flat array representing all four color properties to use with the ColorMatrixFilter class.

Related API Elements

flash.filters.ColorMatrixFilter

Public Properties
 PropertyDefined By
  brightness : Number
[write-only] Sets the brightness of the AdjustColor filter.
AdjustColor
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  contrast : Number
[write-only] Sets the contrast of the AdjustColor filter.
AdjustColor
  hue : Number
[write-only] Sets the hue of the AdjustColor filter.
AdjustColor
  saturation : Number
[write-only] Sets the saturation of the AdjustColor filter.
AdjustColor
Public Methods
 MethodDefined By
  
AdjustColor()
The AdjustColor class defines various color properties to support the ColorMatrixFilter.
AdjustColor
  
AllValuesAreSet():Boolean
Verifies if all four AdjustColor properties are set.
AdjustColor
  
CalculateFinalFlatArray():Array
Returns the flat array of values for all four properties.
AdjustColor
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

brightness

property
brightness:Number  [write-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Sets the brightness of the AdjustColor filter. The range of valid values is -100 to 100.



Implementation
    public function set brightness(value:Number):void

contrast

property 
contrast:Number  [write-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Sets the contrast of the AdjustColor filter. The range of valid values is -100 to 100.



Implementation
    public function set contrast(value:Number):void

hue

property 
hue:Number  [write-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Sets the hue of the AdjustColor filter. The range of valid values is -180 to 180.



Implementation
    public function set hue(value:Number):void

saturation

property 
saturation:Number  [write-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Sets the saturation of the AdjustColor filter. The range of valid values is -100 to 100.



Implementation
    public function set saturation(value:Number):void
Constructor Detail

AdjustColor

()Constructor
public function AdjustColor()

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

The AdjustColor class defines various color properties to support the ColorMatrixFilter.

Related API Elements

flash.filters.ColorMatrixFilter
Method Detail

AllValuesAreSet

()method
public function AllValuesAreSet():Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Verifies if all four AdjustColor properties are set.

Returns
Boolean — A Boolean value that is true if all four AdjustColor properties have been set, false otherwise.

CalculateFinalFlatArray

()method 
public function CalculateFinalFlatArray():Array

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Returns the flat array of values for all four properties.

Returns
Array — An array of 20 numerical values representing all four AdjustColor properties to use with the flash.filters.ColorMatrixFilter class.

Related API Elements

flash.filters.ColorMatrixFilter



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy