heronarts.lx.modulator

Class QuadraticEnvelope

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.LXPeriodicModulator

heronarts.lx.modulator.LXRangeModulator

heronarts.lx.modulator.QuadraticEnvelope

All Implemented Interfaces:

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

public class QuadraticEnvelope
extends LXRangeModulator

A quadratic envelope moves from one value to another along a quadratic curve.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuadraticEnvelope.Ease Different modes of quadratic easing.

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

Method Summary

Modifier and Type	Method and Description
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.
QuadraticEnvelope	setEase(QuadraticEnvelope.Ease ease) Sets the easing type

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

QuadraticEnvelope

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

Method Detail

setEase

public QuadraticEnvelope setEase(QuadraticEnvelope.Ease ease)

Sets the easing type

Parameters:

ease - easing type

Returns:

this

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)

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