GateEffect (LX API)

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, LXLoopTask, LXPath, LXSerializable, LXMidiListener, LXModulationContainer, LXOscComponent, LXParameterListener
```
@LXCategory(value="MIDI")
public class GateEffect
extends LXEffect
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GateEffect.TriggerMode
- Nested classes/interfaces inherited from class heronarts.lx.effect.LXEffect
  LXEffect.Placeholder, 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`GateEffect.TriggerMode`

Field Summary

Fields
Modifier and Type	Field and Description
`CompoundParameter`	`attack`
`CompoundParameter`	`ceiling`
`CompoundParameter`	`decay`
`CompoundParameter`	`floor`
`BooleanParameter`	`manualTrigger`
`BooleanParameter`	`midiEnabled`
`DiscreteParameter`	`midiMinNote`
`DiscreteParameter`	`midiNoteRange`
`BoundedParameter`	`midiVelocityResponse`
`CompoundParameter`	`release`
`CompoundParameter`	`shape`
`CompoundParameter`	`sustain`
`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, 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
Constructor and Description

GateEffect(LX lx)

Constructors
Constructor and Description
`GateEffect(LX lx)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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, getPath, isEnabled, isRemoteControl, onDisable, onEnable, onLoop, setBus, setDamping, setDampingTime, setDampingTime, setIndex, toggle

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, 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, pitchBendReceived, programChangeReceived

Methods inherited from interface heronarts.lx.LXPath
get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

- Field Detail
  - floor
```
public final CompoundParameter floor
```
  - ceiling
```
public final CompoundParameter ceiling
```
  - attack
```
public final CompoundParameter attack
```
  - decay
```
public final CompoundParameter decay
```
  - sustain
```
public final CompoundParameter sustain
```
  - release
```
public final CompoundParameter release
```
  - shape
```
public final CompoundParameter shape
```
  - triggerMode
```
public final EnumParameter<GateEffect.TriggerMode> triggerMode
```
  - manualTrigger
```
public final BooleanParameter manualTrigger
```
  - midiEnabled
```
public final BooleanParameter midiEnabled
```
  - midiVelocityResponse
```
public final BoundedParameter midiVelocityResponse
```
  - midiMinNote
```
public final DiscreteParameter midiMinNote
```
  - midiNoteRange
```
public final DiscreteParameter midiNoteRange
```
- Constructor Detail
  - GateEffect
```
public GateEffect(LX lx)
```
- Method Detail
  - 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)
```
  - noteOffReceived
```
public void noteOffReceived(MidiNote note)
```

Class GateEffect

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class heronarts.lx.effect.LXEffect

Fields inherited from class heronarts.lx.LXDeviceComponent

Fields inherited from class heronarts.lx.LXLayeredComponent

Fields inherited from class heronarts.lx.LXModelComponent

Fields inherited from class heronarts.lx.LXModulatorComponent

Fields inherited from class heronarts.lx.LXComponent

Constructor Summary

Method Summary

Methods inherited from class heronarts.lx.effect.LXEffect

Methods inherited from class heronarts.lx.LXDeviceComponent

Methods inherited from class heronarts.lx.LXLayeredComponent

Methods inherited from class heronarts.lx.LXModelComponent

Methods inherited from class heronarts.lx.LXModulatorComponent

Methods inherited from class heronarts.lx.LXComponent

Methods inherited from class java.lang.Object

Methods inherited from interface heronarts.lx.osc.LXOscComponent

Methods inherited from interface heronarts.lx.midi.LXMidiListener

Methods inherited from interface heronarts.lx.LXPath

Field Detail

floor

ceiling

attack

decay

sustain

release

shape

triggerMode

manualTrigger

midiEnabled

midiVelocityResponse

midiMinNote

midiNoteRange

Constructor Detail

GateEffect

Method Detail

onParameterChanged

run

noteOnReceived

noteOffReceived