net.lenni0451.commons.color

Class ColorUtils

java.lang.Object

net.lenni0451.commons.color.ColorUtils

public class ColorUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ColorUtils()

Method Summary

Modifier and Type	Method and Description
static int	distance(java.awt.Color color1, java.awt.Color color2) Get the distance between two colors.
static java.awt.Color	getRainbowColor(int offset, float divider) Get a color calculated by the current time.
static java.awt.Color	interpolate(float progress, java.awt.Color... colors) Interpolate between multiple colors with a progress.
static java.awt.Color	interpolate(float progress, java.awt.Color[] colors, float[] steps) Interpolate between multiple colors with a progress.
static java.awt.Color	interpolate(float progress, java.awt.Color color1, java.awt.Color color2) Interpolate between two colors with a progress.
static java.awt.Color	invert(java.awt.Color color) Invert a color.
static java.awt.Color	mix(java.awt.Color color1, java.awt.Color color2) Mix two colors together.
static java.awt.Color	multiply(java.awt.Color color, float factor) Multiply a color with a factor.
static java.awt.Color	multiply(java.awt.Color color, float rFactor, float gFactor, float bFactor, float aFactor) Multiply a color with a factor.
static java.awt.Color	multiplyAll(java.awt.Color color, float factor) Multiply a color with a factor.
static java.awt.Color	multiplyAlpha(java.awt.Color color, float factor) Multiply the alpha value of a color with a factor.
static java.awt.Color	setAlpha(java.awt.Color color, int a) Set the alpha value of a color.
static java.awt.Color	setBlue(java.awt.Color color, int b) Set the blue value of a color.
static java.awt.Color	setGreen(java.awt.Color color, int g) Set the green value of a color.
static java.awt.Color	setRed(java.awt.Color color, int r) Set the red value of a color.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColorUtils

public ColorUtils()

Method Detail

getRainbowColor

public static java.awt.Color getRainbowColor(int offset,
                                             float divider)

Get a color calculated by the current time.
Calling this method subsequently will generate an RGB rainbow color effect.
The offset depends on the used divider. With a divider of 7.5F the color will be the same with the offset of 0 and 7500.
The higher the divider the slower and smoother the color will change.

Parameters:

offset - The offset added to the current time

divider - The divider for the current time

Returns:

The calculated color

setRed

public static java.awt.Color setRed(java.awt.Color color,
                                    int r)

Set the red value of a color.
This will generate a new color object unless the red value is already the same.

Parameters:

color - The color to modify

r - The new red value

Returns:

The modified color

setGreen

public static java.awt.Color setGreen(java.awt.Color color,
                                      int g)

Set the green value of a color.
This will generate a new color object unless the green value is already the same.

Parameters:

color - The color to modify

g - The new green value

Returns:

The modified color

setBlue

public static java.awt.Color setBlue(java.awt.Color color,
                                     int b)

Set the blue value of a color.
This will generate a new color object unless the blue value is already the same.

Parameters:

color - The color to modify

b - The new blue value

Returns:

The modified color

setAlpha

public static java.awt.Color setAlpha(java.awt.Color color,
                                      int a)

Set the alpha value of a color.
This will generate a new color object unless the alpha value is already the same.

Parameters:

color - The color to modify

a - The new alpha value

Returns:

The modified color

invert

public static java.awt.Color invert(java.awt.Color color)

Invert a color.

Parameters:

color - The color to invert

Returns:

The inverted color

multiply

public static java.awt.Color multiply(java.awt.Color color,
                                      float factor)

Multiply a color with a factor.
The alpha value will not be changed.

Parameters:

color - The color to multiply

factor - The factor to multiply with

Returns:

The multiplied color

multiplyAlpha

public static java.awt.Color multiplyAlpha(java.awt.Color color,
                                           float factor)

Multiply the alpha value of a color with a factor.
The RGB values will not be changed.

Parameters:

color - The color to multiply

factor - The factor to multiply with

Returns:

The multiplied color

multiplyAll

public static java.awt.Color multiplyAll(java.awt.Color color,
                                         float factor)

Multiply a color with a factor.

Parameters:

color - The color to multiply

factor - The factor to multiply with

Returns:

The multiplied color

multiply

public static java.awt.Color multiply(java.awt.Color color,
                                      float rFactor,
                                      float gFactor,
                                      float bFactor,
                                      float aFactor)

Multiply a color with a factor.

Parameters:

color - The color to multiply

rFactor - The factor to multiply the red value with

gFactor - The factor to multiply the green value with

bFactor - The factor to multiply the blue value with

aFactor - The factor to multiply the alpha value with

Returns:

The multiplied color

interpolate

public static java.awt.Color interpolate(float progress,
                                         java.awt.Color color1,
                                         java.awt.Color color2)

Interpolate between two colors with a progress.
The progress is a value between 0 and 1.

Parameters:

progress - The progress between the two colors

color1 - The first color

color2 - The second color

Returns:

The interpolated color

interpolate

public static java.awt.Color interpolate(float progress,
                                         java.awt.Color[] colors,
                                         float[] steps)

Interpolate between multiple colors with a progress.
The progress is a value between 0 and 1.
The colors and steps must have the same length.

Parameters:

progress - The progress between the colors

colors - The colors to interpolate between

steps - The steps between the colors

Returns:

The interpolated color

interpolate

public static java.awt.Color interpolate(float progress,
                                         java.awt.Color... colors)

Interpolate between multiple colors with a progress.
The progress is a value between 0 and 1.
The colors must have a length greater than 0.

Parameters:

progress - The progress between the colors

colors - The colors to interpolate between

Returns:

The interpolated color

distance

public static int distance(java.awt.Color color1,
                           java.awt.Color color2)

Get the distance between two colors.

Parameters:

color1 - The first color

color2 - The second color

Returns:

The distance between the two colors

mix

public static java.awt.Color mix(java.awt.Color color1,
                                 java.awt.Color color2)

Mix two colors together.

Parameters:

color1 - The first color

color2 - The second color

Returns:

The mixed color