heronarts.lx.modulator

Class DampedParameter

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.DampedParameter

All Implemented Interfaces:

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

public class DampedParameter
extends LXModulator

A modulator that tracks the value of a parameter but damps motion over time according to rules.

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

Constructor and Description
DampedParameter(LXParameter parameter, double velocity)
DampedParameter(LXParameter parameter, double velocity, double acceleration)
DampedParameter(LXParameter parameter, double velocity, double acceleration, double deceleration)
DampedParameter(LXParameter parameter, LXParameter velocity)
DampedParameter(LXParameter parameter, LXParameter velocity, LXParameter acceleration)
DampedParameter(LXParameter parameter, LXParameter velocity, LXParameter acceleration, LXParameter deceleration)
DampedParameter(String label, double velocity)
DampedParameter(String label, LXParameter parameter, double velocity, double acceleration)
DampedParameter(String label, LXParameter parameter, double velocity, double acceleration, double deceleration)
DampedParameter(String label, LXParameter parameter, LXParameter velocity)
DampedParameter(String label, LXParameter parameter, LXParameter velocity, double acceleration)
DampedParameter(String label, LXParameter parameter, LXParameter velocity, double acceleration, double deceleration)
DampedParameter(String label, LXParameter parameter, LXParameter velocity, LXParameter acceleration)
DampedParameter(String label, LXParameter parameter, LXParameter velocity, LXParameter acceleration, LXParameter deceleration)

Method Summary

Modifier and Type	Method and Description
protected double	computeValue(double deltaMs) Implementation method to advance the modulator's internal state.
LXParameter	getParameter()
DampedParameter	setModulus(boolean hasModulus) Sets whether a modulus value is used.
DampedParameter	setModulus(double modulus) Sets a modulus at which values wrap around

Methods inherited from class heronarts.lx.modulator.LXModulator

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

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

DampedParameter

public DampedParameter(String label,
                       double velocity)

DampedParameter

public DampedParameter(LXParameter parameter,
                       double velocity)

DampedParameter

public DampedParameter(LXParameter parameter,
                       double velocity,
                       double acceleration)

DampedParameter

public DampedParameter(LXParameter parameter,
                       double velocity,
                       double acceleration,
                       double deceleration)

DampedParameter

public DampedParameter(LXParameter parameter,
                       LXParameter velocity)

DampedParameter

public DampedParameter(LXParameter parameter,
                       LXParameter velocity,
                       LXParameter acceleration)

DampedParameter

public DampedParameter(LXParameter parameter,
                       LXParameter velocity,
                       LXParameter acceleration,
                       LXParameter deceleration)

DampedParameter

public DampedParameter(String label,
                       LXParameter parameter,
                       LXParameter velocity)

DampedParameter

public DampedParameter(String label,
                       LXParameter parameter,
                       double velocity,
                       double acceleration)

DampedParameter

public DampedParameter(String label,
                       LXParameter parameter,
                       double velocity,
                       double acceleration,
                       double deceleration)

DampedParameter

public DampedParameter(String label,
                       LXParameter parameter,
                       LXParameter velocity,
                       double acceleration)

DampedParameter

public DampedParameter(String label,
                       LXParameter parameter,
                       LXParameter velocity,
                       double acceleration,
                       double deceleration)

DampedParameter

public DampedParameter(String label,
                       LXParameter parameter,
                       LXParameter velocity,
                       LXParameter acceleration)

DampedParameter

public DampedParameter(String label,
                       LXParameter parameter,
                       LXParameter velocity,
                       LXParameter acceleration,
                       LXParameter deceleration)

Method Detail

setModulus

public DampedParameter setModulus(double modulus)

Sets a modulus at which values wrap around

Parameters:

modulus - Modulus value

Returns:

this

setModulus

public DampedParameter setModulus(boolean hasModulus)

Sets whether a modulus value is used.

Parameters:

hasModulus - Whether to use modulus

Returns:

this

computeValue

protected double computeValue(double deltaMs)

Description copied from class: LXModulator

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

Specified by:

computeValue in class LXModulator

Parameters:

deltaMs - Number of milliseconds to advance by

Returns:

Computed value

getParameter

public LXParameter getParameter()