Package heronarts.lx

Class LXModulatorComponent

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXParameterListener

Direct Known Subclasses:

LXAudioEngine, LXBlend, LXDynamicColor, LXModelComponent, LXModulationEngine, Tempo

public abstract class LXModulatorComponent
extends LXComponent
implements LXLoopTask

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LXModulatorComponent.Profiler

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 List<LXModulator>	modulators
final LXModulatorComponent.Profiler	profiler

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

Modifier	Constructor	Description
protected	LXModulatorComponent(LX lx)
protected	LXModulatorComponent(LX lx, String label)

Method Summary

Modifier and Type	Method	Description
<T extends LXModulator> T	addModulator(String path, T modulator)
final <T extends LXModulator> T	addModulator(T modulator)
final <T extends LXModulator> T	addModulator(T modulator, int index)
<T extends LXModulator> T	addModulator(T modulator, int index, JsonObject modulatorObj)
final <T extends LXModulator> T	addModulator(T modulator, JsonObject modulatorObj)
protected LXModulatorComponent.Profiler	constructProfiler()
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
LXModulator	getModulator(String label)
List<LXModulator>	getModulators()
void	loop(double deltaMs)
<T extends LXModulator> T	moveModulator(T modulator, int index)
<T extends LXModulator> T	removeModulator(T modulator)
final <T extends LXModulator> T	startModulator(T modulator)

Methods inherited from class heronarts.lx.LXComponent

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

modulators

public final List<LXModulator> modulators

profiler

public final LXModulatorComponent.Profiler profiler

Constructor Details

LXModulatorComponent

protected LXModulatorComponent(LX lx)

LXModulatorComponent

protected LXModulatorComponent(LX lx,
 String label)

Method Details

constructProfiler

protected LXModulatorComponent.Profiler constructProfiler()

addModulator

public <T extends LXModulator> T addModulator(String path,
 T modulator)

addModulator

public final <T extends LXModulator> T addModulator(T modulator)

addModulator

public final <T extends LXModulator> T addModulator(T modulator,
 JsonObject modulatorObj)

addModulator

public final <T extends LXModulator> T addModulator(T modulator,
 int index)

addModulator

public <T extends LXModulator> T addModulator(T modulator,
 int index,
 JsonObject modulatorObj)

moveModulator

public <T extends LXModulator> T moveModulator(T modulator,
 int index)

startModulator

public final <T extends LXModulator> T startModulator(T modulator)

removeModulator

public <T extends LXModulator> T removeModulator(T modulator)

getModulator

public LXModulator getModulator(String label)

getModulators

public List<LXModulator> getModulators()

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

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask