org.cell2d

Class Color

java.lang.Object

org.cell2d.Color

All Implemented Interfaces:

java.io.Serializable

public class Color
extends java.lang.Object
implements java.io.Serializable

A Color represents a color in RGBA format. It stores four floating-point values, all between 0 and 1: the intensities of red, green, and blue, plus an alpha (opacity) value. An alpha of 0 is completely transparent, and an alpha of 1 is completely opaque. Once created, Colors are immutable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Color	BLACK The color black.
static Color	TRANSPARENT A completely transparent Color.
static Color	WHITE The color white.

Constructor Summary

Constructors

Constructor and Description
Color(java.awt.Color color) Constructs a Color that shares the RGBA values of the specified java.awt.Color.
Color(float r, float g, float b) Constructs a Color with the specified RGB values and an alpha value of 1.
Color(float r, float g, float b, float a) Constructs a Color with the specified RGBA values.
Color(int r, int g, int b) Constructs a Color with the specified RGB values, given as integers from 0 to 255, and an alpha value of 1.
Color(int r, int g, int b, int a) Constructs a Color with the specified RGBA values, given as integers from 0 to 255.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns whether the specified object is a Color that is equal to this Color.
float	getA() Returns this Color's alpha value.
int	getAByte() Returns this Color's alpha value as an integer from 0 to 255.
float	getB() Returns this Color's blue value.
int	getBByte() Returns this Color's blue value as an integer from 0 to 255.
float	getG() Returns this Color's green value.
int	getGByte() Returns this Color's green value as an integer from 0 to 255.
float	getR() Returns this Color's red value.
int	getRByte() Returns this Color's red value as an integer from 0 to 255.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TRANSPARENT

public static final Color TRANSPARENT

A completely transparent Color.

BLACK

public static final Color BLACK

The color black.

WHITE

public static final Color WHITE

The color white.

Constructor Detail

Color

public Color(float r,
             float g,
             float b,
             float a)

Constructs a Color with the specified RGBA values.

Parameters:

r - The Color's red value

g - The Color's green value

b - The Color's blue value

a - The Color's alpha value

Color

public Color(float r,
             float g,
             float b)

Constructs a Color with the specified RGB values and an alpha value of 1.

Parameters:

r - The Color's red value

g - The Color's green value

b - The Color's blue value

Color

public Color(int r,
             int g,
             int b,
             int a)

Constructs a Color with the specified RGBA values, given as integers from 0 to 255.

Parameters:

r - The Color's red value

g - The Color's green value

b - The Color's blue value

a - The Color's alpha value

Color

public Color(int r,
             int g,
             int b)

Constructs a Color with the specified RGB values, given as integers from 0 to 255, and an alpha value of 1.

Parameters:

r - The Color's red value

g - The Color's green value

b - The Color's blue value

Color

public Color(java.awt.Color color)

Constructs a Color that shares the RGBA values of the specified java.awt.Color.

Parameters:

color - The java.awt.Color to copy the Color's RGBA values from

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Returns whether the specified object is a Color that is equal to this Color. Two CellVectors are equal if and only if their R, G, B, and A values are all equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to be compared with this Color

Returns:

Whether the specified object is a Color that is equal to this Color

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getR

public final float getR()

Returns this Color's red value.

Returns:

This Color's red value

getG

public final float getG()

Returns this Color's green value.

Returns:

This Color's green value

getB

public final float getB()

Returns this Color's blue value.

Returns:

This Color's blue value

getA

public final float getA()

Returns this Color's alpha value.

Returns:

This Color's alpha value

getRByte

public final int getRByte()

Returns this Color's red value as an integer from 0 to 255.

Returns:

This Color's red value as an integer from 0 to 255

getGByte

public final int getGByte()

Returns this Color's green value as an integer from 0 to 255.

Returns:

This Color's green value as an integer from 0 to 255

getBByte

public final int getBByte()

Returns this Color's blue value as an integer from 0 to 255.

Returns:

This Color's blue value as an integer from 0 to 255

getAByte

public final int getAByte()

Returns this Color's alpha value as an integer from 0 to 255.

Returns:

This Color's alpha value as an integer from 0 to 255