Package heronarts.lx.modulation

Class LXTriggerModulation

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.modulation.LXParameterModulation

heronarts.lx.modulation.LXTriggerModulation

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener

public class LXTriggerModulation
extends LXParameterModulation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LXTriggerModulation.MomentaryToggleMode
static enum	LXTriggerModulation.ToggleMode
static enum	LXTriggerModulation.ToggleMomentaryMode

Nested classes/interfaces inherited from class heronarts.lx.modulation.LXParameterModulation

LXParameterModulation.CircularDependencyException, LXParameterModulation.InvalidScopeException, LXParameterModulation.ModulationException

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

LXComponent.Hidden, LXComponent.Placeholder, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final EnumParameter<LXTriggerModulation.MomentaryToggleMode>	momentaryToggleMode
final BooleanParameter	source
final BooleanParameter	target
final EnumParameter<LXTriggerModulation.ToggleMode>	toggleMode
final EnumParameter<LXTriggerModulation.ToggleMomentaryMode>	toggleMomentaryMode

Fields inherited from class heronarts.lx.modulation.LXParameterModulation

clr, color, enabled, index, KEY_SOURCE, KEY_TARGET, scope

Fields inherited from class heronarts.lx.LXComponent

children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
LXTriggerModulation(LX lx, LXModulationEngine scope, JsonObject obj)
LXTriggerModulation(LXModulationEngine scope, BooleanParameter source, BooleanParameter target)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
EnumParameter<?>	getModeParameter()
String	getPath()	Accessor for the path of this object.

Methods inherited from class heronarts.lx.modulation.LXParameterModulation

getIndex, getLabel, getParameter, getTarget, save, setIndex

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isValidOscParameter, load, loadParameters, loadPreset, onParameterChanged, removeParameter, removeParameter, removeParameter, removeParameter, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, 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

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

source

public final BooleanParameter source

target

public final BooleanParameter target

toggleMode

public final EnumParameter<LXTriggerModulation.ToggleMode> toggleMode

momentaryToggleMode

public final EnumParameter<LXTriggerModulation.MomentaryToggleMode> momentaryToggleMode

toggleMomentaryMode

public final EnumParameter<LXTriggerModulation.ToggleMomentaryMode> toggleMomentaryMode

Constructor Details

LXTriggerModulation

public LXTriggerModulation(LX lx,
 LXModulationEngine scope,
 JsonObject obj)
                    throws LXParameterModulation.ModulationException

Throws:

LXParameterModulation.ModulationException

LXTriggerModulation

public LXTriggerModulation(LXModulationEngine scope,
 BooleanParameter source,
 BooleanParameter target)
                    throws LXParameterModulation.ModulationException

Throws:

LXParameterModulation.ModulationException

Method Details

getModeParameter

public EnumParameter<?> getModeParameter()

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

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 LXParameterModulation