Package heronarts.lx.effect

Class LXEffect.Placeholder

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.LXLayeredComponent

heronarts.lx.LXDeviceComponent

heronarts.lx.effect.LXEffect

heronarts.lx.effect.LXEffect.Placeholder

All Implemented Interfaces:

LXComponent.Placeholder, LXComponent.Renamable, LXLoopTask, LXPath, LXPresetComponent, LXSerializable, LXMidiListener, LXModulationContainer, LXOscComponent, LXParameterListener

Enclosing class:

LXEffect

public static class LXEffect.Placeholder
extends LXEffect
implements LXComponent.Placeholder

Placeholder pattern for when a class is missing

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.effect.LXEffect

LXEffect.Container, LXEffect.Placeholder, LXEffect.Profiler

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

LXDeviceComponent.Midi

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

LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.PluginRequired, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields inherited from class heronarts.lx.effect.LXEffect

enabled, enabledDamped, enabledDampingAttack, enabledDampingRelease, hasDamping, locked, profiler

Fields inherited from class heronarts.lx.LXDeviceComponent

automationChildren, controlsExpanded, controlsExpandedAux, controlsExpandedCue, controlSurfaceSemaphore, crashed, DEVICE_CATEGORY_NAME_SORT, DEVICE_VERSION_UNSPECIFIED, KEY_DEVICE_VERSION, midiFilter, modulation, modulationExpanded, remoteControlsChanged, view, viewPriority

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

Fields inherited from class heronarts.lx.LXComponent

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

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
Placeholder(LX lx, LX.InstantiationException instantiationException)

Method Summary

Modifier and Type	Method	Description
LX.InstantiationException	getInstantiationException()
String	getPlaceholderClassName()
String	getPlaceholderTypeName()
void	load(LX lx, JsonObject object)	Loads the LX component.
protected void	run(double deltaMs, double enabledAmount)	Implementation of the effect.
void	save(LX lx, JsonObject object)	Serializes the LX component.

Methods inherited from class heronarts.lx.effect.LXEffect

disable, dispose, enable, getBus, getContainer, getIndex, getModelView, getPath, getPattern, isBusEffect, isEnabled, isHiddenControl, isPatternEffect, onDisable, onEnable, onLoop, setBus, setDamping, setDampingTime, setDampingTime, setIndex, setPattern, toggle

Methods inherited from class heronarts.lx.LXDeviceComponent

addAutomationChild, addControlSurface, clearCustomRemoteControls, getControlSurfaces, getCrash, getCrashStackTrace, getCustomRemoteControls, getDeviceDescription, getDeviceVersion, getModulationEngine, getModulationExpanded, getRemoteControls, isSnapshotControl, loop, midiDispatch, removeControlSurface, removeCustomRemoteControl, resetRemoteControls, setCustomRemoteControls, setRemoteControls

Methods inherited from class heronarts.lx.LXLayeredComponent

addColor, addColor, addLayer, afterLayers, applyEffects, blendColor, blendColor, clearColors, getBuffer, getColor, getColor, getColors, getLayers, 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, addModulator, addModulator, constructProfiler, getModulator, getModulators, moveModulator, removeModulator, startModulator

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isValidOscParameter, 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.midi.LXMidiListener

aftertouchReceived, controlChangeReceived, midiPanicReceived, noteOffReceived, noteOnReceived, pitchBendReceived, programChangeReceived, sysexReceived

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Methods inherited from interface heronarts.lx.LXPresetComponent

getPresetClass, postProcessPreset

Constructor Details

Placeholder

public Placeholder(LX lx,
 LX.InstantiationException instantiationException)

Method Details

getPlaceholderTypeName

public String getPlaceholderTypeName()

Specified by:

getPlaceholderTypeName in interface LXComponent.Placeholder

getPlaceholderClassName

public String getPlaceholderClassName()

Specified by:

getPlaceholderClassName in interface LXComponent.Placeholder

getInstantiationException

public LX.InstantiationException getInstantiationException()

Specified by:

getInstantiationException in interface LXComponent.Placeholder

save

public void save(LX lx,
 JsonObject object)

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 LXDeviceComponent

Parameters:

lx - LX instance

object - Object to serialize into

load

public void load(LX lx,
 JsonObject object)

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 LXDeviceComponent

Parameters:

lx - LX instance

object - Object to deserialize

run

protected void run(double deltaMs,
 double enabledAmount)

Description copied from class: LXEffect

Implementation of the effect. Subclasses need to override this to implement their functionality.

Specified by:

run in class LXEffect

Parameters:

deltaMs - Number of milliseconds elapsed since last invocation

enabledAmount - The amount of the effect to apply, scaled from 0-1