heronarts.lx.modulator

Class LXModulator

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

All Implemented Interfaces:

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

Direct Known Subclasses:

Accelerator, Accumulator, ADEnvelope, ADSREnvelope, BandGate, DampedParameter, DecibelMeter, HistoryBuffer, LXPeriodicModulator, MacroKnobs

public abstract class LXModulator
extends LXRunnableComponent
implements LXComponent.Renamable, LXParameter

A Modulator is an abstraction for a variable with a value that varies over time, such as an envelope or a low frequency oscillator. Some modulators run continuously, others may halt after they reach a certain value.

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

Modifier	Constructor and Description
protected	LXModulator(String label) Utility default constructor

Method Summary

Modifier and Type	Method and Description
protected abstract double	computeValue(double deltaMs) Implementation method to advance the modulator's internal state.
String	getDescription() Returns a contextual help message explaining the purpose of this parameter to the user, or null if none is available.
LXParameter.Formatter	getFormatter() Gets the formatter to be used for printing this parameter's value
int	getIndex() Returns the ordering index of this modulator in its parent
String	getOscAddress() Gets the OSC address for this object
String	getOscPath() Accessor for this component's OSC path relative to its parent.
String	getPath() Accessor for the path of this object.
LXParameter.Polarity	getPolarity() Gets the polarity of this parameter.
LXParameter.Units	getUnits() Gets the unit format that this parameter's value stores.
double	getValue() Retrieves the current value of the modulator in full precision
float	getValuef() Retrieves the current value of the modulator in floating point precision.
protected void	onSetValue(double value) Subclasses may override when actions are necessary on value change.
protected void	run(double deltaMs) Applies updates to the modulator for the specified number of milliseconds.
LXParameter	setComponent(LXComponent component, String path) Sets the component that owns this parameter
LXParameter	setDescription(String description)
LXModulator	setFormatter(LXParameter.Formatter formatter)
LXModulator	setIndex(int index) Sets the index of this modulator in its parent list
LXModulator	setPolarity(LXParameter.Polarity polarity)
LXModulator	setUnits(LXParameter.Units units)
LXModulator	setValue(double value) Set the modulator to a certain value in its cycle.
protected LXModulator	setValue(double value, boolean notify)
protected LXModulator	updateValue(double value) Helper for subclasses to update value in situations where it needs to be recomputed.

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, loop, onParameterChanged, onReset, 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, getLabel, isMappable, reset, setMappable

Methods inherited from interface heronarts.lx.LXPath

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

Constructor Detail

LXModulator

protected LXModulator(String label)

Utility default constructor

Parameters:

label - Label

Method Detail

setIndex

public LXModulator setIndex(int index)

Sets the index of this modulator in its parent list

Parameters:

index - Modulator index

Returns:

this

getIndex

public int getIndex()

Returns the ordering index of this modulator in its parent

Returns:

Modulator index

getOscPath

public String getOscPath()

Description copied from class: LXComponent

Accessor for this component's OSC path relative to its parent. This by default is no different from LXComponent.getPath(), but certain subclasses may modify this to support different types of OSC paths that aren't required to match the LX hierarchy.

Overrides:

getOscPath in class LXComponent

Returns:

Path that this object can be accessed via OSC

getOscAddress

public String getOscAddress()

Description copied from class: LXComponent

Gets the OSC address for this object

Overrides:

getOscAddress in class LXComponent

Returns:

Full OSC address for this component

setDescription

public LXParameter setDescription(String description)

getDescription

public String getDescription()

Description copied from interface: LXParameter

Returns a contextual help message explaining the purpose of this parameter to the user, or null if none is available.

Specified by:

getDescription in interface LXParameter

Returns:

Contextual help string explaining purpose of parameter.

setComponent

public LXParameter setComponent(LXComponent component,
                                String path)

Description copied from interface: LXParameter

Sets the component that owns this parameter

Specified by:

setComponent in interface LXParameter

Parameters:

component - Component

path - Path name for parameter

Returns:

this

getPath

public String getPath()

Description copied from class: LXComponent

Accessor for the path of this object. Returns the path this component was registered with. Some subclasses may override this if path structure is dynamic.

Specified by:

getPath in interface LXPath

Overrides:

getPath in class LXComponent

Returns:

path of this component relative to its parent

setFormatter

public LXModulator setFormatter(LXParameter.Formatter formatter)

getFormatter

public LXParameter.Formatter getFormatter()

Description copied from interface: LXParameter

Gets the formatter to be used for printing this parameter's value

Specified by:

getFormatter in interface LXParameter

Returns:

Formatter

setUnits

public LXModulator setUnits(LXParameter.Units units)

getUnits

public LXParameter.Units getUnits()

Description copied from interface: LXParameter

Gets the unit format that this parameter's value stores.

Specified by:

getUnits in interface LXParameter

Returns:

Units

setPolarity

public LXModulator setPolarity(LXParameter.Polarity polarity)

getPolarity

public LXParameter.Polarity getPolarity()

Description copied from interface: LXParameter

Gets the polarity of this parameter.

Specified by:

getPolarity in interface LXParameter

Returns:

polarity of this parameter

getValue

public final double getValue()

Retrieves the current value of the modulator in full precision

Specified by:

getValue in interface LXParameter

Returns:

Current value of the modulator

getValuef

public final float getValuef()

Retrieves the current value of the modulator in floating point precision.

Specified by:

getValuef in interface LXParameter

Returns:

Current value of the modulator, cast to float

setValue

public final LXModulator setValue(double value)

Set the modulator to a certain value in its cycle.

Specified by:

setValue in interface LXParameter

Parameters:

value - The value to apply

Returns:

This modulator, for method chaining

setValue

protected final LXModulator setValue(double value,
                                     boolean notify)

onSetValue

protected void onSetValue(double value)

Subclasses may override when actions are necessary on value change.

Parameters:

value - New value

updateValue

protected final LXModulator updateValue(double value)

Helper for subclasses to update value in situations where it needs to be recomputed. This cannot be overriden, and subclasses may assume that it ONLY updates the internal value without triggering any other recomputations.

Parameters:

value - Value for modulator

Returns:

this, for method chaining

run

protected final void run(double deltaMs)

Applies updates to the modulator for the specified number of milliseconds. This method is invoked by the core engine.

Specified by:

run in class LXRunnableComponent

Parameters:

deltaMs - Milliseconds to advance by

computeValue

protected abstract double computeValue(double deltaMs)

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

Parameters:

deltaMs - Number of milliseconds to advance by

Returns:

Computed value