Package heronarts.lx.modulator

Class MultiStageEnvelope

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.LXPeriodicModulator

heronarts.lx.modulator.LXRangeModulator

heronarts.lx.modulator.LXVariablePeriodModulator

heronarts.lx.modulator.MultiStageEnvelope

All Implemented Interfaces:

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

@LXCategory("Core")
@Global("Envelope")
@Device("Envelope")
public class MultiStageEnvelope
extends LXVariablePeriodModulator
implements LXWaveshape, LXOscComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MultiStageEnvelope.Stage

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

LXVariablePeriodModulator.ClockMode

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.Hidden, 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 MutableParameter	monitor
final List<MultiStageEnvelope.Stage>	stages

Fields inherited from class heronarts.lx.modulator.LXVariablePeriodModulator

clockMode, periodFast, periodSlow

Fields inherited from class heronarts.lx.modulator.LXPeriodicModulator

looping, tempoDivision, tempoLock, tempoSync

Fields inherited from class heronarts.lx.modulator.LXModulator

crashed, midiFilter

Fields inherited from class heronarts.lx.LXRunnableComponent

runMs, running, trigger

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

Fields inherited from interface heronarts.lx.modulator.LXWaveshape

DOWN, SIN, SQUARE, TRI, UP

Constructor Summary

Constructors

Constructor	Description
MultiStageEnvelope()
MultiStageEnvelope(String label)
MultiStageEnvelope(String label, float initialValue, float endValue)

Method Summary

Modifier and Type	Method	Description
MultiStageEnvelope.Stage	addStage(double basis, double value)
MultiStageEnvelope.Stage	addStage(MultiStageEnvelope.Stage stage)
double	compute(double basis)
protected double	computeNormalizedBasis(double basis, double normalizedValue)	Subclasses determine the basis based on a normalized value from 0 to 1.
protected double	computeNormalizedValue(double deltaMs, double basis)	Subclasses implement this which returns their value from a 0-1 scale.
double	invert(double value, double basisHint)
void	load(LX lx, JsonObject obj)	Loads the LX component.
MultiStageEnvelope	removeStage(MultiStageEnvelope.Stage stage)
void	save(LX lx, JsonObject obj)	Serializes the LX component.

Methods inherited from class heronarts.lx.modulator.LXVariablePeriodModulator

onParameterChanged

Methods inherited from class heronarts.lx.modulator.LXRangeModulator

computeBasis, computeValue, getExponent, getNormalized, getNormalizedf, onSetValue, setEndValue, setEndValue, setExponent, setNormalized, setRange, setRange, setRangeFromHereTo, setRangeFromHereTo, setStartValue, setStartValue

Methods inherited from class heronarts.lx.modulator.LXPeriodicModulator

computeValue, disableAutoReset, finished, getBasis, getBasisf, getPeriod, getPeriodf, loop, loop, numLoops, onReset, randomBasis, setBasis, setLooping, setPeriod, setPeriod, updateBasis

Methods inherited from class heronarts.lx.modulator.LXModulator

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

Methods inherited from class heronarts.lx.LXRunnableComponent

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

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, dispose, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscLabel, 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.parameter.LXNormalizedParameter

getBaseNormalized, getBaseNormalizedf, getOscMode, getValueFromNormalized, isWrappable

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

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, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Field Details

stages

public final List<MultiStageEnvelope.Stage> stages

monitor

public final MutableParameter monitor

Constructor Details

MultiStageEnvelope

public MultiStageEnvelope()

MultiStageEnvelope

public MultiStageEnvelope(String label)

MultiStageEnvelope

public MultiStageEnvelope(String label,
 float initialValue,
 float endValue)

Method Details

removeStage

public MultiStageEnvelope removeStage(MultiStageEnvelope.Stage stage)

addStage

public MultiStageEnvelope.Stage addStage(MultiStageEnvelope.Stage stage)

addStage

public MultiStageEnvelope.Stage addStage(double basis,
 double value)

computeNormalizedValue

protected double computeNormalizedValue(double deltaMs,
 double basis)

Description copied from class: LXRangeModulator

Subclasses implement this which returns their value from a 0-1 scale. This class automatically takes care of scaling to the startValue/endValue range.

Specified by:

computeNormalizedValue in class LXRangeModulator

Parameters:

deltaMs - Milliseconds elapsed

basis - Basis of modulator

Returns:

Modulator value

computeNormalizedBasis

protected double computeNormalizedBasis(double basis,
 double normalizedValue)

Description copied from class: LXRangeModulator

Subclasses determine the basis based on a normalized value from 0 to 1.

Specified by:

computeNormalizedBasis in class LXRangeModulator

Parameters:

basis - Modulator basis

normalizedValue - A normalize value from 0 to 1

Returns:

Computed normalized basis for modulator

compute

public double compute(double basis)

Specified by:

compute in interface LXWaveshape

invert

public double invert(double value,
 double basisHint)

Specified by:

invert in interface LXWaveshape

save

public void save(LX lx,
 JsonObject obj)

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 LXPeriodicModulator

Parameters:

lx - LX instance

obj - Object to serialize into

load

public void load(LX lx,
 JsonObject obj)

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 LXPeriodicModulator

Parameters:

lx - LX instance

obj - Object to deserialize