Package heronarts.lx.modulator

Class AHDSREnvelope

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.AHDSREnvelope

All Implemented Interfaces:

LXComponent.Renamable, LXLoopTask, LXPath, LXSerializable, LXNormalizedParameter, LXParameter, LXParameterListener

Direct Known Subclasses:

MultiModeEnvelope

public class AHDSREnvelope
extends LXModulator
implements LXNormalizedParameter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AHDSREnvelope.Stage
static enum	AHDSREnvelope.StageMode

Nested classes/interfaces inherited from class heronarts.lx.modulator.LXModulator

LXModulator.Device, LXModulator.Global, LXModulator.Placeholder

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.parameter.LXNormalizedParameter

LXNormalizedParameter.OscMode

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final LXParameter	attack
final LXParameter	decay
final LXParameter	delay
final BooleanParameter	engage
final LXParameter	hold
final LXParameter	initial
final BooleanParameter	oneshot
final LXParameter	peak
final LXParameter	release
final BooleanParameter	resetMode
final TriggerParameter	retrig
EnumParameter<AHDSREnvelope.StageMode>	stageMode
final LXParameter	sustain

Fields inherited from class heronarts.lx.modulator.LXModulator

crashed, midiFilter, midiSource

Fields inherited from class heronarts.lx.LXRunnableComponent

runMs, running, trigger

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
AHDSREnvelope(String label, LXParameter delay, LXParameter attack, LXParameter hold, LXParameter decay, LXParameter sustain, LXParameter release, LXParameter initial, LXParameter peak)

Method Summary

Modifier and Type	Method	Description
protected double	computeValue(double deltaMs)	Implementation method to advance the modulator's internal state.
double	getNormalized()	Gets the value of the parameter in a normalized space from 0 to 1
AHDSREnvelope.Stage	getStage()	Current stage of the envelope.
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
protected void	onStageChanged(AHDSREnvelope.Stage stage)	A subclass may override to perform custom logic in this method
LXNormalizedParameter	setNormalized(double value)	Sets the value or the parameter in normalized space from 0 to 1
AHDSREnvelope	setShape(LXParameter shape)

Methods inherited from class heronarts.lx.modulator.LXModulator

autostart, disableAutoStart, getCrash, getCrashStackTrace, getFormatter, getIndex, getOscAddress, getOscPath, getPath, getPolarity, getUnits, getValue, isMappingSource, loop, onSetValue, run, setComponent, setFormatter, setIndex, setMappingSource, setPolarity, setUnits, setValue, setValue, updateValue

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, onReset, onStart, onStop, onTrigger, postRun, reset, start, stop, toggle, trigger

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, dispose, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscLabel, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isValidOscParameter, load, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, 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.parameter.LXNormalizedParameter

getBaseNormalized, getBaseNormalizedf, getExponent, getNormalizedf, getOscMode, getValueFromNormalized, isWrappable

Methods inherited from interface heronarts.lx.parameter.LXParameter

dispose, getBaseValue, getBaseValuef, getFormatter, getLabel, getParentParameter, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setFormatter, setMappable, setValue

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Field Details

engage

public final BooleanParameter engage

retrig

public final TriggerParameter retrig

resetMode

public final BooleanParameter resetMode

oneshot

public final BooleanParameter oneshot

stageMode

public EnumParameter<AHDSREnvelope.StageMode> stageMode

delay

public final LXParameter delay

attack

public final LXParameter attack

hold

public final LXParameter hold

decay

public final LXParameter decay

sustain

public final LXParameter sustain

release

public final LXParameter release

initial

public final LXParameter initial

peak

public final LXParameter peak

Constructor Details

AHDSREnvelope

public AHDSREnvelope(String label,
 LXParameter delay,
 LXParameter attack,
 LXParameter hold,
 LXParameter decay,
 LXParameter sustain,
 LXParameter release,
 LXParameter initial,
 LXParameter peak)

Method Details

onStageChanged

protected void onStageChanged(AHDSREnvelope.Stage stage)

A subclass may override to perform custom logic in this method

Parameters:

stage - Stage that is now active

setShape

public AHDSREnvelope setShape(LXParameter shape)

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 LXRunnableComponent

Parameters:

p - Parameter that has a value change

computeValue

protected double computeValue(double deltaMs)

Description copied from class: LXModulator

Implementation method to advance the modulator's internal state. Subclasses must provide and update value appropriately.

Specified by:

computeValue in class LXModulator

Parameters:

deltaMs - Number of milliseconds to advance by

Returns:

Computed value

getStage

public AHDSREnvelope.Stage getStage()

Current stage of the envelope.

setNormalized

public LXNormalizedParameter setNormalized(double value)

Description copied from interface: LXNormalizedParameter

Sets the value or the parameter in normalized space from 0 to 1

Specified by:

setNormalized in interface LXNormalizedParameter

Parameters:

value - The normalized value, from 0 to 1

Returns:

this, for method chaining

getNormalized

public double getNormalized()

Description copied from interface: LXNormalizedParameter

Gets the value of the parameter in a normalized space from 0 to 1

Specified by:

getNormalized in interface LXNormalizedParameter

Returns:

Value of parameter, normalized to range from 0 to 1