heronarts.lx.color

Class LXPalette

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.color.LXPalette

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class LXPalette
extends LXComponent
implements LXLoopTask, LXOscComponent

A palette is an object that is used to keep track of top-level color values and set modes of color computation. Though its use is not required, it is very useful for creating coherent color schemes across patterns.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LXPalette.AutoCycleMode
static interface	LXPalette.Listener
static class	LXPalette.TransitionMode

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
DiscreteParameter	autoCycleCursor
BooleanParameter	autoCycleEnabled
EnumParameter<LXPalette.AutoCycleMode>	autoCycleMode Auto-cycle to a random palette, not the next one
BoundedParameter	autoCycleTimeSecs Time in seconds after which transition thru the pattern set is automatically initiated.
LXDynamicColor	color The primary active color value
LXSwatch	swatch The active color swatch
List<LXSwatch>	swatches A read-only list of all the saved color swatches
BooleanParameter	transitionEnabled
EnumParameter<LXPalette.TransitionMode>	transitionMode
BoundedParameter	transitionTimeSecs Amount of time taken in seconds to transition into a new snapshot view
BooleanParameter	triggerSwatchCycle

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
LXPalette(LX lx)

Method Summary

Modifier and Type	Method and Description
LXPalette	addListener(LXPalette.Listener listener) Registers a listener to the palette
LXSwatch	addSwatch(JsonObject swatchObj, int index) Adds a swatch at the given index
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
double	getAutoCycleProgress()
double	getBrightness() Gets the brightness of the primary color in active swatch
float	getBrightnessf() Gets the brightness of the primary color in active swatch
int	getColor() Gets the primary color of the currently active swatch
double	getHue() Gets the hue of the primary color in active swatch
float	getHuef() Gets the hue of the primary color in active swatch
double	getSaturation() Gets the saturation of the primary color in active swatch
float	getSaturationf() Gets the saturation of the primary color in active swatch
LXDynamicColor	getSwatchColor(int index) Gets the color in the active swatch at the given index.
double	getTransitionProgress()
void	load(LX lx, JsonObject obj) Loads the LX component.
void	loop(double deltaMs)
LXPalette	moveSwatch(LXSwatch swatch, int index) Moves a saved swatch to a different position in the list
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
LXPalette	removeListener(LXPalette.Listener listener) Unregisters a listener to the palette
LXPalette	removeSwatch(LXSwatch swatch) Removes a swatch from the color palette's saved swatch list
void	save(LX lx, JsonObject obj) Serializes the LX component.
LXSwatch	saveSwatch() Saves the current swatch to the list of saved swatches
LXPalette	setSwatch(LXSwatch swatch)

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, getPath, 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

swatches

public final List<LXSwatch> swatches

A read-only list of all the saved color swatches

swatch

public final LXSwatch swatch

The active color swatch

color

public final LXDynamicColor color

The primary active color value

autoCycleEnabled

public final BooleanParameter autoCycleEnabled

autoCycleMode

public final EnumParameter<LXPalette.AutoCycleMode> autoCycleMode

Auto-cycle to a random palette, not the next one

autoCycleTimeSecs

public final BoundedParameter autoCycleTimeSecs

Time in seconds after which transition thru the pattern set is automatically initiated.

autoCycleCursor

public final DiscreteParameter autoCycleCursor

triggerSwatchCycle

public final BooleanParameter triggerSwatchCycle

transitionTimeSecs

public final BoundedParameter transitionTimeSecs

Amount of time taken in seconds to transition into a new snapshot view

transitionEnabled

public final BooleanParameter transitionEnabled

transitionMode

public final EnumParameter<LXPalette.TransitionMode> transitionMode

Constructor Detail

LXPalette

public LXPalette(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

getColor

public int getColor()

Gets the primary color of the currently active swatch

Returns:

Primary color of active swatch

getSwatchColor

public LXDynamicColor getSwatchColor(int index)

Gets the color in the active swatch at the given index. If the swatch doesn't have that many colors, the last available color is returned.

Parameters:

index - Index in swatch

Returns:

Color

getHuef

public float getHuef()

Gets the hue of the primary color in active swatch

Returns:

Hue of primary color

getHue

public double getHue()

Gets the hue of the primary color in active swatch

Returns:

Hue of primary color

getSaturationf

public float getSaturationf()

Gets the saturation of the primary color in active swatch

Returns:

Saturation of primary color

getSaturation

public double getSaturation()

Gets the saturation of the primary color in active swatch

Returns:

Saturation of primary color

getBrightnessf

public float getBrightnessf()

Gets the brightness of the primary color in active swatch

Returns:

Brightness of primary color

getBrightness

public double getBrightness()

Gets the brightness of the primary color in active swatch

Returns:

Brightness of primary color

saveSwatch

public LXSwatch saveSwatch()

Saves the current swatch to the list of saved swatches

Returns:

Saved swatch, added to swatch list

addSwatch

public LXSwatch addSwatch(JsonObject swatchObj,
                          int index)

Adds a swatch at the given index

Parameters:

swatchObj - Saved swatch object

index - Index to save at

Returns:

Swatch object

removeSwatch

public LXPalette removeSwatch(LXSwatch swatch)

Removes a swatch from the color palette's saved swatch list

Parameters:

swatch - Swatch to remove

Returns:

this

setSwatch

public LXPalette setSwatch(LXSwatch swatch)

getTransitionProgress

public double getTransitionProgress()

getAutoCycleProgress

public double getAutoCycleProgress()

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

moveSwatch

public LXPalette moveSwatch(LXSwatch swatch,
                            int index)

Moves a saved swatch to a different position in the list

Parameters:

swatch - Saved swatch

index - New index for that swatch

Returns:

this

addListener

public LXPalette addListener(LXPalette.Listener listener)

Registers a listener to the palette

Parameters:

listener - Palette listener

Returns:

this

removeListener

public LXPalette removeListener(LXPalette.Listener listener)

Unregisters a listener to the palette

Parameters:

listener - Palette listener

Returns:

this

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

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