heronarts.lx.modulator

Class LXPeriodicModulator

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.LXPeriodicModulator

All Implemented Interfaces:

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

Direct Known Subclasses:

Click, LXRangeModulator

public abstract class LXPeriodicModulator
extends LXModulator

An LXPeriodicModulator is a modulator that moves through a cycle in a given amount of time. It may then repeat the cycle, or perform it once. The values are computed based upon a position in the cycle, internally referred to as a basis, which moves from 0 to 1. This can be thought of as equivalent to an angle moving from 0 to two times pi. The period itself is a parameter which may be a modulator or otherwise.

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

Modifier and Type	Field and Description
BooleanParameter	looping Whether this modulator runs continuously looping.
EnumParameter<Tempo.Division>	tempoDivision
BooleanParameter	tempoLock
BooleanParameter	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

Modifier	Constructor and Description
protected	LXPeriodicModulator(String label, LXParameter period) Utility constructor with period

Method Summary

Modifier and Type	Method and Description
protected abstract double	computeBasis(double basis, double value) Implementation method to compute the appropriate basis for a modulator given its current basis and value.
protected double	computeValue(double deltaMs) Implementation method to advance the modulator's internal state.
protected abstract double	computeValue(double deltaMs, double basis) Implementation method to compute the value of a modulator given its basis.
boolean	finished() For envelope modulators, which are not looping, this returns true if they finished on this frame.
double	getBasis() Accessor for the current basis
float	getBasisf() Accessor for basis as a float
double	getPeriod()
float	getPeriodf()
void	load(LX lx, JsonObject object) Loads the LX component.
boolean	loop() Returns true once each time this modulator loops through its starting position.
void	loop(double deltaMs)
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
protected void	onReset() Optional subclass method when reset happens.
void	onSetValue(double value) Set the modulator to a certain value in its cycle.
LXPeriodicModulator	randomBasis() Sets the basis to a random position
void	save(LX lx, JsonObject object) Serializes the LX component.
LXPeriodicModulator	setBasis(double basis) Set the modulator to a certain basis position in its cycle.
LXPeriodicModulator	setLooping(boolean looping) Sets whether the modulator should loop after it completes a cycle or halt at the end position.
LXPeriodicModulator	setPeriod(double periodMs) Modify the period of this modulator
LXPeriodicModulator	setPeriod(LXParameter period) Sets a parameter to the period of this modulator
protected void	updateBasis(double value) Updates the basis of the modulator based on present values.

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, getLabel, isMappable, reset, setMappable

Methods inherited from interface heronarts.lx.LXPath

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

Field Detail

looping

public final BooleanParameter looping

Whether this modulator runs continuously looping.

tempoSync

public final BooleanParameter tempoSync

tempoDivision

public final EnumParameter<Tempo.Division> tempoDivision

tempoLock

public final BooleanParameter tempoLock

Constructor Detail

LXPeriodicModulator

protected LXPeriodicModulator(String label,
                              LXParameter period)

Utility constructor with period

Parameters:

label - Label

period - Parameter for period

Method Detail

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXRunnableComponent

Parameters:

p - Parameter that has a value change

setLooping

public LXPeriodicModulator setLooping(boolean looping)

Sets whether the modulator should loop after it completes a cycle or halt at the end position.

Parameters:

looping - Whether to loop

Returns:

this, for method chaining

getBasis

public final double getBasis()

Accessor for the current basis

Returns:

The basis of the modulator

getBasisf

public final float getBasisf()

Accessor for basis as a float

Returns:

basis as float

onReset

protected void onReset()

Description copied from class: LXRunnableComponent

Optional subclass method when reset happens.

Overrides:

onReset in class LXRunnableComponent

randomBasis

public final LXPeriodicModulator randomBasis()

Sets the basis to a random position

Returns:

this

setBasis

public final LXPeriodicModulator setBasis(double basis)

Set the modulator to a certain basis position in its cycle.

Parameters:

basis - Basis of modulator, from 0-1

Returns:

this

onSetValue

public void onSetValue(double value)

Set the modulator to a certain value in its cycle.

Overrides:

onSetValue in class LXModulator

Parameters:

value - The value to apply

updateBasis

protected final void updateBasis(double value)

Updates the basis of the modulator based on present values.

Parameters:

value - New value of the modulator

setPeriod

public final LXPeriodicModulator setPeriod(double periodMs)

Modify the period of this modulator

Parameters:

periodMs - New period, in milliseconds

Returns:

Modulator, for method chaining;

getPeriod

public final double getPeriod()

Returns:

The period of this modulator

getPeriodf

public final float getPeriodf()

Returns:

The period of this modulator as a floating point

setPeriod

public final LXPeriodicModulator setPeriod(LXParameter period)

Sets a parameter to the period of this modulator

Parameters:

period - Parameter for period value

Returns:

This modulator, for method chaining

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

Overrides:

loop in class LXRunnableComponent

computeValue

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

loop

public final boolean loop()

Returns true once each time this modulator loops through its starting position.

Returns:

true if the modulator just looped

finished

public final boolean finished()

For envelope modulators, which are not looping, this returns true if they finished on this frame.

Returns:

true if the modulator just finished its operation on this frame

computeValue

protected abstract double computeValue(double deltaMs,
                                       double basis)

Implementation method to compute the value of a modulator given its basis.

Parameters:

deltaMs - Milliseconds elapsed

basis - Basis of the modulator

Returns:

Value of modulator

computeBasis

protected abstract double computeBasis(double basis,
                                       double value)

Implementation method to compute the appropriate basis for a modulator given its current basis and value.

Parameters:

basis - Last basis of modulator

value - Current value of modulator

Returns:

Basis of modulator

save

public void save(LX lx,
                 JsonObject object)

Description copied from class: LXComponent

Serializes the LX component. By default, all internal and user-facing parameters are serialized, as well as any explicitly registered child components. Note that child arrays are not serialized, or any other dynamic components. Subclasses may override to perform more saving, and are expected to call super.save(lx, obj) at the appropriate time.

Specified by:

save in interface LXSerializable

Overrides:

save in class LXComponent

Parameters:

lx - LX instance

object - Object to serialize into

load

public void load(LX lx,
                 JsonObject object)

Description copied from class: LXComponent

Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.

Specified by:

load in interface LXSerializable

Overrides:

load in class LXComponent

Parameters:

lx - LX instance

object - Object to deserialize