ColorUtil

Kind of class: public class
Package:
Inherits from:
  • none
Version: 03/29/10
Author: Aaron Clinger
Classpath: org.casalib.util.ColorUtil
File last modified: Friday, 20 May 2011, 00:59:45
► View source▼ Hide source
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2011, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
     
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
     
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
     
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
     
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
     
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/
package org.casalib.util {
    import flash.geom.ColorTransform;
    import org.casalib.math.Percent;
    import org.casalib.util.NumberUtil;
     
    /**
        Provides utility functions for dealing with color.
         
        @author Aaron Clinger
        @version 03/29/10
    */
    public class ColorUtil {
         
        /**
            Interpolates (tints) between two colors.
             
            @param begin: The start color.
            @param end: The finish color.
            @param amount: The level of interpolation between the two colors.
            @return The new interpolated color.
            @example
                <code>
                    var myColor:ColorTransform = new ColorTransform();
                    myColor.color              = 0xFF0000;
                     
                    var box:Sprite = new Sprite();
                    box.graphics.beginFill(0x0000FF);
                    box.graphics.drawRect(10, 10, 250, 250);
                    box.graphics.endFill();
                     
                    box.transform.colorTransform = ColorUtil.interpolateColor(new ColorTransform(), myColor, new Percent(0.5));
                     
                    this.addChild(box);
                </code>
        */
        public static function interpolateColor(begin:ColorTransform, end:ColorTransform, amount:Percent):ColorTransform {
            var interpolation:ColorTransform = new ColorTransform();
             
            interpolation.redMultiplier   = NumberUtil.interpolate(amount, begin.redMultiplier, end.redMultiplier);
            interpolation.greenMultiplier = NumberUtil.interpolate(amount, begin.greenMultiplier, end.greenMultiplier);
            interpolation.blueMultiplier  = NumberUtil.interpolate(amount, begin.blueMultiplier, end.blueMultiplier);
            interpolation.alphaMultiplier = NumberUtil.interpolate(amount, begin.alphaMultiplier, end.alphaMultiplier);
            interpolation.redOffset       = NumberUtil.interpolate(amount, begin.redOffset, end.redOffset);
            interpolation.greenOffset     = NumberUtil.interpolate(amount, begin.greenOffset, end.greenOffset);
            interpolation.blueOffset      = NumberUtil.interpolate(amount, begin.blueOffset, end.blueOffset);
            interpolation.alphaOffset     = NumberUtil.interpolate(amount, begin.alphaOffset, end.alphaOffset);
             
            return interpolation;
        }
         
        /**
            Converts a series of individual RGB(A) values to a 32-bit ARGB color value.
             
            @param r: A uint from 0 to 255 representing the red color value.
            @param g: A uint from 0 to 255 representing the green color value.
            @param b: A uint from 0 to 255 representing the blue color value.
            @param a: A uint from 0 to 255 representing the alpha value. Default is <code>255</code>.
            @return Returns a hexidecimal color as a String.
            @example
                <code>
                    var hexColor : String = ColorUtil.getHexStringFromARGB(128, 255, 0, 255);
                    trace(hexColor); // Traces 80FF00FF
                </code>
        */
        public static function getColor(r : uint, g : uint, b : uint, a : uint = 255) : uint {
            return (a << 24) | (r << 16) | (g << 8) | b;
        }
         
        /**
            Converts a 32-bit ARGB color value into an ARGB object.
             
            @param color: The 32-bit ARGB color value.
            @return Returns an object with the properties a, r, g, and b defined.
            @example
                <code>
                    var myRGB:Object = ColorUtil.getARGB(0xCCFF00FF);
                    trace("Alpha = " + myRGB.a);
                    trace("Red = " + myRGB.r);
                    trace("Green = " + myRGB.g);
                    trace("Blue = " + myRGB.b);
                </code>
        */
        public static function getARGB(color : uint) : Object {
            var c : Object = {};
            c.a = color >> 24 & 0xFF;
            c.r = color >> 16 & 0xFF;
            c.g = color >> 8 & 0xFF;
            c.b = color & 0xFF;
            return c;
        }
         
        /**
            Converts a 24-bit RGB color value into an RGB object.
             
            @param color: The 24-bit RGB color value.
            @return Returns an object with the properties r, g, and b defined.
            @example
                <code>
                    var myRGB:Object = ColorUtil.getRGB(0xFF00FF);
                    trace("Red = " + myRGB.r);
                    trace("Green = " + myRGB.g);
                    trace("Blue = " + myRGB.b);
                </code>
        */
        public static function getRGB(color : uint) : Object {
            var c : Object = {};
            c.r = color >> 16 & 0xFF;
            c.g = color >> 8 & 0xFF;
            c.b = color & 0xFF;
            return c;
        }
         
        /**
            Converts a 32-bit ARGB color value into a hexidecimal String representation.
             
            @param a: A uint from 0 to 255 representing the alpha value.
            @param r: A uint from 0 to 255 representing the red color value.
            @param g: A uint from 0 to 255 representing the green color value.
            @param b: A uint from 0 to 255 representing the blue color value.
            @return Returns a hexidecimal color as a String.
            @example
                <code>
                    var hexColor : String = ColorUtil.getHexStringFromARGB(128, 255, 0, 255);
                    trace(hexColor); // Traces 80FF00FF
                </code>
        */
        public static function getHexStringFromARGB(a : uint, r : uint, g : uint, b : uint) : String {
            var aa : String = a.toString(16);
            var rr : String = r.toString(16);
            var gg : String = g.toString(16);
            var bb : String = b.toString(16);
            aa = (aa.length == 1) ? '0' + aa : aa;
            rr = (rr.length == 1) ? '0' + rr : rr;
            gg = (gg.length == 1) ? '0' + gg : gg;
            bb = (bb.length == 1) ? '0' + bb : bb;
            return (aa + rr + gg + bb).toUpperCase();
        }
         
        /**
            Converts an RGB color value into a hexidecimal String representation.
             
            @param r: A uint from 0 to 255 representing the red color value.
            @param g: A uint from 0 to 255 representing the green color value.
            @param b: A uint from 0 to 255 representing the blue color value.
            @return Returns a hexidecimal color as a String.
            @example
                <code>
                    var hexColor : String = ColorUtil.getHexStringFromRGB(255, 0, 255);
                    trace(hexColor); // Traces FF00FF
                </code>
        */
        public static function getHexStringFromRGB(r : uint, g : uint, b : uint) : String {
            var rr : String = r.toString(16);
            var gg : String = g.toString(16);
            var bb : String = b.toString(16);
            rr = (rr.length == 1) ? '0' + rr : rr;
            gg = (gg.length == 1) ? '0' + gg : gg;
            bb = (bb.length == 1) ? '0' + bb : bb;
            return (rr + gg + bb).toUpperCase();
        }
    }
}
Provides utility functions for dealing with color.

Summary

Class methods
  • interpolateColor (begin:ColorTransform, end:ColorTransform, amount:Percent) : ColorTransform
    • Interpolates (tints) between two colors.
  • getColor (r:uint, g:uint, b:uint, a:uint = 255) : uint
    • Converts a series of individual RGB(A) values to a 32-bit ARGB color value.
  • getARGB (color:uint) : Object
    • Converts a 32-bit ARGB color value into an ARGB object.
  • getRGB (color:uint) : Object
    • Converts a 24-bit RGB color value into an RGB object.
  • getHexStringFromARGB (a:uint, r:uint, g:uint, b:uint) : String
    • Converts a 32-bit ARGB color value into a hexidecimal String representation.
  • getHexStringFromRGB (r:uint, g:uint, b:uint) : String
    • Converts an RGB color value into a hexidecimal String representation.

Class methods

getARGB

static function getARGB(color:uint) : Object

Converts a 32-bit ARGB color value into an ARGB object.

Parameters
color:The 32-bit ARGB color value.
Example 
  • var myRGB:Object = ColorUtil.getARGB(0xCCFF00FF);
trace("Alpha = " + myRGB.a);
trace("Red = " + myRGB.r);
trace("Green = " + myRGB.g);
trace("Blue = " + myRGB.b);
Returns
  • Returns an object with the properties a, r, g, and b defined.

getColor

static function getColor(r:uint, g:uint, b:uint, a:uint = 255) : uint

Converts a series of individual RGB(A) values to a 32-bit ARGB color value.

Parameters
r:A uint from 0 to 255 representing the red color value.
g:A uint from 0 to 255 representing the green color value.
b:A uint from 0 to 255 representing the blue color value.
a:A uint from 0 to 255 representing the alpha value. Default is 255.
Example 
  • var hexColor : String = ColorUtil.getHexStringFromARGB(128, 255, 0, 255);
trace(hexColor); // Traces 80FF00FF
Returns
  • Returns a hexidecimal color as a String.

getHexStringFromARGB

static function getHexStringFromARGB(a:uint, r:uint, g:uint, b:uint) : String

Converts a 32-bit ARGB color value into a hexidecimal String representation.

Parameters
a:A uint from 0 to 255 representing the alpha value.
r:A uint from 0 to 255 representing the red color value.
g:A uint from 0 to 255 representing the green color value.
b:A uint from 0 to 255 representing the blue color value.
Example 
  • var hexColor : String = ColorUtil.getHexStringFromARGB(128, 255, 0, 255);
trace(hexColor); // Traces 80FF00FF
Returns
  • Returns a hexidecimal color as a String.

getHexStringFromRGB

static function getHexStringFromRGB(r:uint, g:uint, b:uint) : String

Converts an RGB color value into a hexidecimal String representation.

Parameters
r:A uint from 0 to 255 representing the red color value.
g:A uint from 0 to 255 representing the green color value.
b:A uint from 0 to 255 representing the blue color value.
Example 
  • var hexColor : String = ColorUtil.getHexStringFromRGB(255, 0, 255);
trace(hexColor); // Traces FF00FF
Returns
  • Returns a hexidecimal color as a String.

getRGB

static function getRGB(color:uint) : Object

Converts a 24-bit RGB color value into an RGB object.

Parameters
color:The 24-bit RGB color value.
Example 
  • var myRGB:Object = ColorUtil.getRGB(0xFF00FF);
trace("Red = " + myRGB.r);
trace("Green = " + myRGB.g);
trace("Blue = " + myRGB.b);
Returns
  • Returns an object with the properties r, g, and b defined.

interpolateColor

static function interpolateColor(begin:ColorTransform, end:ColorTransform, amount:Percent) : ColorTransform

Interpolates (tints) between two colors.

Parameters
begin :The start color.
end :The finish color.
amount:The level of interpolation between the two colors.
Example 
  • var myColor:ColorTransform = new ColorTransform();
myColor.color              = 0xFF0000;

var box:Sprite = new Sprite();
box.graphics.beginFill(0x0000FF);
box.graphics.drawRect(10, 10, 250, 250);
box.graphics.endFill();

box.transform.colorTransform = ColorUtil.interpolateColor(new ColorTransform(), myColor, new Percent(0.5));

this.addChild(box);
Returns
  • The new interpolated color.