Package heronarts.lx.modulator

Class VariableLFO

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.VariableLFO

All Implemented Interfaces:

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

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

A sawtooth LFO oscillates from one extreme value to another. When the later value is hit, the oscillator rests to its initial value.

Nested Class Summary

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.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 CompoundParameter	bias
final CompoundParameter	exp
final CompoundParameter	periodCustom	Period of the waveform, in ms
final CompoundParameter	phase
final CompoundParameter	shape
final CompoundParameter	skew
final ObjectParameter<LXWaveshape>	waveshape	Parameter of LXWaveshape objects that select the wave shape used by this LFO.

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

Fields inherited from interface heronarts.lx.modulator.LXWaveshape

DOWN, SIN, SQUARE, TRI, UP

Constructor Summary

Constructors

Constructor	Description
VariableLFO()
VariableLFO(String label)
VariableLFO(String label, LXWaveshape[] waveshapes)
VariableLFO(String label, LXWaveshape[] waveshapes, CompoundParameter period)	Constructs a VariableLFO with a custom list of waveshapes

Method Summary

Modifier and Type	Method	Description
double	compute(double basis)
double	computeBase(double basis)
protected final double	computeNormalizedBasis(double basis, double normalizedValue)	Subclasses determine the basis based on a normalized value from 0 to 1.
protected final double	computeNormalizedValue(double deltaMs, double basis)	Subclasses implement this which returns their value from a 0-1 scale.
LXWaveshape	getWaveshape()
double	invert(double value, double basisHint)

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, load, loop, loop, numLoops, onReset, randomBasis, save, 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, assertDisposed, contains, copyParameters, dispose, getCategory, getChild, getComponentDescription, 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, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Field Details

waveshape

public final ObjectParameter<LXWaveshape> waveshape

Parameter of LXWaveshape objects that select the wave shape used by this LFO. Default options are the waveshapes predefined in LXWaveshape, but you can pass your own.

periodCustom

public final CompoundParameter periodCustom

Period of the waveform, in ms

skew

public final CompoundParameter skew

shape

public final CompoundParameter shape

exp

public final CompoundParameter exp

bias

public final CompoundParameter bias

phase

public final CompoundParameter phase

Constructor Details

VariableLFO

public VariableLFO()

VariableLFO

public VariableLFO(String label)

VariableLFO

public VariableLFO(String label,
 LXWaveshape[] waveshapes)

VariableLFO

public VariableLFO(String label,
 LXWaveshape[] waveshapes,
 CompoundParameter period)

Constructs a VariableLFO with a custom list of waveshapes

Parameters:

label - LFO label

waveshapes - Optional list of custom LXWaveshape. If null, will use predefined ones in LXWaveshape

period - Optional. Parameter that supplies custom waveform period, in ms. Default goes 100-60000ms.

Method Details

getWaveshape

public LXWaveshape getWaveshape()

computeNormalizedValue

protected final 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 final 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

computeBase

public double computeBase(double basis)

invert

public double invert(double value,
 double basisHint)

Specified by:

invert in interface LXWaveshape