heronarts.lx.color

Class ColorParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.color.ColorParameter

All Implemented Interfaces:

LXPath, LXParameter, LXParameterListener

public class ColorParameter
extends LXListenableParameter
implements LXParameterListener

Nested Class Summary

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Formatter, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields

Modifier and Type	Field and Description
CompoundParameter	brightness
CompoundParameter	hue
static String	PATH_BRIGHTNESS
static String	PATH_HUE
static String	PATH_SATURATION
CompoundParameter	saturation

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Constructor Summary

Constructors

Constructor and Description
ColorParameter(String label)
ColorParameter(String label, int color)

Method Summary

Modifier and Type	Method and Description
void	dispose() Invoked when the parameter is done being used and none of its resources are needed anymore.
int	getColor()
String	getHexString()
void	onParameterChanged(LXParameter parameter) Invoked when the value of a parameter is changed.
ColorParameter	setColor(int color)
ColorParameter	setDescription(String description)
protected double	updateValue(double value) Invoked when the value has changed.

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, bang, getDescription, getFormatter, getLabel, getParent, getPath, getPolarity, getUnits, getValue, getValuef, incrementValue, isMappable, removeListener, reset, reset, setComponent, setFormatter, setMappable, setPolarity, setUnits, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

Field Detail

hue

public final CompoundParameter hue

saturation

public final CompoundParameter saturation

brightness

public final CompoundParameter brightness

PATH_HUE

public static final String PATH_HUE

See Also:

Constant Field Values

PATH_SATURATION

public static final String PATH_SATURATION

See Also:

Constant Field Values

PATH_BRIGHTNESS

public static final String PATH_BRIGHTNESS

See Also:

Constant Field Values

Constructor Detail

ColorParameter

public ColorParameter(String label)

ColorParameter

public ColorParameter(String label,
                      int color)

Method Detail

setDescription

public ColorParameter setDescription(String description)

Overrides:

setDescription in class LXListenableParameter

getColor

public int getColor()

setColor

public ColorParameter setColor(int color)

getHexString

public String getHexString()

updateValue

protected double updateValue(double value)

Description copied from class: LXListenableParameter

Invoked when the value has changed. Subclasses should update any special internal state according to this new value.

Specified by:

updateValue in class LXListenableParameter

Parameters:

value - New value

Returns:

this

onParameterChanged

public void onParameterChanged(LXParameter parameter)

Description copied from interface: LXParameterListener

Invoked when the value of a parameter is changed.

Specified by:

onParameterChanged in interface LXParameterListener

Parameters:

parameter - The parameter that has changed its value

dispose

public void dispose()

Description copied from interface: LXParameter

Invoked when the parameter is done being used and none of its resources are needed anymore.

Specified by:

dispose in interface LXParameter

Overrides:

dispose in class LXListenableParameter