squidpony.squidgrid.gui.gdx

Class SColorFactory

java.lang.Object

squidpony.squidgrid.gui.gdx.SColorFactory

public class SColorFactory
extends Object

Provides utilities for working with colors as well as caching operations for color creation. All returned SColor objects are cached so multiple requests for the same SColor will not create duplicate long term objects.

Author:

Eben Howard - http://squidpony.com - howard@squidpony.com

Method Summary

Modifier and Type	Method and Description
static SColor	add(SColor color1, SColor color2) Adds the two colors together.
static void	addPalette(String name, ArrayList<SColor> palette) Places the palette into the cache, along with each of the member colors.
static void	addPallet(String name, ArrayList<SColor> palette) Deprecated. Prefer addPalette over this misspelled version; they are equivalent.
static ArrayList<SColor>	asGradient(SColor color1, SColor color2) Returns a list of colors starting at the first color and moving to the second color.
static SColor	asSColor(com.badlogic.gdx.graphics.Color color) Returns an SColor representation of the provided Color.
static SColor	asSColor(float a, float r, float g, float b) Returns the cached color that matches the desired rgb value.
static SColor	asSColor(int argb) Returns the cached color that matches the desired rgb value.
static SColor	asSColor(int r, int g, int b) Returns an SColor that is opaque.
static SColor	asSColor(int a, int r, int g, int b) Returns an SColor with the given values, with those values clamped between 0 and 255.
static SColor	blend(SColor color1, SColor color2, double coef) Returns an SColor that is the given distance from the first color to the second color.
static SColor	colorForName(String s) Returns the SColor Constant who's name is the one provided.
static SColor	colorForValue(int rgb) Returns the SColor who's value matches the one passed in.
static SColor	desaturate(SColor color, double percent) Returns an SColor that is the version of the provided color desaturated the given amount.
static SColor	desaturated(SColor color) Returns an SColor that is the fully desaturated (greyscale) version of the provided color.
static SColor	dim(SColor color) Returns an SColor that is a slightly dimmer version of the provided color.
static SColor	dimmer(SColor color) Returns an SColor that is a somewhat dimmer version of the provided color.
static SColor	dimmest(SColor color) Returns an SColor that is a lot darker version of the provided color.
static void	emptyCache() Clears the backing cache.
static SColor	fromPalette(String name, float percent) Returns the SColor that is the provided percent towards the end of the palette.
static SColor	fromPallet(String name, float percent) Deprecated. Prefer fromPalette over this misspelled version; they are equivalent.
static SColor	light(SColor color) Returns an SColor that is a slightly lighter version of the provided color.
static SColor	lighter(SColor color) Returns an SColor that is a somewhat lighter version of the provided color.
static SColor	lightest(SColor color) Returns an SColor that is a lot lighter version of the provided color.
static SColor	lightWith(SColor color, SColor light) Uses the second color as a light source, meaning that each of the red, green, and blue values of the first color are multiplied by the lighting color's percentage of full value (1.0).
static ArrayList<SColor>	palette(String name) Returns the palette associate with the provided name, or null if there is no such palette.
static ArrayList<SColor>	pallet(String name) Deprecated. Prefer palette over this misspelled version.
static int	quantityCached() Returns the number of SColor objects currently cached.
static SColor	randomBlend(SColor color1, SColor color2, double min, double max) Returns an SColor that is randomly chosen from the color line between the two provided colors from the two provided points.
static void	setFloor(int value) Sets the value at which each of the red, green, and blue values will be set to the nearest lower multiple of.

Methods inherited from class java.lang.Object

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

Method Detail

colorForName

public static SColor colorForName(String s)

Returns the SColor Constant who's name is the one provided. If one cannot be found then null is returned. This method constructs a list of the SColor constants the first time it is called.

Parameters:

s -

Returns:

colorForValue

public static SColor colorForValue(int rgb)

Returns the SColor who's value matches the one passed in. If no SColor Constant matches that value then a cached or new SColor is returned that matches the provided value. This method constructs a list of the SColor constants the first time it is called.

Parameters:

rgb -

Returns:

quantityCached

public static int quantityCached()

Returns the number of SColor objects currently cached.

Returns:

blend

public static SColor blend(SColor color1,
                           SColor color2,
                           double coef)

Returns an SColor that is the given distance from the first color to the second color.

Parameters:

color1 - The first color

color2 - The second color

coef - The percent towards the second color, as 0.0 to 1.0

Returns:

randomBlend

public static SColor randomBlend(SColor color1,
                                 SColor color2,
                                 double min,
                                 double max)

Returns an SColor that is randomly chosen from the color line between the two provided colors from the two provided points.

Parameters:

color1 -

color2 -

min - The minimum percent towards the second color, as 0.0 to 1.0

max - The maximum percent towards the second color, as 0.0 to 1.0

Returns:

add

public static SColor add(SColor color1,
                         SColor color2)

Adds the two colors together.

Parameters:

color1 -

color2 -

Returns:

lightWith

public static SColor lightWith(SColor color,
                               SColor light)

Uses the second color as a light source, meaning that each of the red, green, and blue values of the first color are multiplied by the lighting color's percentage of full value (1.0).

Parameters:

color -

light -

Returns:

emptyCache

public static void emptyCache()

Clears the backing cache. Should only be used if an extreme number of colors are being created and then not reused, such as when blending different colors in different areas that will not be revisited.

setFloor

public static void setFloor(int value)

Sets the value at which each of the red, green, and blue values will be set to the nearest lower multiple of. For example, a floor value of 5 would mean that each of those values would be considered the nearest lower multiple of 5 when building the colors. If the value passed in is less than 1, then the flooring value is set at 1.

Parameters:

value -

asSColor

public static SColor asSColor(int argb)

Returns the cached color that matches the desired rgb value. If the color is not already in the cache, it is created and added to the cache. This method does not check to see if the value is already available as a SColor constant. If such functionality is desired then please use colorForValue(int rgb) instead.

Parameters:

argb -

Returns:

asSColor

public static SColor asSColor(float a,
                              float r,
                              float g,
                              float b)

Returns the cached color that matches the desired rgb value. If the color is not already in the cache, it is created and added to the cache. This method does not check to see if the value is already available as a SColor constant. If such functionality is desired then please use colorForValue(int rgb) instead.

Parameters:

a -

r -

g -

b -

Returns:

asSColor

public static SColor asSColor(int r,
                              int g,
                              int b)

Returns an SColor that is opaque.

Parameters:

r -

g -

b -

Returns:

asSColor

public static SColor asSColor(int a,
                              int r,
                              int g,
                              int b)

Returns an SColor with the given values, with those values clamped between 0 and 255.

Parameters:

a -

r -

g -

b -

Returns:

asSColor

public static SColor asSColor(com.badlogic.gdx.graphics.Color color)

Returns an SColor representation of the provided Color. If there is a named SColor constant that matches the value, then that constant is returned.

Parameters:

color -

Returns:

dim

public static SColor dim(SColor color)

Returns an SColor that is a slightly dimmer version of the provided color.

Parameters:

color -

Returns:

dimmer

public static SColor dimmer(SColor color)

Returns an SColor that is a somewhat dimmer version of the provided color.

Parameters:

color -

Returns:

dimmest

public static SColor dimmest(SColor color)

Returns an SColor that is a lot darker version of the provided color.

Parameters:

color -

Returns:

light

public static SColor light(SColor color)

Returns an SColor that is a slightly lighter version of the provided color.

Parameters:

color -

Returns:

lighter

public static SColor lighter(SColor color)

Returns an SColor that is a somewhat lighter version of the provided color.

Parameters:

color -

Returns:

lightest

public static SColor lightest(SColor color)

Returns an SColor that is a lot lighter version of the provided color.

Parameters:

color -

Returns:

desaturated

public static SColor desaturated(SColor color)

Returns an SColor that is the fully desaturated (greyscale) version of the provided color.

Parameters:

color -

Returns:

desaturate

public static SColor desaturate(SColor color,
                                double percent)

Returns an SColor that is the version of the provided color desaturated the given amount.

Parameters:

color -

percent - The percent to desaturate, from 0.0 for none to 1.0 for fully desaturated

Returns:

asGradient

public static ArrayList<SColor> asGradient(SColor color1,
                                           SColor color2)

Returns a list of colors starting at the first color and moving to the second color. The end point colors are included in the list.

Parameters:

color1 -

color2 -

Returns:

palette

public static ArrayList<SColor> palette(String name)

Returns the palette associate with the provided name, or null if there is no such palette.

Parameters:

name -

Returns:

pallet

public static ArrayList<SColor> pallet(String name)

Deprecated. Prefer palette over this misspelled version.

Returns the palette associate with the provided name, or null if there is no such palette.

Parameters:

name -

Returns:

fromPalette

public static SColor fromPalette(String name,
                                 float percent)

Returns the SColor that is the provided percent towards the end of the palette. Bounds are checked so as long as there is at least one color in the palette, values below 0 will return the first element and values above 1 will return the last element; If there is no palette keyed to the provided name, null is returned.

Parameters:

name -

percent -

Returns:

fromPallet

public static SColor fromPallet(String name,
                                float percent)

Deprecated. Prefer fromPalette over this misspelled version; they are equivalent.

Returns the SColor that is the provided percent towards the end of the palette. Bounds are checked so as long as there is at least one color in the palette, values below 0 will return the first element and values above 1 will return the last element; If there is no palette keyed to the provided name, null is returned.

Parameters:

name -

percent -

Returns:

addPallet

public static void addPallet(String name,
                             ArrayList<SColor> palette)

Deprecated. Prefer addPalette over this misspelled version; they are equivalent.

Places the palette into the cache, along with each of the member colors.

Parameters:

name -

palette -

addPalette

public static void addPalette(String name,
                              ArrayList<SColor> palette)

Places the palette into the cache, along with each of the member colors.

Parameters:

name -

palette -