Beatmup.Imaging.Color Class Reference

Integer RGBA color value. More...

Public Member Functions
	Color ()
	Creates a zero-valued color. More...
	Color (int r, int g, int b, int a)
	Creates a color by aggregating the four channels values components. More...
	Color (int code)
	Constructs a color from its integer code. More...
int	getRgbaCode ()
Color	scale (float factorRGB, float factorAlpha)
	Returns a scaled version of the current color by given factors. More...

Static Public Member Functions
static Color	parseString (String expr) throws IllegalArgumentException
	Builds a color from a string. More...
static Color	byHue (float hueDegrees)
	Returns a fully saturated color from its hue. More...

Public Attributes
int	r
	red More...
int	g
	green More...
int	b
	blue More...
int	a
	alpha More...

Static Public Attributes
static final Color	TRANSPARENT_BLACK = new Color(0, 0, 0, 0)
	Predefined color constants. More...

Detailed Description

Integer RGBA color value.

Definition at line 24 of file Color.java.

Constructor & Destructor Documentation

Color() [1/3]

Beatmup.Imaging.Color.Color ( )

inline

Creates a zero-valued color.

Definition at line 33 of file Color.java.

                   {
        r = g = b = a = 0;
    }

Color() [2/3]

Beatmup.Imaging.Color.Color ( int  r, int  g, int  b, int  a  )

inline

Creates a color by aggregating the four channels values components.

Parameters

r	the red channel value
g	the green channel value
b	the blue channel value
a	the alpha channel value

Definition at line 44 of file Color.java.

                                             {
        this.r = r;
        this.g = g;
        this.b = b;
        this.a = a;
        // This constructor is called by JNI, do not remove it.
    }

Color() [3/3]

Beatmup.Imaging.Color.Color ( int  code )

inline

Constructs a color from its integer code.

Parameters

code	The integer code.

Definition at line 56 of file Color.java.

                           {
        b = code % 256;
        g = (code >> 8) % 256;
        r = (code >> 16) % 256;
        a = (code >> 24) % 256;
    }

Member Function Documentation

getRgbaCode()

int Beatmup.Imaging.Color.getRgbaCode ( )

inline

Returns

the integer code of the current color.

Definition at line 66 of file Color.java.

                             {
        return r | g << 8 | b << 16 | a << 24;
    }

parseString()

static Color Beatmup.Imaging.Color.parseString ( String  expr ) throws IllegalArgumentException

inlinestatic

Builds a color from a string.

Accepts hexadecimal RGB and RGBA notations like "7f7f7f", "7f7f7fFF" (case-insensitive) and a comma-separed list of 3 or 4 decimal integer values like "127,127,127,255".

Parameters

expr	The string expression

Returns

the corresponding color. If cannot parsem throws an exception.

Definition at line 76 of file Color.java.

                                                                                 {
        // hex notation
        if (expr.matches("(\\d|[a-fA-F]){6}")) {
            Color c = new Color(Integer.parseInt(expr, 16));
            c.a = 255;
            return c;
        }
        if (expr.matches("(\\d|[a-fA-F]){8}"))
            return new Color(Integer.parseInt(expr, 16));
        // comma split notation
        String vals[] = expr.split(",");
        if (vals.length != 3 && vals.length != 4)
            throw new IllegalArgumentException("Cannot parse color from expression '" +expr+ "'");
        return new Color(
            Integer.parseInt(vals[0]),
            Integer.parseInt(vals[1]),
            Integer.parseInt(vals[2]),
            vals.length > 3 ? Integer.parseInt(vals[3]) : 255
        );
    }

scale()

Color Beatmup.Imaging.Color.scale ( float  factorRGB, float  factorAlpha  )

inline

Returns a scaled version of the current color by given factors.

Parameters

factorRGB	The color components scaling factor
factorAlpha	The alpha component scaling factor

Returns

the scaled color value. The current instance of Color is not changed.

Definition at line 103 of file Color.java.

                                                           {
        return new Color(
                Math.round(r * factorRGB),
                Math.round(g * factorRGB),
                Math.round(b * factorRGB),
                Math.round(a * factorAlpha)
        );
    }

byHue()

static Color Beatmup.Imaging.Color.byHue ( float  hueDegrees )

inlinestatic

Returns a fully saturated color from its hue.

Parameters

hueDegrees

The hue in degrees.

Returns

the color having the given hue.

Definition at line 117 of file Color.java.

                                                {
        final double
            SQRT3 = 1.732050807568877,
            hue = Math.toRadians(hueDegrees),
            r = Math.max(0, (2 * Math.cos(hue) + 1) / 3),
            g = Math.max(0, (SQRT3 * Math.sin(hue) - Math.cos(hue) + 1) / 3),
            b = Math.max(0, (1 - SQRT3 * Math.sin(hue) - Math.cos(hue)) / 3),
            norm = Math.max(r, Math.max(g, b));
        return new Color(
            (int) Math.floor(255 * r / norm),
            (int) Math.floor(255 * g / norm),
            (int) Math.floor(255 * b / norm),
            255
        );
    }

Member Data Documentation

r

int Beatmup.Imaging.Color.r

red

Definition at line 25 of file Color.java.

g

int Beatmup.Imaging.Color.g

green

Definition at line 26 of file Color.java.

b

int Beatmup.Imaging.Color.b

blue

Definition at line 27 of file Color.java.

a

int Beatmup.Imaging.Color.a

alpha

Definition at line 28 of file Color.java.

TRANSPARENT_BLACK

final Color Beatmup.Imaging.Color.TRANSPARENT_BLACK = new Color(0, 0, 0, 0)

static

Predefined color constants.

Definition at line 137 of file Color.java.

---

The documentation for this class was generated from the following file:

• android/lib/src/main/java/Beatmup/Imaging/Color.java