heronarts.lx.modulator

Class ADEnvelope

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.ADEnvelope

All Implemented Interfaces:

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

public class ADEnvelope
extends LXModulator
implements LXNormalizedParameter

Nested Class Summary

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

LXComponent.Placeholder, LXComponent.Renamable

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

LXParameter.Formatter, LXParameter.Polarity, LXParameter.Units

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
BooleanParameter	engage

Fields inherited from class heronarts.lx.LXRunnableComponent

runMs, running, trigger

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
ADEnvelope(String label, double startValue, double endValue, LXParameter attack, LXParameter decay)
ADEnvelope(String label, double startValue, double endValue, LXParameter attack, LXParameter decay, LXParameter shape)
ADEnvelope(String label, double startValue, LXParameter endValue, LXParameter attack, LXParameter decay)
ADEnvelope(String label, double startValue, LXParameter endValue, LXParameter attack, LXParameter decay, LXParameter shape)
ADEnvelope(String label, LXParameter startValue, LXParameter endValue, LXParameter attack, LXParameter decay, LXParameter shape)

Method Summary

Modifier and Type	Method and Description
protected double	computeValue(double deltaMs) Implementation method to advance the modulator's internal state.
double	getExponent() Gets the exponent used for scaling this parameter across its normalized range.
double	getNormalized() Gets the value of the parameter in a normalized space from 0 to 1
float	getNormalizedf() Gets the value of the parameter in a normalized space as a float
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
void	onReset() Optional subclass method when reset happens.
LXNormalizedParameter	setNormalized(double value) Sets the value or the parameter in normalized space from 0 to 1

Methods inherited from class heronarts.lx.modulator.LXModulator

getDescription, getFormatter, getIndex, getOscAddress, getOscPath, getPath, getPolarity, getUnits, getValue, getValuef, onSetValue, run, setComponent, setDescription, setFormatter, setIndex, setPolarity, setUnits, setValue, setValue, updateValue

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, loop, onStart, onStop, reset, start, stop, toggle, trigger

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, dispose, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscLabel, getParameter, getParameters, getParent, handleOscMessage, load, loadParameters, removeParameter, removeParameter, save, 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.parameter.LXParameter

dispose, getDescription, getFormatter, getLabel, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setMappable, setValue

Methods inherited from interface heronarts.lx.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter, getParent, getPath

Field Detail

engage

public final BooleanParameter engage

Constructor Detail

ADEnvelope

public ADEnvelope(String label,
                  LXParameter startValue,
                  LXParameter endValue,
                  LXParameter attack,
                  LXParameter decay,
                  LXParameter shape)

ADEnvelope

public ADEnvelope(String label,
                  double startValue,
                  double endValue,
                  LXParameter attack,
                  LXParameter decay)

ADEnvelope

public ADEnvelope(String label,
                  double startValue,
                  double endValue,
                  LXParameter attack,
                  LXParameter decay,
                  LXParameter shape)

ADEnvelope

public ADEnvelope(String label,
                  double startValue,
                  LXParameter endValue,
                  LXParameter attack,
                  LXParameter decay)

ADEnvelope

public ADEnvelope(String label,
                  double startValue,
                  LXParameter endValue,
                  LXParameter attack,
                  LXParameter decay,
                  LXParameter shape)

Method Detail

onReset

public void onReset()

Description copied from class: LXRunnableComponent

Optional subclass method when reset happens.

Overrides:

onReset in class LXRunnableComponent

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

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

getNormalizedf

public float getNormalizedf()

Description copied from interface: LXNormalizedParameter

Gets the value of the parameter in a normalized space as a float

Specified by:

getNormalizedf in interface LXNormalizedParameter

Returns:

Normalized value of parameter, in range from 0 to 1

getExponent

public double getExponent()

Description copied from interface: LXNormalizedParameter

Gets the exponent used for scaling this parameter across its normalized range. Default is 1 which means linear scaling.

Specified by:

getExponent in interface LXNormalizedParameter

Returns:

scaling exponent

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