universum.studios.android.graphics

Class Colors

java.lang.Object

universum.studios.android.graphics.Colors

public final class Colors
extends Object

Utility class that may be used to change components of a specific color, like its alpha or to blend two colors together.

Utility methods

• withAlpha(int, float)
• withAlpha(int, int)
• blend(int, int)
• blend(int, int, float)
• brighter(int, float)
• darker(int, float)
• random(boolean)
• hexName(int)
• hexName(int, boolean)

Since:

1.0

Author:

Martin Albedinsky

Method Summary

Modifier and Type	Method and Description
static int	blend(int first, int second) Same as blend(int, int, float) with 0.5 blending ratio.
static int	blend(int first, int second, float blendingRatio) Blends the given colors together in the specified blending.
static int	brighter(int color, float fraction) Transforms the given color by changing its components (except alpha) to the brightest ones by multiplying theirs current value with (1.0 + fraction).
static int	darker(int color, float fraction) Transforms the given color by changing its components (except alpha) to the darkest ones by multiplying theirs current value with (1.0 - fraction).
static String	hexName(int color) Same as hexName(int, boolean) with withAlpha flag set to true.
static String	hexName(int color, boolean withAlpha) Returns the name of the specified color represented by hexadecimal values of its current components.
static int	random(boolean randomAlpha) Returns a new color with random components.
static int	withAlpha(int color, float alphaRatio) Same as withAlpha(int, int) with alpha ratio support.
static int	withAlpha(int color, int alpha) Transforms the given color in a way that changes its alpha value to the given one.

Methods inherited from class java.lang.Object

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

Method Detail

withAlpha

public static int withAlpha(int color,
                            float alphaRatio)

Same as withAlpha(int, int) with alpha ratio support.

Alpha ratio must be in the [0.0, 1.0] range, otherwise an exception is thrown.

Parameters:

color - Color to transform.

alphaRatio - Ratio used to calculate value of alpha component (0.0 = fully transparent, 1.0 = fully opaque).

Returns:

New color with the same RGB values and alpha value in the requested ratio.

Throws:

IllegalArgumentException - If the specified alpha ratio is not from the required range.

withAlpha

public static int withAlpha(int color,
                            int alpha)

Transforms the given color in a way that changes its alpha value to the given one.

Alpha value must be in the [0, 255] range, otherwise an exception is thrown.

Parameters:

color - Color to transform.

alpha - New value of alpha component (0 = fully transparent, 255 = fully opaque).

Returns:

New color with the same RGB values and the requested alpha value.

Throws:

IllegalArgumentException - If the specified alpha is not from the required range.

blend

public static int blend(int first,
                        int second)

Same as blend(int, int, float) with 0.5 blending ratio.

blend

public static int blend(int first,
                        int second,
                        float blendingRatio)

Blends the given colors together in the specified blending.

Blending ratio must be in the [0.0, 1.0] range, otherwise an exception is thrown.

Parameters:

first - First color to be blended with the second one.

second - Second color to be blended with the first one.

blendingRatio - Ratio used to blend the given two colors. Use ratio from range [0.0, 1.0]. 1.0 ratio will return first, 0.0 ratio will return second color.

Returns:

New color blended from the given colors according to the requested ratio.

Throws:

IllegalArgumentException - If the specified blending ratio is not from the required range.

brighter

public static int brighter(int color,
                           float fraction)

Transforms the given color by changing its components (except alpha) to the brightest ones by multiplying theirs current value with (1.0 + fraction).

Transforming fraction must be in the [0.0, 1.0] range, otherwise an exception is thrown.

Parameters:

fraction - Fraction used to transform color components. Use for example 0.75 if the resulting color should be brighter by 75%.

Returns:

New brighter color or the specified color.

Throws:

IllegalArgumentException - If the specified fraction is not from the required range.

See Also:

darker(int, float), blend(int, int, float)

darker

public static int darker(int color,
                         float fraction)

Transforms the given color by changing its components (except alpha) to the darkest ones by multiplying theirs current value with (1.0 - fraction).

Transforming fraction must be in the [0.0, 1.0] range, otherwise an exception is thrown.

Parameters:

fraction - Fraction used to transform color components. Use for example 0.25 if the resulting color should be darker by 25%.

Returns:

New darker color or the specified color.

Throws:

IllegalArgumentException - If the specified fraction is not from the required range.

See Also:

brighter(int, float), blend(int, int, float)

random

public static int random(boolean randomAlpha)

Returns a new color with random components.

Parameters:

randomAlpha - If true, the random selection will be also applied to the alpha component, otherwise alpha component will be set to 255.

Returns:

New random color.

hexName

@NonNull
public static String hexName(int color)

Same as hexName(int, boolean) with withAlpha flag set to true.

hexName

@NonNull
public static String hexName(int color,
                                      boolean withAlpha)

Returns the name of the specified color represented by hexadecimal values of its current components.

Parameters:

color - The color of which hexadecimal name to obtain.

withAlpha - If true, the hexadecimal name will be returned also with the alpha component, otherwise without it.

Returns:

Hexadecimal name of the color, like: black color => #000000, white color => #ffffff or with alpha #33000000, #00ffffff.