heronarts.lx.modulator

Class Accelerator

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.Accelerator

All Implemented Interfaces:

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

public class Accelerator
extends LXModulator

An accelerator is a free-running modulator that changes its value based on velocity and acceleration, measured in units/second and units/second^2, respectively.

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
Accelerator(double initValue, double initVelocity, double acceleration)
Accelerator(double initValue, double initVelocity, LXParameter acceleration)
Accelerator(double initValue, LXParameter initVelocity, LXParameter acceleration)
Accelerator(String label, double initValue, double initVelocity, double acceleration)
Accelerator(String label, double initValue, double initVelocity, LXParameter acceleration)
Accelerator(String label, double initValue, LXParameter initVelocity, LXParameter acceleration)

Method Summary

Modifier and Type	Method and Description
protected double	computeValue(double deltaMs) Implementation method to advance the modulator's internal state.
double	getAcceleration()
float	getAccelerationf()
double	getVelocity()
float	getVelocityf()
protected void	onReset() Optional subclass method when reset happens.
Accelerator	setAcceleration(double acceleration)
Accelerator	setAcceleration(LXParameter acceleration) Updates the acceleration.
Accelerator	setInitVelocity(double initVelocity) Sets the initial velocity to a fixed value
Accelerator	setInitVelocity(LXParameter initVelocity) Sets initial velocity of the Accelerator
Accelerator	setSpeed(double initVelocity, double acceleration)
Accelerator	setSpeed(LXParameter initVelocity, LXParameter acceleration) Sets both the velocity and acceleration of the modulator.
Accelerator	setVelocity(double velocity) Updates the current velocity.

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

Accelerator

public Accelerator(double initValue,
                   double initVelocity,
                   double acceleration)

Accelerator

public Accelerator(double initValue,
                   double initVelocity,
                   LXParameter acceleration)

Accelerator

public Accelerator(double initValue,
                   LXParameter initVelocity,
                   LXParameter acceleration)

Accelerator

public Accelerator(String label,
                   double initValue,
                   double initVelocity,
                   double acceleration)

Accelerator

public Accelerator(String label,
                   double initValue,
                   double initVelocity,
                   LXParameter acceleration)

Accelerator

public Accelerator(String label,
                   double initValue,
                   LXParameter initVelocity,
                   LXParameter acceleration)

Method Detail

onReset

protected void onReset()

Description copied from class: LXRunnableComponent

Optional subclass method when reset happens.

Overrides:

onReset in class LXRunnableComponent

getVelocity

public double getVelocity()

Returns:

the current velocity

getVelocityf

public float getVelocityf()

Returns:

the current velocity as a floating point

getAcceleration

public double getAcceleration()

Returns:

The current acceleration

getAccelerationf

public float getAccelerationf()

Returns:

The current acceleration, as a float

setSpeed

public Accelerator setSpeed(double initVelocity,
                            double acceleration)

setSpeed

public Accelerator setSpeed(LXParameter initVelocity,
                            LXParameter acceleration)

Sets both the velocity and acceleration of the modulator. Updates the default values so that a future call to trigger() will reset to this velocity.

Parameters:

initVelocity - New velocity

acceleration - Acceleration

Returns:

this

setVelocity

public Accelerator setVelocity(double velocity)

Updates the current velocity. Does not reset the default.

Parameters:

velocity - New velocity

Returns:

this

setInitVelocity

public Accelerator setInitVelocity(double initVelocity)

Sets the initial velocity to a fixed value

Parameters:

initVelocity - Fixed initial velocity value

Returns:

this

setInitVelocity

public Accelerator setInitVelocity(LXParameter initVelocity)

Sets initial velocity of the Accelerator

Parameters:

initVelocity - Initial velocity parameter

Returns:

this

setAcceleration

public Accelerator setAcceleration(double acceleration)

setAcceleration

public Accelerator setAcceleration(LXParameter acceleration)

Updates the acceleration.

Parameters:

acceleration - New acceleration

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