sc.fiji.snt.util

Class SNTColor

java.lang.Object

sc.fiji.snt.util.SNTColor

public class SNTColor
extends java.lang.Object

A simple class for handling Colors including the ability to map an AWT Color to a SWC type integer tag.

Author:

Tiago Ferreira

Constructor Summary

Constructors

Constructor and Description
SNTColor(java.awt.Color color) Instantiates a new SNT color without SWC type association
SNTColor(java.awt.Color color, int swcType) Instantiates a new SNT color.

Method Summary

Modifier and Type	Method and Description
static java.awt.Color	alphaColor(java.awt.Color c, double percent) Adds an alpha component to a AWT color.
static java.awt.Color	average(java.util.Collection<java.awt.Color> colors) Averages a collection of colors
java.awt.Color	color() Retrieves the AWT color
static java.lang.String	colorToString(java.awt.Color color) Returns the color encoded as hex string with the format #rrggbbaa.
static java.awt.Color	contrastColor(java.awt.Color c) Returns a suitable 'contrast' color.
boolean	equals(java.lang.Object obj)
static org.scijava.util.ColorRGB[]	getDistinctColors(int nColors) Returns distinct colors based on Kenneth Kelly's 22 colors of maximum contrast (black and white excluded).
int	hashCode()
boolean	isTypeDefined() Checks if an SWC type has been defined.
void	setAWTColor(java.awt.Color color) Re-assigns a AWT color.
void	setSWCType(int swcType) Re-assigns a SWC type integer flag
static java.awt.Color	stringToColor(java.lang.String hex) Returns an AWT Color from a (#)RRGGBB(AA) hex string.
int	type() Retrieves the SWC type

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SNTColor

public SNTColor(java.awt.Color color,
                int swcType)

Instantiates a new SNT color.

Parameters:

color - the AWT color

swcType - the SWC type integer flag to be associated with color

SNTColor

public SNTColor(java.awt.Color color)

Instantiates a new SNT color without SWC type association

Parameters:

color - the AWT color

Method Detail

color

public java.awt.Color color()

Retrieves the AWT color

Returns:

the AWT color

type

public int type()

Retrieves the SWC type

Returns:

the SWC type integer flag

isTypeDefined

public boolean isTypeDefined()

Checks if an SWC type has been defined.

Returns:

true, if an SWC integer flag has been specified

setAWTColor

public void setAWTColor(java.awt.Color color)

Re-assigns a AWT color.

Parameters:

color - the new color

setSWCType

public void setSWCType(int swcType)

Re-assigns a SWC type integer flag

Parameters:

swcType - the new SWC type

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

colorToString

public static java.lang.String colorToString(java.awt.Color color)

Returns the color encoded as hex string with the format #rrggbbaa.

Parameters:

color - the input AWT color

Returns:

the converted string

stringToColor

public static java.awt.Color stringToColor(java.lang.String hex)

Returns an AWT Color from a (#)RRGGBB(AA) hex string.

Parameters:

hex - the input string

Returns:

the converted AWT color

average

public static java.awt.Color average(java.util.Collection<java.awt.Color> colors)

Averages a collection of colors

Parameters:

colors - the colors to be averaged

Returns:

the averaged color. Note that an average will never be accurate because the RGB space is not linear

alphaColor

public static java.awt.Color alphaColor(java.awt.Color c,
                                        double percent)

Adds an alpha component to a AWT color.

Parameters:

c - the input color

percent - alpha value in percentage

Returns:

the color with an alpha component

contrastColor

public static java.awt.Color contrastColor(java.awt.Color c)

Returns a suitable 'contrast' color.

Parameters:

c - the input color

Returns:

Either white or black, as per hue of input color.

getDistinctColors

public static org.scijava.util.ColorRGB[] getDistinctColors(int nColors)

Returns distinct colors based on Kenneth Kelly's 22 colors of maximum contrast (black and white excluded). More details on this SO discussion

Parameters:

nColors - the number of colors to be retrieved.

Returns:

the maximum contrast colors