heronarts.lx.color

Class LXSwatch

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.color.LXSwatch

All Implemented Interfaces:

LXComponent.Renamable, LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class LXSwatch
extends LXComponent
implements LXLoopTask, LXOscComponent, LXComponent.Renamable

A swatch is a set of up to 5 dynamic colors that can be referenced by patterns and effects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LXSwatch.Listener

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Placeholder, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
BooleanParameter	autoCycleEligible
List<LXDynamicColor>	colors
static int	MAX_COLORS
BooleanParameter	recall

Fields inherited from class heronarts.lx.LXComponent

controlSurfaceSemaphore, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_PARAMETER_PATH, KEY_PATH, label, lx, modulationColor

Constructor Summary

Constructors

Constructor and Description
LXSwatch(LX lx)

Method Summary

Modifier and Type	Method and Description
LXDynamicColor	addColor() Adds a new dynamic color to the swatch
LXDynamicColor	addColor(int index, JsonObject colorObj)
LXSwatch	addListener(LXSwatch.Listener listener) Registers a listener to the swatch
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
LXDynamicColor	getColor(int index) Retrieves the color at a given index in the swatch.
int	getIndex()
String	getPath() Accessor for the path of this object.
void	load(LX lx, JsonObject obj) Loads the LX component.
void	loop(double deltaMs)
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
LXDynamicColor	removeColor() Removes the last color from the swatch
LXDynamicColor	removeColor(int index) Removes the color at a specific index from the swatch
LXDynamicColor	removeColor(LXDynamicColor color) Removes a specific color from the swatch
LXSwatch	removeListener(LXSwatch.Listener listener) Unregisters a listener to the swatch
void	save(LX lx, JsonObject obj) Serializes the LX component.

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, handleOscMessage, loadParameters, removeParameter, removeParameter, saveParameters, setParent, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

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

Field Detail

MAX_COLORS

public static final int MAX_COLORS

See Also:

Constant Field Values

colors

public final List<LXDynamicColor> colors

recall

public final BooleanParameter recall

autoCycleEligible

public final BooleanParameter autoCycleEligible

Constructor Detail

LXSwatch

public LXSwatch(LX lx)

Method Detail

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXComponent

Parameters:

p - Parameter that has a value change

getIndex

public int getIndex()

getPath

public String getPath()

Description copied from class: LXComponent

Accessor for the path of this object. Returns the path this component was registered with. Some subclasses may override this if path structure is dynamic.

Specified by:

getPath in interface LXPath

Overrides:

getPath in class LXComponent

Returns:

path of this component relative to its parent

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

getColor

public LXDynamicColor getColor(int index)

Retrieves the color at a given index in the swatch. If this swatch does not specify a color at that index, then the last valid color is returned instead.

Parameters:

index - Index

Returns:

Dynamic color at that index

addColor

public LXDynamicColor addColor()

Adds a new dynamic color to the swatch

Returns:

The newly added color

addColor

public LXDynamicColor addColor(int index,
                               JsonObject colorObj)

removeColor

public LXDynamicColor removeColor()

Removes the last color from the swatch

Returns:

The removed color

removeColor

public LXDynamicColor removeColor(LXDynamicColor color)

Removes a specific color from the swatch

Parameters:

color - The color to remove

Returns:

The removed color

removeColor

public LXDynamicColor removeColor(int index)

Removes the color at a specific index from the swatch

Parameters:

index - Index to remove

Returns:

Color removed

addListener

public LXSwatch addListener(LXSwatch.Listener listener)

Registers a listener to the swatch

Parameters:

listener - Swatch listener

Returns:

this

removeListener

public LXSwatch removeListener(LXSwatch.Listener listener)

Unregisters a listener to the swatch

Parameters:

listener - Swatch listener

Returns:

this

save

public void save(LX lx,
                 JsonObject obj)

Description copied from class: LXComponent

Serializes the LX component. By default, all internal and user-facing parameters are serialized, as well as any explicitly registered child components. Note that child arrays are not serialized, or any other dynamic components. Subclasses may override to perform more saving, and are expected to call super.save(lx, obj) at the appropriate time.

Specified by:

save in interface LXSerializable

Overrides:

save in class LXComponent

Parameters:

lx - LX instance

obj - Object to serialize into

load

public void load(LX lx,
                 JsonObject obj)

Description copied from class: LXComponent

Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.

Specified by:

load in interface LXSerializable

Overrides:

load in class LXComponent

Parameters:

lx - LX instance

obj - Object to deserialize

dispose

public void dispose()

Description copied from class: LXComponent

Invoked when a component is being removed from the system and will no longer be used at all. This unregisters the component and should free up any resources and parameter listeners. Ideally after this method is called the object should be eligible for garbage collection. Subclasses are generally expected to override this method to handle their particular cleanup work. They should also generally call super.dispose() at the appropriate time to perform the basic cleanup, which may need to happen either before or after cleaning up other objects.

Overrides:

dispose in class LXComponent