Package heronarts.lx.parameter

Class CompoundParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.BoundedParameter

heronarts.lx.parameter.CompoundParameter

All Implemented Interfaces:

LXPath, LXCompoundModulation.Target, LXNormalizedParameter, LXParameter

public class CompoundParameter
extends BoundedParameter
implements LXCompoundModulation.Target

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.parameter.BoundedParameter

BoundedParameter.NormalizationCurve, BoundedParameter.Range

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

Field Summary

Fields

Modifier and Type	Field	Description
final List<LXCompoundModulation>	modulations

Fields inherited from class heronarts.lx.parameter.BoundedParameter

range

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
CompoundParameter(LXListenableParameter underlying, double v0, double v1)	Creates a CompoundParameter which limits the value of an underlying MutableParameter to a given range.
CompoundParameter(String label)	Labeled parameter with value of 0 and range of 0-1
CompoundParameter(String label, double value)	A bounded parameter with label and value, initial value of 0 and a range of 0-1
CompoundParameter(String label, double value, double max)	A bounded parameter with an initial value, and range from 0 to max
CompoundParameter(String label, double value, double v0, double v1)	A bounded parameter with initial value and range from v0 to v1.

Method Summary

Modifier and Type	Method	Description
CompoundParameter	addModulation(LXCompoundModulation modulation)	Adds a modulation to this parameter
final CompoundParameter	addModulationListener(LXCompoundModulation.Listener listener)	Adds a listener to the modulation target
double	getBaseNormalized()	Get the base parameter value, for modulated parameters this may differ from getValue()
double	getBaseValue()	Get the base parameter value, for modulated parameters this may differ from getValue()
List<LXCompoundModulation>	getModulations()	Get the list of modulations applied to this parameter
double	getNormalized()	Gets a normalized value of the parameter from 0 to 1
List<LXCompoundModulation>	getUIThreadModulations()	Gets a list of modulation applied to this parameter for use on UI thread
double	getValue()	Retrieves the value of the parameter
CompoundParameter	removeModulation(LXCompoundModulation modulation)	Removes a modulation from this parameter
final CompoundParameter	removeModulationListener(LXCompoundModulation.Listener listener)	Removes a listener from the modulation target
CompoundParameter	setDescription(String description)
CompoundParameter	setDetents(double... detents)
CompoundParameter	setDetentsNormalized(double... detents)
CompoundParameter	setExponent(double exponent)
CompoundParameter	setFormatter(LXParameter.Formatter formatter)	Sets the formatter used for printing this parameter's value
CompoundParameter	setNormalizationCurve(BoundedParameter.NormalizationCurve curve)
CompoundParameter	setOscMode(LXNormalizedParameter.OscMode oscMode)
CompoundParameter	setPolarity(LXParameter.Polarity polarity)
CompoundParameter	setUnits(LXParameter.Units units)
CompoundParameter	setWrappable(boolean wrappable)

Methods inherited from class heronarts.lx.parameter.BoundedParameter

getNormalizationCurve, getNormalizedf, getRange, getValueFromNormalized, incrementDetentTicks, incrementDetentTicks, incrementNormalized, incrementValue, incrementValue, isDetentEnabled, nextDetent, nextDetent, prevDetent, prevDetent, reset, setDetents, setDetentsEnabled, setMappable, setNormalized, updateValue

Methods inherited from class heronarts.lx.parameter.LXListenableNormalizedParameter

getExponent, getNormalizedWithModulation, getOscMode, incrementNormalized, isWrappable

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, addListener, bang, dispose, getDescription, getFormatter, getLabel, getParent, getParentParameter, getPath, getPolarity, getUnits, isDefault, isMappable, removeListener, reset, setComponent, setValue, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface heronarts.lx.parameter.LXNormalizedParameter

getBaseNormalizedf, getExponent, getNormalizedf, getOscMode, getValueFromNormalized, isWrappable, setNormalized

Methods inherited from interface heronarts.lx.parameter.LXParameter

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

Methods inherited from interface heronarts.lx.LXPath

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

Field Details

modulations

public final List<LXCompoundModulation> modulations

Constructor Details

CompoundParameter

public CompoundParameter(String label)

Labeled parameter with value of 0 and range of 0-1

Parameters:

label - Label for parameter

CompoundParameter

public CompoundParameter(String label,
 double value)

A bounded parameter with label and value, initial value of 0 and a range of 0-1

Parameters:

label - Label

value - value

CompoundParameter

public CompoundParameter(String label,
 double value,
 double max)

A bounded parameter with an initial value, and range from 0 to max

Parameters:

label - Label

value - value

max - Maximum value

CompoundParameter

public CompoundParameter(String label,
 double value,
 double v0,
 double v1)

A bounded parameter with initial value and range from v0 to v1. Note that it is not necessary for v0 to be less than v1, if it is desired for the knob's value to progress negatively.

Parameters:

label - Label

value - Initial value

v0 - Start of range

v1 - End of range

CompoundParameter

public CompoundParameter(LXListenableParameter underlying,
 double v0,
 double v1)

Creates a CompoundParameter which limits the value of an underlying MutableParameter to a given range. Changes to the CompoundParameter are forwarded to the MutableParameter, and vice versa. If the MutableParameter is set to a value outside the specified bounds, this BoundedParmaeter will ignore the update and the values will be inconsistent. The typical use of this mode is to create a parameter suitable for limited-range UI control of a parameter, typically a MutableParameter.

Parameters:

underlying - The underlying parameter

v0 - Beginning of range

v1 - End of range

Method Details

addModulationListener

public final CompoundParameter addModulationListener(LXCompoundModulation.Listener listener)

Description copied from interface: LXCompoundModulation.Target

Adds a listener to the modulation target

Specified by:

addModulationListener in interface LXCompoundModulation.Target

Parameters:

listener - Listener

Returns:

The target

removeModulationListener

public final CompoundParameter removeModulationListener(LXCompoundModulation.Listener listener)

Description copied from interface: LXCompoundModulation.Target

Removes a listener from the modulation target

Specified by:

removeModulationListener in interface LXCompoundModulation.Target

Parameters:

listener - Listener

Returns:

The target

setWrappable

public CompoundParameter setWrappable(boolean wrappable)

Overrides:

setWrappable in class BoundedParameter

setFormatter

public CompoundParameter setFormatter(LXParameter.Formatter formatter)

Description copied from interface: LXParameter

Sets the formatter used for printing this parameter's value

Specified by:

setFormatter in interface LXParameter

Overrides:

setFormatter in class BoundedParameter

Parameters:

formatter - Formatter

Returns:

The parameter

setUnits

public CompoundParameter setUnits(LXParameter.Units units)

Overrides:

setUnits in class BoundedParameter

setPolarity

public CompoundParameter setPolarity(LXParameter.Polarity polarity)

Overrides:

setPolarity in class BoundedParameter

setExponent

public CompoundParameter setExponent(double exponent)

Overrides:

setExponent in class BoundedParameter

setNormalizationCurve

public CompoundParameter setNormalizationCurve(BoundedParameter.NormalizationCurve curve)

Overrides:

setNormalizationCurve in class BoundedParameter

setDescription

public CompoundParameter setDescription(String description)

Overrides:

setDescription in class BoundedParameter

setOscMode

public CompoundParameter setOscMode(LXNormalizedParameter.OscMode oscMode)

Overrides:

setOscMode in class BoundedParameter

setDetents

public CompoundParameter setDetents(double... detents)

Overrides:

setDetents in class BoundedParameter

setDetentsNormalized

public CompoundParameter setDetentsNormalized(double... detents)

Overrides:

setDetentsNormalized in class BoundedParameter

getModulations

public List<LXCompoundModulation> getModulations()

Description copied from interface: LXCompoundModulation.Target

Get the list of modulations applied to this parameter

Specified by:

getModulations in interface LXCompoundModulation.Target

Returns:

List of modulations applied to this parameter

getUIThreadModulations

public List<LXCompoundModulation> getUIThreadModulations()

Description copied from interface: LXCompoundModulation.Target

Gets a list of modulation applied to this parameter for use on UI thread

Specified by:

getUIThreadModulations in interface LXCompoundModulation.Target

Returns:

List of modulations applied to this parameter for use on UI thread

addModulation

public CompoundParameter addModulation(LXCompoundModulation modulation)

Adds a modulation to this parameter

Specified by:

addModulation in interface LXCompoundModulation.Target

Parameters:

modulation - Modulation mapping to add to this parameter

Returns:

this

removeModulation

public CompoundParameter removeModulation(LXCompoundModulation modulation)

Removes a modulation from this parameter

Specified by:

removeModulation in interface LXCompoundModulation.Target

Parameters:

modulation - Modulation mapping to remove

Returns:

this

getBaseValue

public double getBaseValue()

Description copied from interface: LXParameter

Get the base parameter value, for modulated parameters this may differ from getValue()

Specified by:

getBaseValue in interface LXParameter

Returns:

Base parameter value

getBaseNormalized

public double getBaseNormalized()

Description copied from interface: LXNormalizedParameter

Get the base parameter value, for modulated parameters this may differ from getValue()

Specified by:

getBaseNormalized in interface LXNormalizedParameter

Returns:

Base normalized parameter value

getNormalized

public double getNormalized()

Description copied from class: BoundedParameter

Gets a normalized value of the parameter from 0 to 1

Specified by:

getNormalized in interface LXNormalizedParameter

Overrides:

getNormalized in class BoundedParameter

Returns:

Normalized value, from 0 to 1

getValue

public double getValue()

Description copied from interface: LXParameter

Retrieves the value of the parameter

Specified by:

getValue in interface LXParameter

Overrides:

getValue in class LXListenableParameter

Returns:

Parameter value