Package heronarts.lx.effect.midi

Class GateEffect

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.midi.GateEffect

All Implemented Interfaces:

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

@LXCategory("MIDI")
public class GateEffect
extends LXEffect
implements LXDeviceComponent.Midi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GateEffect.EnvelopeMode
static enum	GateEffect.TriggerMode

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

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.Hidden, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final CompoundParameter	attack
final CompoundParameter	decay
final CompoundParameter	delay
final AHDSREnvelope	env
final EnumParameter<GateEffect.EnvelopeMode>	envelopeMode
final CompoundParameter	hold
final CompoundParameter	initial
final BooleanParameter	manualTrigger
final BoundedParameter	midiNoteResponse
final BoundedParameter	midiVelocityResponse
final CompoundParameter	peak
final CompoundParameter	release
final CompoundParameter	shape
final CompoundParameter	sustain
final TriggerParameter	targetTrigger
final EnumParameter<GateEffect.TriggerMode>	triggerMode

Fields inherited from class heronarts.lx.effect.LXEffect

enabled, enabledDamped, enabledDampingAttack, enabledDampingRelease, hasDamping, profiler

Fields inherited from class heronarts.lx.LXDeviceComponent

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

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

Method Summary

Modifier and Type	Method	Description
void	noteOffReceived(MidiNote note)
void	noteOnReceived(MidiNoteOn note)
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
protected void	run(double deltaMs, double enabledAmount)	Implementation of the effect.

Methods inherited from class heronarts.lx.effect.LXEffect

disable, dispose, enable, getBus, 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

addControlSurface, clearCustomRemoteControls, getControlSurfaces, getCrash, getCrashStackTrace, getCustomRemoteControls, getDeviceVersion, getModulationEngine, getRemoteControls, isSnapshotControl, load, loop, midiDispatch, removeControlSurface, removeCustomRemoteControl, resetRemoteControls, save, setCustomRemoteControls, 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, addModulator, addModulator, constructProfiler, getModulator, getModulators, moveModulator, removeModulator, startModulator

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, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, 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, pitchBendReceived, programChangeReceived

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Methods inherited from interface heronarts.lx.LXPresetComponent

getPresetClass, postProcessPreset

Field Details

initial

public final CompoundParameter initial

peak

public final CompoundParameter peak

delay

public final CompoundParameter delay

attack

public final CompoundParameter attack

hold

public final CompoundParameter hold

decay

public final CompoundParameter decay

sustain

public final CompoundParameter sustain

release

public final CompoundParameter release

shape

public final CompoundParameter shape

envelopeMode

public final EnumParameter<GateEffect.EnvelopeMode> envelopeMode

triggerMode

public final EnumParameter<GateEffect.TriggerMode> triggerMode

manualTrigger

public final BooleanParameter manualTrigger

targetTrigger

public final TriggerParameter targetTrigger

midiVelocityResponse

public final BoundedParameter midiVelocityResponse

midiNoteResponse

public final BoundedParameter midiNoteResponse

env

public final AHDSREnvelope env

Constructor Details

GateEffect

public GateEffect(LX lx)

Method Details

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXComponent

Parameters:

p - Parameter that has a value change

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

noteOnReceived

public void noteOnReceived(MidiNoteOn note)

Specified by:

noteOnReceived in interface LXMidiListener

noteOffReceived

public void noteOffReceived(MidiNote note)

Specified by:

noteOffReceived in interface LXMidiListener