Package heronarts.lx.modulator

Class NoiseModulator

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.modulator.NoiseModulator

All Implemented Interfaces:

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

@Global("Noise")
@Device("Noise")
@LXCategory("Core")
public class NoiseModulator
extends LXModulator
implements LXNormalizedParameter, LXOscComponent

Modulator that provides random noise output

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.modulator.LXModulator

LXModulator.Device, LXModulator.Global, LXModulator.Placeholder

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Hidden, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXNormalizedParameter

LXNormalizedParameter.OscMode

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final EnumParameter<NoisePattern.Algorithm>	algorithm
final CompoundParameter	contrast
final BoundedParameter	gain
final BoundedParameter	lacunarity
final CompoundParameter	level
final CompoundParameter	maxLevel
final CompoundParameter	minLevel
final DiscreteParameter	octaves
final BoundedParameter	ridgeOffset
final DiscreteParameter	seed
final BooleanParameter	showPreview
final CompoundParameter	speed
final BoundedParameter	speedRange

Fields inherited from class heronarts.lx.modulator.LXModulator

crashed, midiFilter

Fields inherited from class heronarts.lx.LXRunnableComponent

runMs, running, trigger

Fields inherited from class heronarts.lx.LXComponent

children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
NoiseModulator()

Method Summary

Modifier and Type	Method	Description
protected double	computeValue(double deltaMs)	Implementation method to advance the modulator's internal state.
double	getNormalized()	Gets the value of the parameter in a normalized space from 0 to 1
double	lookahead(double deltaMs)
LXNormalizedParameter	setNormalized(double value)	Sets the value or the parameter in normalized space from 0 to 1

Methods inherited from class heronarts.lx.modulator.LXModulator

autostart, disableAutoStart, getCrash, getCrashStackTrace, getFormatter, getIndex, getOscAddress, getOscPath, getPath, getPolarity, getUnits, getValue, isMappingSource, loop, onSetValue, run, setComponent, setFormatter, setIndex, setMappingSource, setPolarity, setUnits, setValue, setValue, updateValue

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, onParameterChanged, onReset, onStart, onStop, onTrigger, postRun, reset, start, stop, toggle, trigger

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, dispose, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscLabel, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isValidOscParameter, load, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, 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.LXNormalizedParameter

getBaseNormalized, getBaseNormalizedf, getExponent, getNormalizedf, getOscMode, getValueFromNormalized, isWrappable

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.parameter.LXParameter

dispose, getBaseValue, getBaseValuef, getFormatter, getLabel, getParentParameter, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setFormatter, setMappable, setValue

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Field Details

speed

public final CompoundParameter speed

speedRange

public final BoundedParameter speedRange

level

public final CompoundParameter level

contrast

public final CompoundParameter contrast

minLevel

public final CompoundParameter minLevel

maxLevel

public final CompoundParameter maxLevel

algorithm

public final EnumParameter<NoisePattern.Algorithm> algorithm

seed

public final DiscreteParameter seed

octaves

public final DiscreteParameter octaves

lacunarity

public final BoundedParameter lacunarity

gain

public final BoundedParameter gain

ridgeOffset

public final BoundedParameter ridgeOffset

showPreview

public final BooleanParameter showPreview

Constructor Details

NoiseModulator

public NoiseModulator()

Method Details

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

lookahead

public double lookahead(double deltaMs)

setNormalized

public LXNormalizedParameter setNormalized(double value)

Description copied from interface: LXNormalizedParameter

Sets the value or the parameter in normalized space from 0 to 1

Specified by:

setNormalized in interface LXNormalizedParameter

Parameters:

value - The normalized value, from 0 to 1

Returns:

this, for method chaining

getNormalized

public double getNormalized()

Description copied from interface: LXNormalizedParameter

Gets the value of the parameter in a normalized space from 0 to 1

Specified by:

getNormalized in interface LXNormalizedParameter

Returns:

Value of parameter, normalized to range from 0 to 1