Package heronarts.lx.parameter

Class DiscreteParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.DiscreteParameter

All Implemented Interfaces:

LXPath, LXNormalizedParameter, LXParameter

Direct Known Subclasses:

CompoundDiscreteParameter, DiscreteColorParameter, LXPalette.IndexSelector, ObjectParameter

public class DiscreteParameter
extends LXListenableNormalizedParameter

Parameter type with a discrete set of possible integer values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	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
protected int	maxValue
protected int	minValue
final MutableParameter	optionsChanged
protected long	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
DiscreteParameter(String label, int range)	Parameter with values from [0, range-1], 0 by default
DiscreteParameter(String label, int min, int max)	Parameter with values from [min, max-1], min by default
DiscreteParameter(String label, int value, int min, int max)	Parameter with values from [min, max-1], value by default
DiscreteParameter(String label, String[] options)	Parameter with set of String label values
DiscreteParameter(String label, String[] options, int value)	Parameter with set of String label values, and a default

Method Summary

Modifier and Type	Method	Description
DiscreteParameter	decrement()
DiscreteParameter	decrement(boolean wrap)
DiscreteParameter	decrement(int amt)
DiscreteParameter	decrement(int amt, boolean wrap)
int	getBaseIndex()
String	getBaseOption()	The currently selected option
int	getBaseValuei()
DiscreteParameter.IncrementMode	getIncrementMode()
int	getIndex()
final int	getMaxValue()	Returns the maximum value (inclusive) this parameter can hold
final int	getMinValue()	Returns the minimum value (inclusive) this parameter can hold
double	getNormalized()	Gets the value of the parameter in a normalized space from 0 to 1
String	getOption()	The currently selected option
String	getOption(double value)
String[]	getOptions()	The set of string labels for these parameters
final long	getRange()	Returns the number of discrete values this parameter can hold, the size of the inclusive range [getMinValue(), getMaxValue()]
final int	getRangei()	Gets the number of discrete values this parameter can hold as an integer.
double	getValueFromNormalized(double normalized)	Get the equivalent raw parameter value from a normalized value
int	getValuei()
DiscreteParameter	increment()
DiscreteParameter	increment(boolean wrap)
DiscreteParameter	increment(int amt)
DiscreteParameter	increment(int amt, boolean wrap)
protected int	normalizedToValue(double normalized)
DiscreteParameter	setDescription(String description)
DiscreteParameter	setFormatter(LXParameter.Formatter formatter)	Sets the formatter used for printing this parameter's value
DiscreteParameter	setFormatter(LXParameter.Formatter formatter, boolean setOptions)
DiscreteParameter	setIncrementMode(DiscreteParameter.IncrementMode incrementMode)
DiscreteParameter	setIndex(int index)	Set the value by index
DiscreteParameter	setMappable(boolean mappable)	Sets whether this parameter should be eligible for MIDI/modulation mapping or not.
DiscreteParameter	setNormalized(double normalized)	Sets the value or the parameter in normalized space from 0 to 1
DiscreteParameter	setOptions(LXParameter.Formatter formatter)	Set the options to the strings generated by the formatter
DiscreteParameter	setOptions(String[] options)	Set the range and option strings for the parameter
DiscreteParameter	setOptions(String[] options, boolean updateRange)	Set the range and option strings for the parameter
final DiscreteParameter	setRange(int range)	Sets range from [0, range-1] inclusive
final DiscreteParameter	setRange(int minValue, int maxValue)	Sets the range from [minValue, maxValue-1] inclusive
DiscreteParameter	setRange(int minValue, long maxValue)	Sets the range from [minValue, maxValue-1] inclusive
DiscreteParameter	setUnits(LXParameter.Units units)
DiscreteParameter	setWrappable(boolean wrappable)
protected double	updateValue(double value)	Invoked when the value has changed.

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, getValue, incrementValue, isDefault, isMappable, removeListener, reset, reset, setComponent, 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

getBaseNormalized, getBaseNormalizedf, getNormalizedf

Methods inherited from interface heronarts.lx.parameter.LXParameter

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

Methods inherited from interface heronarts.lx.LXPath

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

Field Details

minValue

protected int minValue

maxValue

protected int maxValue

range

protected long range

optionsChanged

public final MutableParameter optionsChanged

Constructor Details

DiscreteParameter

public DiscreteParameter(String label,
 int range)

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

Parameters:

label - Name of parameter

range - range of values

DiscreteParameter

public DiscreteParameter(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

DiscreteParameter

public DiscreteParameter(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)

DiscreteParameter

public DiscreteParameter(String label,
 String[] options)

Parameter with set of String label values

Parameters:

label - Label

options - Values

DiscreteParameter

public DiscreteParameter(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

setFormatter

public DiscreteParameter setFormatter(LXParameter.Formatter formatter,
 boolean setOptions)

setFormatter

public DiscreteParameter 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 LXListenableParameter

Parameters:

formatter - Formatter

Returns:

The parameter

setUnits

public DiscreteParameter setUnits(LXParameter.Units units)

Overrides:

setUnits in class LXListenableNormalizedParameter

setWrappable

public DiscreteParameter setWrappable(boolean wrappable)

Overrides:

setWrappable in class LXListenableNormalizedParameter

setMappable

public DiscreteParameter 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 LXListenableParameter

Parameters:

mappable - Whether parameter should be available for mapping

Returns:

this

setDescription

public DiscreteParameter setDescription(String description)

Overrides:

setDescription in class LXListenableParameter

updateValue

protected double updateValue(double value)

Description copied from class: LXListenableParameter

Invoked when the value has changed. Subclasses should update any special internal state according to this new value.

Specified by:

updateValue in class LXListenableParameter

Parameters:

value - New value

Returns:

this

getMinValue

public final int getMinValue()

Returns the minimum value (inclusive) this parameter can hold

Returns:

Min value, inclusive

getMaxValue

public final int getMaxValue()

Returns the maximum value (inclusive) this parameter can hold

Returns:

Maximum value, inclusive

getRangei

public final int getRangei()

Gets the number of discrete values this parameter can hold as an integer. Will throw an exception if the range is too large to be represented as an integer.

Returns:

Number of distinct values this parameter can hold

getRange

public final long getRange()

Returns the number of discrete values this parameter can hold, the size of the inclusive range [getMinValue(), getMaxValue()]

Returns:

Number of distinct values this parameter can hold

getOptions

public String[] getOptions()

The set of string labels for these parameters

Returns:

Strings, may be null

getBaseOption

public String getBaseOption()

The currently selected option

Returns:

String description, or numerical value

getOption

public String getOption()

The currently selected option

Returns:

String description, or numerical value

getOption

public String getOption(double value)

setOptions

public DiscreteParameter setOptions(String[] options)

Set the range and option strings for the parameter

Parameters:

options - Array of string labels

Returns:

this

setOptions

public DiscreteParameter setOptions(LXParameter.Formatter formatter)

Set the options to the strings generated by the formatter

Parameters:

formatter - Formatter

Returns:

Parameter with options updated

setOptions

public DiscreteParameter setOptions(String[] options,
 boolean updateRange)

Set the range and option strings for the parameter

Parameters:

options - Array of string labels

updateRange - Also update the range

Returns:

this

setRange

public final DiscreteParameter setRange(int minValue,
 int maxValue)

Sets the range from [minValue, maxValue-1] inclusive

Parameters:

minValue - Minimum value

maxValue - Maximum value, exclusive

Returns:

this

setRange

public DiscreteParameter setRange(int minValue,
 long maxValue)

Sets the range from [minValue, maxValue-1] inclusive

Parameters:

minValue - Minimum value

maxValue - Maximum value, exclusive

Returns:

this

setRange

public final DiscreteParameter setRange(int range)

Sets range from [0, range-1] inclusive

Parameters:

range - Number of discrete values

Returns:

this

setIndex

public DiscreteParameter setIndex(int index)

Set the value by index

Parameters:

index - Index in all eligible values, 0 corresponds to minimum value

Returns:

this

increment

public DiscreteParameter increment()

increment

public DiscreteParameter increment(boolean wrap)

increment

public DiscreteParameter increment(int amt)

increment

public DiscreteParameter increment(int amt,
 boolean wrap)

decrement

public DiscreteParameter decrement()

decrement

public DiscreteParameter decrement(boolean wrap)

decrement

public DiscreteParameter decrement(int amt)

decrement

public DiscreteParameter decrement(int amt,
 boolean wrap)

getValuei

public int getValuei()

getBaseValuei

public int getBaseValuei()

getIndex

public int getIndex()

getBaseIndex

public int getBaseIndex()

getNormalized

public double getNormalized()

Description copied from interface: LXNormalizedParameter

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

Returns:

Value of parameter, normalized to range from 0 to 1

getValueFromNormalized

public double getValueFromNormalized(double normalized)

Description copied from interface: LXNormalizedParameter

Get the equivalent raw parameter value from a normalized value

Parameters:

normalized - Normalized value

Returns:

The equivalent raw value

normalizedToValue

protected int normalizedToValue(double normalized)

setNormalized

public DiscreteParameter setNormalized(double normalized)

Description copied from interface: LXNormalizedParameter

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

Parameters:

normalized - The normalized value, from 0 to 1

Returns:

this, for method chaining

getIncrementMode

public DiscreteParameter.IncrementMode getIncrementMode()

setIncrementMode

public DiscreteParameter setIncrementMode(DiscreteParameter.IncrementMode incrementMode)