Package heronarts.lx.parameter

Class CompoundDiscreteParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.DiscreteParameter

heronarts.lx.parameter.CompoundDiscreteParameter

All Implemented Interfaces:

LXPath, LXCompoundModulation.Target, LXNormalizedParameter, LXParameter

Direct Known Subclasses:

CompoundObjectParameter

public class CompoundDiscreteParameter
extends DiscreteParameter
implements LXCompoundModulation.Target

Nested Class Summary

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

DiscreteParameter.IncrementMode

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.DiscreteParameter

maxValue, minValue, optionsChanged, range

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
CompoundDiscreteParameter(String label, int range)	Parameter with values from [0, range-1], 0 by default
CompoundDiscreteParameter(String label, int min, int max)	Parameter with values from [min, max-1], min by default
CompoundDiscreteParameter(String label, int value, int min, int max)	Parameter with values from [min, max-1], value by default
CompoundDiscreteParameter(String label, String[] options)	Parameter with set of String label values
CompoundDiscreteParameter(String label, String[] options, int value)	Parameter with set of String label values, and a default

Method Summary

Modifier and Type	Method	Description
CompoundDiscreteParameter	addModulation(LXCompoundModulation modulation)	Adds a modulation to this parameter
final CompoundDiscreteParameter	addModulationListener(LXCompoundModulation.Listener listener)	Adds a listener to the modulation target
int	getBaseIndex()
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()
int	getBaseValuei()
List<LXCompoundModulation>	getModulations()	Get the list of modulations applied to this parameter
double	getNormalized()	Gets the value of the parameter in a normalized space from 0 to 1
double	getValue()	Retrieves the value of the parameter
CompoundDiscreteParameter	removeModulation(LXCompoundModulation modulation)	Removes a modulation from this parameter
final CompoundDiscreteParameter	removeModulationListener(LXCompoundModulation.Listener listener)	Removes a listener from the modulation target
CompoundDiscreteParameter	setDescription(String description)
CompoundDiscreteParameter	setMappable(boolean mappable)	Sets whether this parameter should be eligible for MIDI/modulation mapping or not.
CompoundDiscreteParameter	setUnits(LXParameter.Units units)
CompoundDiscreteParameter	setWrappable(boolean wrappable)

Methods inherited from class heronarts.lx.parameter.DiscreteParameter

decrement, decrement, decrement, decrement, getBaseOption, getIncrementMode, getIndex, getMaxValue, getMinValue, getOption, getOptions, getRange, getValueFromNormalized, getValuei, increment, increment, increment, increment, normalizedToValue, setIncrementMode, setIndex, setNormalized, setOptions, setOptions, setRange, setRange, updateValue

Methods inherited from class heronarts.lx.parameter.LXListenableNormalizedParameter

getExponent, getNormalizedWithModulation, getOscMode, incrementNormalized, incrementNormalized, isWrappable, setExponent, setOscMode

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, addListener, bang, dispose, getDescription, getFormatter, getLabel, getParent, getParentParameter, getPath, getPolarity, getUnits, incrementValue, isDefault, isMappable, removeListener, reset, reset, setComponent, setFormatter, setPolarity, 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, setFormatter, setValue

Methods inherited from interface heronarts.lx.LXPath

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

Field Details

modulations

public final List<LXCompoundModulation> modulations

Constructor Details

CompoundDiscreteParameter

public CompoundDiscreteParameter(String label,
 int range)

Parameter with values from [0, range-1], 0 by default

Parameters:

label - Name of parameter

range - range of values

CompoundDiscreteParameter

public CompoundDiscreteParameter(String label,
 int min,
 int max)

Parameter with values from [min, max-1], min by default

Parameters:

label - Label

min - Minimum value

max - Maximum value is 1 less than this

CompoundDiscreteParameter

public CompoundDiscreteParameter(String label,
 int value,
 int min,
 int max)

Parameter with values from [min, max-1], value by default

Parameters:

label - Label

value - Default value

min - Minimum value (inclusive)

max - Maximum value (exclusive)

CompoundDiscreteParameter

public CompoundDiscreteParameter(String label,
 String[] options)

Parameter with set of String label values

Parameters:

label - Label

options - Values

CompoundDiscreteParameter

public CompoundDiscreteParameter(String label,
 String[] options,
 int value)

Parameter with set of String label values, and a default

Parameters:

label - Label

options - Values

value - Default index

Method Details

addModulationListener

public final CompoundDiscreteParameter 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 CompoundDiscreteParameter 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

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

addModulation

public CompoundDiscreteParameter 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 CompoundDiscreteParameter removeModulation(LXCompoundModulation modulation)

Removes a modulation from this parameter

Specified by:

removeModulation in interface LXCompoundModulation.Target

Parameters:

modulation - Modulation mapping to remove

Returns:

this

setUnits

public CompoundDiscreteParameter setUnits(LXParameter.Units units)

Overrides:

setUnits in class DiscreteParameter

setWrappable

public CompoundDiscreteParameter setWrappable(boolean wrappable)

Overrides:

setWrappable in class DiscreteParameter

setMappable

public CompoundDiscreteParameter setMappable(boolean mappable)

Description copied from interface: LXParameter

Sets whether this parameter should be eligible for MIDI/modulation mapping or not.

Specified by:

setMappable in interface LXParameter

Overrides:

setMappable in class DiscreteParameter

Parameters:

mappable - Whether parameter should be available for mapping

Returns:

this

setDescription

public CompoundDiscreteParameter setDescription(String description)

Overrides:

setDescription in class DiscreteParameter

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

getBaseValuei

public int getBaseValuei()

Overrides:

getBaseValuei in class DiscreteParameter

getBaseIndex

public int getBaseIndex()

Overrides:

getBaseIndex in class DiscreteParameter

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

Overrides:

getNormalized in class DiscreteParameter

Returns:

Value of parameter, normalized to range 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