ColorRGBA

java.lang.Object
- org.synthclipse.core.math.ColorRGBA

All Implemented Interfaces:

Serializable, Cloneable, org.synthclipse.core.ICopyable<ColorRGBA>
```
public final class ColorRGBA
extends Object
implements Cloneable, Serializable, org.synthclipse.core.ICopyable<ColorRGBA>
```
ColorRGBA defines a color made from a collection of red, green and blue values. An alpha value determines is transparency. All values must be between 0 and 1. If any value is set higher or lower than these constraints they are clamped to the min or max. That is, if a value smaller than zero is set the value clamps to zero. If a value higher than 1 is passed, that value is clamped to 1. However, because the attributes r, g, b, a are public for efficiency reasons, they can be directly modified with invalid values. The client should take care when directly addressing the values. A call to clamp will assure that the values are within the constraints.

SCRIPTING: In scripts, ColorRGBA instance can be created by Native.newColorRGBA() / Native.newColorRGBA(r, g, b, a).

Copyright (c) 2009-2012 jMonkeyEngine All rights reserved.
Licensed under BSD license. See the source code for complete license agreement.

Version:

$Id: ColorRGBA.java,v 1.29 2007/09/09 18:25:14 irrisor Exp $

Author:

Mark Powell

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`float`	`a` The alpha component of the color.
`float`	`b` The blue component of the color.
`static ColorRGBA`	`Black` The color black (0,0,0).
`static ColorRGBA`	`BlackNoAlpha` The black color with no alpha (0, 0, 0, 0).
`static ColorRGBA`	`Blue` The color blue (0,0,1).
`static ColorRGBA`	`Brown` The color brown (65/255, 40/255, 25/255).
`static ColorRGBA`	`Cyan` The color cyan (0,1,1).
`static ColorRGBA`	`DarkGray` The color gray (.2,.2,.2).
`float`	`g` The green component of the color.
`static ColorRGBA`	`Gray` The color gray (.5,.5,.5).
`static ColorRGBA`	`Green` The color green (0,1,0).
`static ColorRGBA`	`LightGray` The color gray (.8,.8,.8).
`static ColorRGBA`	`Magenta` The color magenta (1,0,1).
`static ColorRGBA`	`Orange` The color orange (251/255, 130/255,0).
`static ColorRGBA`	`Pink` The color pink (1, 0.68, 0.68).
`float`	`r` The red component of the color.
`static ColorRGBA`	`Red` The color red (1,0,0).
`static ColorRGBA`	`White` The color white (1,1,1).
`static ColorRGBA`	`Yellow` The color yellow (1,1,0).

Constructor Summary

Constructors
Constructor and Description
`ColorRGBA()` Constructor instantiates a new `ColorRGBA` object.
`ColorRGBA(ColorRGBA rgba)` Copy constructor creates a new `ColorRGBA` object, based on a provided color.
`ColorRGBA(float r, float g, float b, float a)` Constructor instantiates a new `ColorRGBA` object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ColorRGBA`	`add(ColorRGBA c)` Adds each r,g,b,a of this `ColorRGBA` by the corresponding r,g,b,a of the given color and returns the result as a new `ColorRGBA`.
`ColorRGBA`	`addLocal(ColorRGBA c)` Adds each r,g,b,a of this `ColorRGBA` by the r,g,b,a the given color and returns the result (this).
`byte[]`	`asBytesRGBA()` Retrieves the component values of this `ColorRGBA` as a four element `byte` array in the order: r,g,b,a.
`int`	`asIntABGR()` Retrieves the component values of this `ColorRGBA` as an `int` in a,b,g,r order.
`int`	`asIntARGB()` Retrieves the component values of this `ColorRGBA` as an `int` in a,r,g,b order.
`int`	`asIntRGBA()` Retrieves the component values of this `ColorRGBA` as an `int` in r,g,b,a order.
`void`	`clamp()` `clamp` insures that all values are between 0 and 1.
`ColorRGBA`	`clone()`
`ColorRGBA`	`copy()`
`boolean`	`equals(Object o)` `equals` returns true if this `ColorRGBA` is logically equivalent to a given color.
`void`	`fromIntARGB(int color)` Sets the component values of this `ColorRGBA` with the given combined ARGB `int`.
`void`	`fromIntRGBA(int color)` Sets the RGBA values of this `ColorRGBA` with the given combined RGBA value Bits 24-31 are red, bits 16-23 are green, bits 8-15 are blue, bits 0-7 are alpha.
`float`	`getAlpha()` Retrieves the alpha component value of this `ColorRGBA`.
`float`	`getBlue()` Retrieves the blue component value of this `ColorRGBA`.
`float[]`	`getColorArray()` `getColorArray` retrieves the color values of this `ColorRGBA` as a four element `float` array in the order: r,g,b,a.
`float[]`	`getColorArray(float[] store)` Stores the current r,g,b,a values into the given array.
`float`	`getGreen()` Retrieves the green component value of this `ColorRGBA`.
`float`	`getRed()` Retrieves the red component value of this `ColorRGBA`.
`int`	`hashCode()` `hashCode` returns a unique code for this `ColorRGBA` based on its values.
`void`	`interpolate(ColorRGBA beginColor, ColorRGBA finalColor, float changeAmnt)` Sets this `ColorRGBA` to the interpolation by changeAmnt from beginColor to finalColor: this=(1-changeAmnt)beginColor + changeAmnt finalColor
`void`	`interpolate(ColorRGBA finalColor, float changeAmnt)` Sets this `ColorRGBA` to the interpolation by changeAmnt from this to the finalColor: this=(1-changeAmnt)this + changeAmnt finalColor
`ColorRGBA`	`mult(ColorRGBA c)` Multiplies each r,g,b,a of this `ColorRGBA` by the corresponding r,g,b,a of the given color and returns the result as a new `ColorRGBA`.
`ColorRGBA`	`mult(float scalar)` Multiplies each r,g,b,a of this `ColorRGBA` by the given scalar and returns the result as a new `ColorRGBA`.
`ColorRGBA`	`multLocal(float scalar)` Multiplies each r,g,b,a of this `ColorRGBA` by the given scalar and returns the result (this).
`static ColorRGBA`	`randomColor()` `randomColor` is a utility method that generates a random opaque color.
`ColorRGBA`	`set(ColorRGBA rgba)` `set` sets the values of this `ColorRGBA` to those set by a parameter color.
`ColorRGBA`	`set(float r, float g, float b, float a)` `set` sets the RGBA values of this `ColorRGBA`.
`float[]`	`toArray(float[] floats)` Saves this `ColorRGBA` into the given `float` array.
`String`	`toString()` `toString` returns the string representation of this `ColorRGBA`.
`Vector3f`	`toVector3f()` Transform this `ColorRGBA` to a `Vector3f` using x = r, y = g, z = b.
`Vector4f`	`toVector4f()` Transform this `ColorRGBA` to a `Vector4f` using x = r, y = g, z = b, w = a.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - Black
```
public static final ColorRGBA Black
```
    The color black (0,0,0).
  - White
```
public static final ColorRGBA White
```
    The color white (1,1,1).
  - DarkGray
```
public static final ColorRGBA DarkGray
```
    The color gray (.2,.2,.2).
  - Gray
```
public static final ColorRGBA Gray
```
    The color gray (.5,.5,.5).
  - LightGray
```
public static final ColorRGBA LightGray
```
    The color gray (.8,.8,.8).
  - Red
```
public static final ColorRGBA Red
```
    The color red (1,0,0).
  - Green
```
public static final ColorRGBA Green
```
    The color green (0,1,0).
  - Blue
```
public static final ColorRGBA Blue
```
    The color blue (0,0,1).
  - Yellow
```
public static final ColorRGBA Yellow
```
    The color yellow (1,1,0).
  - Magenta
```
public static final ColorRGBA Magenta
```
    The color magenta (1,0,1).
  - Cyan
```
public static final ColorRGBA Cyan
```
    The color cyan (0,1,1).
  - Orange
```
public static final ColorRGBA Orange
```
    The color orange (251/255, 130/255,0).
  - Brown
```
public static final ColorRGBA Brown
```
    The color brown (65/255, 40/255, 25/255).
  - Pink
```
public static final ColorRGBA Pink
```
    The color pink (1, 0.68, 0.68).
  - BlackNoAlpha
```
public static final ColorRGBA BlackNoAlpha
```
    The black color with no alpha (0, 0, 0, 0).
  - r
```
public float r
```
    The red component of the color. 0 is none and 1 is maximum red.
  - g
```
public float g
```
    The green component of the color. 0 is none and 1 is maximum green.
  - b
```
public float b
```
    The blue component of the color. 0 is none and 1 is maximum blue.
  - a
```
public float a
```
    The alpha component of the color. 0 is transparent and 1 is opaque.
- Constructor Detail
  - ColorRGBA
```
public ColorRGBA()
```
    Constructor instantiates a new ColorRGBA object. This color is the default "white" with all values 1.
  - ColorRGBA
```
public ColorRGBA(float r,
                 float g,
                 float b,
                 float a)
```
    Constructor instantiates a new ColorRGBA object. The values are defined as passed parameters. These values are then clamped to insure that they are between 0 and 1.
    
    Parameters:
    
    r - The red component of this color.
    
    g - The green component of this ColorRGBA.
    
    b - The blue component of this ColorRGBA.
    
    a - The alpha component of this ColorRGBA.
  - ColorRGBA
```
public ColorRGBA(ColorRGBA rgba)
```
    Copy constructor creates a new ColorRGBA object, based on a provided color.
    
    Parameters:
    
    rgba - The ColorRGBA object to copy.
- Method Detail
  - set
```
public ColorRGBA set(float r,
                     float g,
                     float b,
                     float a)
```
    set sets the RGBA values of this ColorRGBA. The values are then clamped to insure that they are between 0 and 1.
    
    Parameters:
    
    r - The red component of this color.
    
    g - The green component of this color.
    
    b - The blue component of this color.
    
    a - The alpha component of this color.
    
    Returns:
    
    this
  - set
```
public ColorRGBA set(ColorRGBA rgba)
```
    set sets the values of this ColorRGBA to those set by a parameter color.
    
    Parameters:
    
    rgba - The color to set this ColorRGBA to.
    
    Returns:
    
    this
  - clamp
```
public void clamp()
```
    clamp insures that all values are between 0 and 1. If any are less than 0 they are set to zero. If any are more than 1 they are set to one.
  - getColorArray
```
public float[] getColorArray()
```
    getColorArray retrieves the color values of this ColorRGBA as a four element float array in the order: r,g,b,a.
    
    Returns:
    
    The float array that contains the color components.
  - getColorArray
```
public float[] getColorArray(float[] store)
```
    Stores the current r,g,b,a values into the given array. The given array must have a length of 4 or greater, or an array index out of bounds exception will be thrown.
    
    Parameters:
    
    store - The float array to store the values into.
    
    Returns:
    
    The float array after storage.
  - getAlpha
```
public float getAlpha()
```
    Retrieves the alpha component value of this ColorRGBA.
    
    Returns:
    
    The alpha component value.
  - getRed
```
public float getRed()
```
    Retrieves the red component value of this ColorRGBA.
    
    Returns:
    
    The red component value.
  - getBlue
```
public float getBlue()
```
    Retrieves the blue component value of this ColorRGBA.
    
    Returns:
    
    The blue component value.
  - getGreen
```
public float getGreen()
```
    Retrieves the green component value of this ColorRGBA.
    
    Returns:
    
    The green component value.
  - interpolate
```
public void interpolate(ColorRGBA finalColor,
                        float changeAmnt)
```
    Sets this ColorRGBA to the interpolation by changeAmnt from this to the finalColor: this=(1-changeAmnt)*this + changeAmnt * finalColor
    
    Parameters:
    
    finalColor - The final color to interpolate towards.
    
    changeAmnt - An amount between 0.0 - 1.0 representing a percentage change from this towards finalColor.
  - interpolate
```
public void interpolate(ColorRGBA beginColor,
                        ColorRGBA finalColor,
                        float changeAmnt)
```
    Sets this ColorRGBA to the interpolation by changeAmnt from beginColor to finalColor: this=(1-changeAmnt)*beginColor + changeAmnt * finalColor
    
    Parameters:
    
    beginColor - The begining color (changeAmnt=0).
    
    finalColor - The final color to interpolate towards (changeAmnt=1).
    
    changeAmnt - An amount between 0.0 - 1.0 representing a precentage change from beginColor towards finalColor.
  - randomColor
```
public static ColorRGBA randomColor()
```
    randomColor is a utility method that generates a random opaque color.
    
    Returns:
    
    a random ColorRGBA with an alpha set to 1.
  - mult
```
public ColorRGBA mult(ColorRGBA c)
```
    Multiplies each r,g,b,a of this ColorRGBA by the corresponding r,g,b,a of the given color and returns the result as a new ColorRGBA. Used as a way of combining colors and lights.
    
    Parameters:
    
    c - The color to multiply by.
    
    Returns:
    
    The new ColorRGBA. this*c
  - mult
```
public ColorRGBA mult(float scalar)
```
    Multiplies each r,g,b,a of this ColorRGBA by the given scalar and returns the result as a new ColorRGBA. Used as a way of making colors dimmer or brighter.
    
    Parameters:
    
    scalar - The scalar to multiply by.
    
    Returns:
    
    The new ColorRGBA. this*scalar
  - multLocal
```
public ColorRGBA multLocal(float scalar)
```
    Multiplies each r,g,b,a of this ColorRGBA by the given scalar and returns the result (this). Used as a way of making colors dimmer or brighter.
    
    Parameters:
    
    scalar - The scalar to multiply by.
    
    Returns:
    
    this*c
  - add
```
public ColorRGBA add(ColorRGBA c)
```
    Adds each r,g,b,a of this ColorRGBA by the corresponding r,g,b,a of the given color and returns the result as a new ColorRGBA. Used as a way of combining colors and lights.
    
    Parameters:
    
    c - The color to add.
    
    Returns:
    
    The new ColorRGBA. this+c
  - addLocal
```
public ColorRGBA addLocal(ColorRGBA c)
```
    Adds each r,g,b,a of this ColorRGBA by the r,g,b,a the given color and returns the result (this). Used as a way of combining colors and lights.
    
    Parameters:
    
    c - The color to add.
    
    Returns:
    
    this+c
  - toString
```
public String toString()
```
    toString returns the string representation of this ColorRGBA. The format of the string is:
    Class Name: [R=RR.RRRR, G=GG.GGGG, B=BB.BBBB, A=AA.AAAA]
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The string representation of this ColorRGBA.
  - clone
```
public ColorRGBA clone()
```
    Overrides:
    
    clone in class Object
  - toArray
```
public float[] toArray(float[] floats)
```
    Saves this ColorRGBA into the given float array.
    
    Parameters:
    
    floats - The float array to take this ColorRGBA. If null, a new float[4] is created.
    
    Returns:
    
    The array, with r,g,b,a float values in that order.
  - equals
```
public boolean equals(Object o)
```
    equals returns true if this ColorRGBA is logically equivalent to a given color. That is, if all the components of the two colors are the same. False is returned otherwise.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - The object to compare against.
    
    Returns:
    
    true if the colors are equal, false otherwise.
  - hashCode
```
public int hashCode()
```
    hashCode returns a unique code for this ColorRGBA based on its values. If two colors are logically equivalent, they will return the same hash code value.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code value of this ColorRGBA.
  - asBytesRGBA
```
public byte[] asBytesRGBA()
```
    Retrieves the component values of this ColorRGBA as a four element byte array in the order: r,g,b,a.
    
    Returns:
    
    the byte array that contains the color components.
  - asIntARGB
```
public int asIntARGB()
```
    Retrieves the component values of this ColorRGBA as an int in a,r,g,b order. Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue.
    
    Returns:
    
    The integer representation of this ColorRGBA in a,r,g,b order.
  - asIntRGBA
```
public int asIntRGBA()
```
    Retrieves the component values of this ColorRGBA as an int in r,g,b,a order. Bits 24-31 are red, 16-23 are green, 8-15 are blue, 0-7 are alpha.
    
    Returns:
    
    The integer representation of this ColorRGBA in r,g,b,a order.
  - asIntABGR
```
public int asIntABGR()
```
    Retrieves the component values of this ColorRGBA as an int in a,b,g,r order. Bits 24-31 are alpha, 16-23 are blue, 8-15 are green, 0-7 are red.
    
    Returns:
    
    The integer representation of this ColorRGBA in a,b,g,r order.
  - fromIntARGB
```
public void fromIntARGB(int color)
```
    Sets the component values of this ColorRGBA with the given combined ARGB int. Bits 24-31 are alpha, bits 16-23 are red, bits 8-15 are green, bits 0-7 are blue.
    
    Parameters:
    
    color - The integer ARGB value used to set this ColorRGBA .
  - fromIntRGBA
```
public void fromIntRGBA(int color)
```
    Sets the RGBA values of this ColorRGBA with the given combined RGBA value Bits 24-31 are red, bits 16-23 are green, bits 8-15 are blue, bits 0-7 are alpha.
    
    Parameters:
    
    color - The integer RGBA value used to set this object.
  - toVector3f
```
public Vector3f toVector3f()
```
    Transform this ColorRGBA to a Vector3f using x = r, y = g, z = b. The Alpha value is not used. This method is useful to use for shaders assignment.
    
    Returns:
    
    A Vector3f containing the RGB value of this ColorRGBA.
  - toVector4f
```
public Vector4f toVector4f()
```
    Transform this ColorRGBA to a Vector4f using x = r, y = g, z = b, w = a. This method is useful to use for shaders assignment.
    
    Returns:
    
    A Vector4f containing the RGBA value of this ColorRGBA.
  - copy
```
public ColorRGBA copy()
```
    Specified by:
    
    copy in interface org.synthclipse.core.ICopyable<ColorRGBA>

Class ColorRGBA

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Black

White

DarkGray

Gray

LightGray

Red

Green

Blue

Yellow

Magenta

Cyan

Orange

Brown

Pink

BlackNoAlpha

r

g

b

a

Constructor Detail

ColorRGBA

ColorRGBA

ColorRGBA

Method Detail

set

set

clamp

getColorArray

getColorArray

getAlpha

getRed

getBlue

getGreen

interpolate

interpolate

randomColor

mult

mult

multLocal

add

addLocal

toString

clone

toArray

equals

hashCode

asBytesRGBA

asIntARGB

asIntRGBA

asIntABGR

fromIntARGB

fromIntRGBA

toVector3f

toVector4f

copy