heronarts.lx.modulator

Class FunctionalModulator

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.LXPeriodicModulator

heronarts.lx.modulator.LXRangeModulator

heronarts.lx.modulator.FunctionalModulator

All Implemented Interfaces:

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

public abstract class FunctionalModulator
extends LXRangeModulator

An extendable modulator class that lets a custom normalized function be supplied by simply extending this class and supplying a compute() and invert() method.

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.modulator.LXPeriodicModulator

looping, tempoDivision, tempoLock, tempoSync

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
FunctionalModulator(double startValue, double endValue, double periodMs)
FunctionalModulator(double startValue, double endValue, LXParameter periodMs)
FunctionalModulator(double startValue, LXParameter endValue, double periodMs)
FunctionalModulator(double startValue, LXParameter endValue, LXParameter periodMs)
FunctionalModulator(LXParameter startValue, double endValue, double periodMs)
FunctionalModulator(LXParameter startValue, double endValue, LXParameter periodMs)
FunctionalModulator(LXParameter startValue, LXParameter endValue, double periodMs)
FunctionalModulator(LXParameter startValue, LXParameter endValue, LXParameter periodMs)
FunctionalModulator(String label, double startValue, double endValue, double periodMs)
FunctionalModulator(String label, double startValue, double endValue, LXParameter periodMs)
FunctionalModulator(String label, double startValue, LXParameter endValue, double periodMs)
FunctionalModulator(String label, double startValue, LXParameter endValue, LXParameter periodMs)
FunctionalModulator(String label, LXParameter startValue, double endValue, double periodMs)
FunctionalModulator(String label, LXParameter startValue, double endValue, LXParameter periodMs)
FunctionalModulator(String label, LXParameter startValue, LXParameter endValue, double periodMs)
FunctionalModulator(String label, LXParameter startValue, LXParameter endValue, LXParameter periodMs)

Method Summary

Modifier and Type	Method and Description
abstract double	compute(double basis) Subclasses override this method to compute the value of the function.
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 basis, double value) Subclasses optionally override this method to support inversion of the value to a basis.

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, finished, getBasis, getBasisf, getPeriod, getPeriodf, load, loop, loop, onParameterChanged, onReset, randomBasis, save, setBasis, setLooping, setPeriod, setPeriod, updateBasis

Methods inherited from class heronarts.lx.modulator.LXModulator

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

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, 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, loadParameters, removeParameter, removeParameter, 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

Constructor Detail

FunctionalModulator

public FunctionalModulator(double startValue,
                           double endValue,
                           double periodMs)

FunctionalModulator

public FunctionalModulator(LXParameter startValue,
                           double endValue,
                           double periodMs)

FunctionalModulator

public FunctionalModulator(double startValue,
                           LXParameter endValue,
                           double periodMs)

FunctionalModulator

public FunctionalModulator(double startValue,
                           double endValue,
                           LXParameter periodMs)

FunctionalModulator

public FunctionalModulator(LXParameter startValue,
                           LXParameter endValue,
                           double periodMs)

FunctionalModulator

public FunctionalModulator(LXParameter startValue,
                           double endValue,
                           LXParameter periodMs)

FunctionalModulator

public FunctionalModulator(double startValue,
                           LXParameter endValue,
                           LXParameter periodMs)

FunctionalModulator

public FunctionalModulator(LXParameter startValue,
                           LXParameter endValue,
                           LXParameter periodMs)

FunctionalModulator

public FunctionalModulator(String label,
                           double startValue,
                           double endValue,
                           double periodMs)

FunctionalModulator

public FunctionalModulator(String label,
                           LXParameter startValue,
                           double endValue,
                           double periodMs)

FunctionalModulator

public FunctionalModulator(String label,
                           double startValue,
                           LXParameter endValue,
                           double periodMs)

FunctionalModulator

public FunctionalModulator(String label,
                           double startValue,
                           double endValue,
                           LXParameter periodMs)

FunctionalModulator

public FunctionalModulator(String label,
                           LXParameter startValue,
                           LXParameter endValue,
                           double periodMs)

FunctionalModulator

public FunctionalModulator(String label,
                           LXParameter startValue,
                           double endValue,
                           LXParameter periodMs)

FunctionalModulator

public FunctionalModulator(String label,
                           double startValue,
                           LXParameter endValue,
                           LXParameter periodMs)

FunctionalModulator

public FunctionalModulator(String label,
                           LXParameter startValue,
                           LXParameter endValue,
                           LXParameter periodMs)

Method Detail

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)

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

Specified by:

computeNormalizedBasis in class LXRangeModulator

Parameters:

normalizedValue - A normalize value from 0 to 1

basis - Modulator basis

Returns:

Computed normalized basis for modulator

compute

public abstract double compute(double basis)

Subclasses override this method to compute the value of the function. Basis is a value from 0-1, the result must be a value from 0-1.

Parameters:

basis - Basis of modulator

Returns:

Computed value for given basis

invert

public double invert(double basis,
                     double value)

Subclasses optionally override this method to support inversion of the value to a basis. This is not well-defined for all functions. If it is not implemented, an UnsupportedOperationException may be thrown at runtime on invocations to methods that would directly change the value or bounds of the function.

Parameters:

basis - Previous basis, from 0-1

value - New value from 0-1

Returns:

New basis, from 0-1