Class Colors

Object
   |
   +--Colors

class Colors

Represent a color. Allows for setting and getting color components based on RGV, HSV and HSL color spaces. See also http://en.wikipedia.org/wiki/Color_space
Defined in colors.js

Constructor Detail

Colors

Colors()

getBlue

int getBlue()

Get blue component of color

Returns:
blue

getGreen

int getGreen()

Get green component of color

Returns:
green value

getHex

String getHex()

Get hex value of color

Returns:
hex value

getHSL

array getHSL()

Get hue, saturation and luminosity of color as an array

Returns:
[hue, sat, lum]

getHue

int getHue()

Get hue component of color

Returns:
hue

getHueV

int getHueV()

Get hue component of color (HSV)

Returns:
hue

getLuminosity

int getLuminosity()

Get luminosity component of color

Returns:
luminosity

getRed

int getRed()

Get red component of color

Returns:
red value

getRGB

array getRGB()

Get red, green and blue component of color as an array

Returns:
[r, g, b]

getSaturation

int getSaturation()

Get saturation component of color

Returns:
saturation

getSaturationV

int getSaturationV()

Get saturation component of color (HSV)

Returns:
saturation

getValue

int getValue()

Get value component of color (HSV)

Returns:
value

setBlue

int setBlue(b)

Set the blue component of the color

Parameters:
b - {int} value of blue component

Returns:
value of blue component

setGreen

int setGreen(g)

Set the green component of the color

Parameters:
g - {int} value of green component

Returns:
value of green component

setHex

String setHex(hex)

Set the color from a hex color code

Parameters:
hex - {String} hex color

Returns:
hex color

setHue

int setHue(h)

Set the hue component of the color

Parameters:
h - {int} desired value of hue

Returns:
new value of hue

setHueV

int setHueV(h)

Set hue component of the color, using HSV http://en.wikipedia.org/wiki/HSV_color_space

Parameters:
h - {float} desired value of hue

Returns:
new value of hue

setLuminosity

int setLuminosity(l)

Set the luminosity component of the color

Parameters:
l - {int} desired value of luminosity

Returns:
new value of luminosity

setRed

int setRed(r)

Set the red component of the color

Parameters:
r - {int} value of red component

Returns:
value of red component

setRGB

void setRGB(c_arr)

Set the red, green and blue components of the color

Parameters:
c_arr - {array} array containing red,green,blue ints

setSaturation

int setSaturation(s)

Set the saturation component of the color

Parameters:
s - {int} desired value of saturation

Returns:
new value of saturation

setSaturationV

int setSaturationV(s)

Set the saturation component of the color, using HSV

Parameters:
h - {float} desired value of saturation

Returns:
new value of saturation

setValue

int setValue(l)

Set the value component of the color, using HSV

Parameters:
h - {float} desired value of value

Returns:
new value of value