Package heronarts.lx.modulator

Class StepModulator

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.LXPeriodicModulator

heronarts.lx.modulator.StepModulator

All Implemented Interfaces:

LXComponent.Renamable, LXLoopTask, LXPath, LXSerializable, LXModulator.TriggerButton, LXParameter, LXParameterListener

Direct Known Subclasses:

Stepper, StepSequencer

public abstract class StepModulator
extends LXPeriodicModulator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StepModulator.TriggerMode

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

LXModulator.Device, LXModulator.Global, LXModulator.Placeholder, LXModulator.ResetButton, LXModulator.TriggerButton

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

LXComponent.Author, LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.PluginRequired, LXComponent.Renamable, LXComponent.Tags

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 BooleanParameter[]	activeStep
static final int	MAX_STEPS
final DiscreteParameter	numSteps
protected int	step
final CompoundParameter	stepTimeMs
final TriggerParameter	triggerIn
final EnumParameter<StepModulator.TriggerMode>	triggerMode
final TriggerParameter	triggerOut

Fields inherited from class heronarts.lx.modulator.LXPeriodicModulator

basisIn, looping, manualBasis, 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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StepModulator(String label)

Method Summary

Modifier and Type	Method	Description
protected double	computeBasis(double basis, double value)	Implementation method to compute the appropriate basis for a modulator given its current basis and value.
protected final double	computeValue(double deltaMs, double basis)	Implementation method to compute the value of a modulator given its basis.
protected double	getStepValue(double deltaMs, double basis)
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
protected void	onStep(boolean trigger)

Methods inherited from class heronarts.lx.modulator.LXPeriodicModulator

computeValue, disableAutoReset, finished, getBasis, getBasisf, getPeriod, getPeriodf, load, loop, loop, numLoops, onReset, onSetValue, 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, addInternalParameters, 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, isSnapshotControl, 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.LXParameter

dispose, getBaseValue, getBaseValuef, getLabel, getParentParameter, getValuef, isMappable, reset, setMappable

Methods inherited from interface heronarts.lx.LXPath

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

Field Details

MAX_STEPS

public static final int MAX_STEPS

See Also:

• Constant Field Values

numSteps

public final DiscreteParameter numSteps

triggerMode

public final EnumParameter<StepModulator.TriggerMode> triggerMode

stepTimeMs

public final CompoundParameter stepTimeMs

triggerIn

public final TriggerParameter triggerIn

triggerOut

public final TriggerParameter triggerOut

activeStep

public final BooleanParameter[] activeStep

step

protected int step

Constructor Details

StepModulator

protected StepModulator(String label)

Method Details

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 LXPeriodicModulator

Parameters:

p - Parameter that has a value change

computeValue

protected final double computeValue(double deltaMs,
 double basis)

Description copied from class: LXPeriodicModulator

Implementation method to compute the value of a modulator given its basis.

Specified by:

computeValue in class LXPeriodicModulator

Parameters:

deltaMs - Milliseconds elapsed

basis - Basis of the modulator

Returns:

Value of modulator

getStepValue

protected double getStepValue(double deltaMs,
 double basis)

computeBasis

protected double computeBasis(double basis,
 double value)

Description copied from class: LXPeriodicModulator

Implementation method to compute the appropriate basis for a modulator given its current basis and value.

Specified by:

computeBasis in class LXPeriodicModulator

Parameters:

basis - Last basis of modulator

value - Current value of modulator

Returns:

Basis of modulator

onStep

protected void onStep(boolean trigger)