heronarts.lx.modulation

Class LXParameterModulation

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.modulation.LXParameterModulation

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener

Direct Known Subclasses:

LXCompoundModulation, LXTriggerModulation

public abstract class LXParameterModulation
extends LXComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LXParameterModulation.CircularDependencyException
static class	LXParameterModulation.InvalidScopeException
static class	LXParameterModulation.ModulationException

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
DiscreteColorParameter	clr
DiscreteColorParameter	color
BooleanParameter	enabled
protected int	index
protected static String	KEY_SOURCE
protected static String	KEY_TARGET
LXParameter	source
LXParameter	target

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

Modifier	Constructor and Description
protected	LXParameterModulation(LXModulationEngine scope, LXParameter source, LXParameter target)

Method Summary

Modifier and Type	Method and Description
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
int	getIndex()
String	getLabel() Accessor for the user-facing label of this component.
protected static LXParameter	getParameter(LX lx, LXModulationEngine scope, JsonObject obj)
LXParameter	getTarget()
void	save(LX lx, JsonObject obj) Serializes the LX component.
LXParameterModulation	setIndex(int index)

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, getChild, getComponentName, getComponentName, getComponentName, getId, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, load, loadParameters, onParameterChanged, 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.LXPath

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

Field Detail

index

protected int index

source

public final LXParameter source

target

public final LXParameter target

color

public final DiscreteColorParameter color

clr

public final DiscreteColorParameter clr

enabled

public final BooleanParameter enabled

KEY_SOURCE

protected static final String KEY_SOURCE

See Also:

Constant Field Values

KEY_TARGET

protected static final String KEY_TARGET

See Also:

Constant Field Values

Constructor Detail

LXParameterModulation

protected LXParameterModulation(LXModulationEngine scope,
                                LXParameter source,
                                LXParameter target)
                         throws LXParameterModulation.ModulationException

Throws:

LXParameterModulation.ModulationException

Method Detail

setIndex

public LXParameterModulation setIndex(int index)

getIndex

public int getIndex()

getTarget

public LXParameter getTarget()

getLabel

public String getLabel()

Description copied from class: LXComponent

Accessor for the user-facing label of this component. Objects that implement the LXComponent.Renamable interface may allow the user to change this value.

Specified by:

getLabel in interface LXPath

Overrides:

getLabel in class LXComponent

Returns:

Label for this component

getParameter

protected static LXParameter getParameter(LX lx,
                                          LXModulationEngine scope,
                                          JsonObject obj)

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