heronarts.lx

Class LXDeviceComponent

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.LXLayeredComponent

heronarts.lx.LXDeviceComponent

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXMidiListener, LXModulationContainer, LXOscComponent, LXParameterListener

Direct Known Subclasses:

LXEffect, LXPattern

public abstract class LXDeviceComponent
extends LXLayeredComponent
implements LXModulationContainer, LXOscComponent, LXMidiListener

A component which may have its own scoped user-level modulators. The concrete subclasses of this are Patterns and Effects.

Nested Class Summary

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

LXLayeredComponent.Buffered

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

LXModulatorComponent.Profiler

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	controlsExpanded
BooleanParameter	crashed
static Comparator<Class<? extends LXDeviceComponent>>	DEVICE_CATEGORY_NAME_SORT
protected static int	DEVICE_VERSION_UNSPECIFIED
protected static String	KEY_DEVICE_VERSION
LXModulationEngine	modulation
BooleanParameter	modulationExpanded

Fields inherited from class heronarts.lx.LXLayeredComponent

colors, layers, palette

Fields inherited from class heronarts.lx.LXModelComponent

model

Fields inherited from class heronarts.lx.LXModulatorComponent

modulators, profiler

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	LXDeviceComponent(LX lx)
protected	LXDeviceComponent(LX lx, String label)

Method Summary

Modifier and Type	Method and Description
static String	getCategory(Class<? extends LXDeviceComponent> clazz)
Throwable	getCrash()
String	getCrashStackTrace()
int	getDeviceVersion() Subclasses may override this and provide a version identifier.
LXModulationEngine	getModulationEngine()
LXListenableNormalizedParameter[]	getRemoteControls() Subclasses may override this.
protected boolean	isRemoteControl(LXListenableNormalizedParameter parameter) Subclasses may override this to filter out parameters that should not be controlled by a remote surface
void	loop(double deltaMs)
void	save(LX lx, JsonObject obj) Serializes the LX component.
protected void	setRemoteControls(LXListenableNormalizedParameter... remoteControls)

Methods inherited from class heronarts.lx.LXLayeredComponent

addColor, addColor, addLayer, afterLayers, blendColor, blendColor, clearColors, dispose, getBuffer, getColor, getColor, getColors, getLayers, onLoop, removeLayer, setBuffer, setBuffer, setColor, setColor, setColor, setColors, subtractColor

Methods inherited from class heronarts.lx.LXModelComponent

getModel, onModelChanged, setModel

Methods inherited from class heronarts.lx.LXModulatorComponent

addModulator, addModulator, addModulator, constructProfiler, getModulator, getModulators, moveModulator, removeModulator, startModulator

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, 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.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.midi.LXMidiListener

aftertouchReceived, controlChangeReceived, noteOffReceived, noteOnReceived, pitchBendReceived, programChangeReceived

Methods inherited from interface heronarts.lx.LXPath

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

Field Detail

DEVICE_CATEGORY_NAME_SORT

public static final Comparator<Class<? extends LXDeviceComponent>> DEVICE_CATEGORY_NAME_SORT

DEVICE_VERSION_UNSPECIFIED

protected static final int DEVICE_VERSION_UNSPECIFIED

See Also:

Constant Field Values

modulation

public final LXModulationEngine modulation

crashed

public final BooleanParameter crashed

controlsExpanded

public final BooleanParameter controlsExpanded

modulationExpanded

public final BooleanParameter modulationExpanded

KEY_DEVICE_VERSION

protected static final String KEY_DEVICE_VERSION

See Also:

Constant Field Values

Constructor Detail

LXDeviceComponent

protected LXDeviceComponent(LX lx)

LXDeviceComponent

protected LXDeviceComponent(LX lx,
                            String label)

Method Detail

getCategory

public static String getCategory(Class<? extends LXDeviceComponent> clazz)

isRemoteControl

protected boolean isRemoteControl(LXListenableNormalizedParameter parameter)

Subclasses may override this to filter out parameters that should not be controlled by a remote surface

Parameters:

parameter - Parameter to check

Returns:

Whether parameter is eligible for remote control

setRemoteControls

protected void setRemoteControls(LXListenableNormalizedParameter... remoteControls)

getRemoteControls

public LXListenableNormalizedParameter[] getRemoteControls()

Subclasses may override this. The method returns an array of parameters in order that can be addressed by a remote control surface

Returns:

Array of parameters for a remote control surface to address

getDeviceVersion

public int getDeviceVersion()

Subclasses may override this and provide a version identifier. This will be written to project files when this device is saved. The version should be incremented when change to the code makes old parameter values incompatible, and the implementation should handle loading old values if possible.

Returns:

Version number of this device

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

Overrides:

loop in class LXLayeredComponent

getCrash

public Throwable getCrash()

getCrashStackTrace

public String getCrashStackTrace()

getModulationEngine

public LXModulationEngine getModulationEngine()

Specified by:

getModulationEngine in interface LXModulationContainer

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