heronarts.lx.effect

Class LXEffect

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.LXModelComponent

heronarts.lx.LXLayeredComponent

heronarts.lx.LXDeviceComponent

heronarts.lx.effect.LXEffect

All Implemented Interfaces:

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

Direct Known Subclasses:

BlurEffect, ColorizeEffect, DynamicsEffect, GateEffect, HueSaturationEffect, InvertEffect, LXEffect.Placeholder, LXModelEffect, SparkleEffect, StrobeEffect

public abstract class LXEffect
extends LXDeviceComponent
implements LXComponent.Renamable, LXOscComponent

Class to represent an effect that may be applied to the color array. Effects may be stateless or stateful, though typically they operate on a single frame. Only the current frame is provided at runtime.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LXEffect.Placeholder Placeholder pattern for when a class is missing
class	LXEffect.Profiler

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

LXLayeredComponent.Buffered

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

LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
BooleanParameter	enabled
protected LinearEnvelope	enabledDamped
protected MutableParameter	enabledDampingAttack
protected MutableParameter	enabledDampingRelease
protected boolean	hasDamping
LXEffect.Profiler	profiler

Fields inherited from class heronarts.lx.LXDeviceComponent

controlsExpanded, crashed, DEVICE_CATEGORY_NAME_SORT, DEVICE_VERSION_UNSPECIFIED, KEY_DEVICE_VERSION, modulation, 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

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	LXEffect(LX lx)

Method Summary

Modifier and Type	Method and Description
LXEffect	disable() Disables the effect.
void	dispose() Invoked when a component is being removed from the system and will no longer be used at all.
LXEffect	enable() Enables the effect.
LXBus	getBus()
int	getIndex() Gets the index of this effect in the channel FX bus.
String	getPath() Accessor for the path of this object.
boolean	isEnabled()
protected boolean	isRemoteControl(LXListenableNormalizedParameter parameter) Subclasses may override this to filter out parameters that should not be controlled by a remote surface
protected void	onDisable()
protected void	onEnable()
void	onLoop(double deltaMs) Applies this effect to the current frame
protected abstract void	run(double deltaMs, double enabledAmount) Implementation of the effect.
LXEffect	setBus(LXBus bus)
LXEffect	setDamping(boolean hasDamping) Sets whether this effect uses damping or not
LXEffect	setDampingTime(double dampingTimeMs) Set the amount of damping time used when this effect is enabled and disabled.
protected LXEffect	setDampingTime(double dampingTimeEnabledMs, double dampingTimeDisabledMs) Set the amount of damping time used when this effect is enabled and disabled.
LXEffect	setIndex(int index) Called by the engine to assign index on this effect.
LXEffect	toggle() Toggles the effect.

Methods inherited from class heronarts.lx.LXDeviceComponent

getCategory, getCrash, getCrashStackTrace, getDeviceVersion, getModulationEngine, getRemoteControls, loop, save, setRemoteControls

Methods inherited from class heronarts.lx.LXLayeredComponent

addColor, addColor, addLayer, afterLayers, 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, 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, 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

enabled

public final BooleanParameter enabled

hasDamping

protected boolean hasDamping

enabledDampingAttack

protected final MutableParameter enabledDampingAttack

enabledDampingRelease

protected final MutableParameter enabledDampingRelease

enabledDamped

protected final LinearEnvelope enabledDamped

profiler

public final LXEffect.Profiler profiler

Constructor Detail

LXEffect

protected LXEffect(LX lx)

Method Detail

setDamping

public LXEffect setDamping(boolean hasDamping)

Sets whether this effect uses damping or not

Parameters:

hasDamping - If true, damping employed when effect is turned on/off

Returns:

this

setDampingTime

public LXEffect setDampingTime(double dampingTimeMs)

Set the amount of damping time used when this effect is enabled and disabled.

Parameters:

dampingTimeMs - Damping time in milliseconds

Returns:

this

setDampingTime

protected LXEffect setDampingTime(double dampingTimeEnabledMs,
                                  double dampingTimeDisabledMs)

Set the amount of damping time used when this effect is enabled and disabled.

Parameters:

dampingTimeEnabledMs - Damping time in milliseconds when effect enabled

dampingTimeDisabledMs - Damping time in milliseconds when effect disabled

Returns:

this

isRemoteControl

protected boolean isRemoteControl(LXListenableNormalizedParameter parameter)

Description copied from class: LXDeviceComponent

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

Overrides:

isRemoteControl in class LXDeviceComponent

Parameters:

parameter - Parameter to check

Returns:

Whether parameter is eligible for remote control

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

setIndex

public final LXEffect setIndex(int index)

Called by the engine to assign index on this effect. Should never be called otherwise.

Parameters:

index - Effect index

Returns:

this

getIndex

public final int getIndex()

Gets the index of this effect in the channel FX bus.

Returns:

index of this effect in the channel FX bus

setBus

public final LXEffect setBus(LXBus bus)

getBus

public LXBus getBus()

isEnabled

public final boolean isEnabled()

Returns:

whether the effect is currently enabled

toggle

public final LXEffect toggle()

Toggles the effect.

Returns:

this

enable

public final LXEffect enable()

Enables the effect.

Returns:

this

disable

public final LXEffect disable()

Disables the effect.

Returns:

this

onEnable

protected void onEnable()

onDisable

protected void onDisable()

onLoop

public final void onLoop(double deltaMs)

Applies this effect to the current frame

Overrides:

onLoop in class LXLayeredComponent

Parameters:

deltaMs - Milliseconds since last frame

run

protected abstract void run(double deltaMs,
                            double enabledAmount)

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

Parameters:

deltaMs - Number of milliseconds elapsed since last invocation

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

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 LXLayeredComponent