Package heronarts.lx.color

Class ColorParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.AggregateParameter

heronarts.lx.color.ColorParameter

All Implemented Interfaces:

LXPath, LXParameter

Direct Known Subclasses:

LinkedColorParameter

public class ColorParameter
extends AggregateParameter

Nested Class Summary

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

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields

Modifier and Type	Field	Description
final CompoundParameter	brightness
protected int	color
final CompoundParameter	hue
static final String	PATH_BRIGHTNESS
static final String	PATH_HUE
static final String	PATH_SATURATION
final CompoundParameter	saturation

Fields inherited from class heronarts.lx.parameter.AggregateParameter

subparameters

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	calcColor()	Calculates the potentially modulated value of the color parameter based upon the parameter values at this precise instance.
int	getBaseColor()
int	getColor()	Returns the fixed color defined by this parameter.
String	getHexString()
LXListenableNormalizedParameter	getRemoteControl()	Subclasses may override.
boolean	isBlack()
protected void	onSubparameterUpdate(LXParameter p)	Subclasses should update the main parameter value when a sub-parameter has changed
protected double	onUpdateValue(double value)	Subclasses may optionally override to take action based upon directly updated value
ColorParameter	setColor(int color)
ColorParameter	setDescription(String description)
protected void	updateSubparameters(double value)	Subclasses should update the subparameter values based upon the raw parameter value if it has been set directly.

Methods inherited from class heronarts.lx.parameter.AggregateParameter

addSubparameter, dispose, updateValue

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, addListener, bang, getDescription, getFormatter, getLabel, getParent, getParentParameter, getPath, getPolarity, getUnits, getValue, incrementValue, isDefault, isMappable, removeListener, reset, reset, setComponent, setFormatter, setMappable, setPolarity, setUnits, setValue, 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.parameter.LXParameter

getBaseValue, getBaseValuef, getValuef

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

hue

public final CompoundParameter hue

saturation

public final CompoundParameter saturation

brightness

public final CompoundParameter brightness

PATH_BRIGHTNESS

public static final String PATH_BRIGHTNESS

See Also:

• Constant Field Values

PATH_SATURATION

public static final String PATH_SATURATION

See Also:

• Constant Field Values

PATH_HUE

public static final String PATH_HUE

See Also:

• Constant Field Values

color

protected int color

Constructor Details

ColorParameter

public ColorParameter(String label)

ColorParameter

public ColorParameter(String label,
 int color)

Method Details

getRemoteControl

public LXListenableNormalizedParameter getRemoteControl()

Description copied from class: AggregateParameter

Subclasses may override. By default an AggregateParameter returns its first subparameter that is an LXListenableNormalizedParameter for remote control surface.

Overrides:

getRemoteControl in class AggregateParameter

Returns:

Subparameter to be used by a remote control surface

setDescription

public ColorParameter setDescription(String description)

Overrides:

setDescription in class LXListenableParameter

getColor

public int getColor()

Returns the fixed color defined by this parameter. Note that this does not take into account any modulation applied to the hue/saturation/brightness values.

Returns:

fixed color specified by the parameter

getBaseColor

public int getBaseColor()

calcColor

public int calcColor()

Calculates the potentially modulated value of the color parameter based upon the parameter values at this precise instance.

Returns:

Generated color value

setColor

public ColorParameter setColor(int color)

isBlack

public boolean isBlack()

getHexString

public String getHexString()

onUpdateValue

protected double onUpdateValue(double value)

Description copied from class: AggregateParameter

Subclasses may optionally override to take action based upon directly updated value

Overrides:

onUpdateValue in class AggregateParameter

Parameters:

value - Updated value

Returns:

Value to store

updateSubparameters

protected void updateSubparameters(double value)

Description copied from class: AggregateParameter

Subclasses should update the subparameter values based upon the raw parameter value if it has been set directly.

Specified by:

updateSubparameters in class AggregateParameter

onSubparameterUpdate

protected void onSubparameterUpdate(LXParameter p)

Description copied from class: AggregateParameter

Subclasses should update the main parameter value when a sub-parameter has changed

Specified by:

onSubparameterUpdate in class AggregateParameter

Parameters:

p - Subparameter that has changed