Package heronarts.lx.color

Class LinkedColorParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.AggregateParameter

heronarts.lx.color.ColorParameter

heronarts.lx.color.LinkedColorParameter

All Implemented Interfaces:

LXPath, LXParameter

public class LinkedColorParameter
extends ColorParameter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LinkedColorParameter.Mode

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 LXPalette.IndexSelector	index
final EnumParameter<LinkedColorParameter.Mode>	mode

Fields inherited from class heronarts.lx.color.ColorParameter

brightness, color, hue, PATH_BRIGHTNESS, PATH_HUE, PATH_SATURATION, 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
LinkedColorParameter(String label)
LinkedColorParameter(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	getColor()	Returns the fixed color defined by this parameter.
LXDynamicColor	getPaletteColor()
protected void	onSubparameterUpdate(LXParameter p)	Subclasses should update the main parameter value when a sub-parameter has changed
LinkedColorParameter	setDescription(String description)
LinkedColorParameter	setIndex(int index)
LinkedColorParameter	setMode(LinkedColorParameter.Mode mode)

Methods inherited from class heronarts.lx.color.ColorParameter

getBaseColor, getHexString, getRemoteControl, isBlack, onUpdateValue, setColor, updateSubparameters

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

mode

public final EnumParameter<LinkedColorParameter.Mode> mode

index

public final LXPalette.IndexSelector index

Constructor Details

LinkedColorParameter

public LinkedColorParameter(String label)

LinkedColorParameter

public LinkedColorParameter(String label,
 int color)

Method Details

setDescription

public LinkedColorParameter setDescription(String description)

Overrides:

setDescription in class ColorParameter

setMode

public LinkedColorParameter setMode(LinkedColorParameter.Mode mode)

setIndex

public LinkedColorParameter setIndex(int index)

getPaletteColor

public LXDynamicColor getPaletteColor()

onSubparameterUpdate

protected void onSubparameterUpdate(LXParameter p)

Description copied from class: AggregateParameter

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

Overrides:

onSubparameterUpdate in class ColorParameter

Parameters:

p - Subparameter that has changed

calcColor

public int calcColor()

Description copied from class: ColorParameter

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

Overrides:

calcColor in class ColorParameter

Returns:

Generated color value

getColor

public int getColor()

Description copied from class: ColorParameter

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.

Overrides:

getColor in class ColorParameter

Returns:

fixed color specified by the parameter