thothbot.parallax.core.shared.math

Class Color

java.lang.Object

thothbot.parallax.core.shared.math.Color

public final class Color
extends java.lang.Object

The Color class is used encapsulate colors in the default RGB color space. This class doesn't work with alpha value. Each RGB value stored as values in range [0.0-1.0]. Where value of 1.0 is 255 means that the color is completely shown and an color value of 0 or 0.0 means that the color is completely hidden.

Author:

thothbot

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Color.HSL HSL presentation of color

Constructor Summary

Constructors

Constructor and Description
Color() This default constructor will create color where R=1.0, G=1.0, B=1.0 ie (255, 255, 255) or 0xFFFFFF in HEX.
Color(int hex) This constructor will create Color instance by defined HEX value.

Method Summary

Modifier and Type	Method and Description
Color	add(Color color)
Color	add(Color color1, Color color2)
Color	add(int s)
Color	clone() Clone the current color class.
Color	convertGammaToLinear() This method will convert gamma to color
Color	convertLinearToGamma() This method will convert color to gamma
Color	copy(Color color) Set value of the color from another color.
Color	copyGammaToLinear(Color color) Set value of color from gamma.
Color	copyLinearToGamma(Color color) Set value of the gamma from color.
boolean	equals(Color c)
double	getB() get B-component of the color.
double	getG() get G-component of the color.
int	getHex() Gets HEX value.
java.lang.String	getHexString()
Color.HSL	getHSL()
double	getR() get R-component of the color.
java.lang.String	getStyle()
Color	lerp(Color color, double alpha) Linearly interpolates between the current color and input color.
Color	multiply(Color color)
Color	multiply(double s)
Color	offsetHSL(double h, double s, double l)
void	setB(double b) Setting B-component of the color.
void	setG(double g) Setting G-component of the color.
Color	setHex(int hex) Setting color in HEX format.
Color	setHSL(double h, double s, double l) h,s,l ranges are in <0.0 - 1.0>
void	setR(double r) Setting R-component of the color.
Color	setRGB(double r, double g, double b) Setting color in RGB mode.
java.lang.String	toString() get Color class description by multiplying each value by 255.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Color

public Color()

This default constructor will create color where R=1.0, G=1.0, B=1.0 ie (255, 255, 255) or 0xFFFFFF in HEX.

Color

public Color(int hex)

This constructor will create Color instance by defined HEX value. For example 0xFFFFFF will create a color in RGB(255, 255, 255), which means completely white.

Parameters:

hex - Color in HEX format

Method Detail

getR

public double getR()

get R-component of the color.

Returns:

a value in range <0.0, 1.0>

getG

public double getG()

get G-component of the color.

Returns:

a value in range <0.0, 1.0>

getB

public double getB()

get B-component of the color.

Returns:

a value in range <0.0, 1.0>

setR

public void setR(double r)

Setting R-component of the color.

Parameters:

r - the value in range <0.0, 1.0>

setG

public void setG(double g)

Setting G-component of the color.

Parameters:

g - the value in range <0.0, 1.0>

setB

public void setB(double b)

Setting B-component of the color.

Parameters:

b - the value in range <0.0, 1.0>

setHex

public Color setHex(int hex)

Setting color in HEX format. For example 0xFFFFFF will create a color in RGB(255, 255, 255), which means completely white.

Parameters:

hex - Color in HEX format

setRGB

public Color setRGB(double r,
                    double g,
                    double b)

Setting color in RGB mode. Each of R, G, B should be in range <0.0, 1.0>.

Parameters:

r - the R-component of Color.

g - the G-component of Color.

b - the B-component of Color.

Returns:

a current color

setHSL

public Color setHSL(double h,
                    double s,
                    double l)

h,s,l ranges are in <0.0 - 1.0>

Parameters:

h - Hue

s - Saturation

l - Lightness (Intensity)

Returns:

copy

public Color copy(Color color)

Set value of the color from another color.

Parameters:

color - the other color

copyGammaToLinear

public Color copyGammaToLinear(Color color)

Set value of color from gamma.

Parameters:

color - the gamma

Returns:

the current color

copyLinearToGamma

public Color copyLinearToGamma(Color color)

Set value of the gamma from color.

Parameters:

color - the color

Returns:

a gamma

convertGammaToLinear

public Color convertGammaToLinear()

This method will convert gamma to color

Returns:

a current color

convertLinearToGamma

public Color convertLinearToGamma()

This method will convert color to gamma

Returns:

a current gamma

getHex

public int getHex()

Gets HEX value.

getHexString

public java.lang.String getHexString()

getHSL

public Color.HSL getHSL()

getStyle

public java.lang.String getStyle()

offsetHSL

public Color offsetHSL(double h,
                       double s,
                       double l)

add

public Color add(Color color)

add

public Color add(Color color1,
                 Color color2)

add

public Color add(int s)

multiply

public Color multiply(Color color)

multiply

public Color multiply(double s)

lerp

public Color lerp(Color color,
                  double alpha)

Linearly interpolates between the current color and input color.

Parameters:

color - the input color

alpha - the alpha value in range <0.0, 1.0>

equals

public boolean equals(Color c)

clone

public Color clone()

Clone the current color class. (color.clone() != color).

Overrides:

clone in class java.lang.Object

Returns:

a new color instance, based on the current color class

toString

public java.lang.String toString()

get Color class description by multiplying each value by 255. Please not this is not real used values. This is just for readability.

Overrides:

toString in class java.lang.Object