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:

DiscreteColorParameter, ObjectParameter

public class DiscreteParameter
extends LXListenableNormalizedParameter

Parameter type with a discrete set of possible integer values.

Nested Class Summary

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

LXParameter.Formatter, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Constructor Summary

Constructors

Constructor and 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 and Description
DiscreteParameter	decrement()
DiscreteParameter	decrement(boolean wrap)
DiscreteParameter	decrement(int amt)
DiscreteParameter	decrement(int amt, boolean wrap)
int	getMaxValue()
int	getMinValue()
double	getNormalized() Gets the value of the parameter in a normalized space from 0 to 1
float	getNormalizedf() Gets the value of the parameter in a normalized space as a float
String	getOption() The currently selected option
String[]	getOptions() The set of string labels for these parameters
int	getRange()
int	getValuei()
DiscreteParameter	increment()
DiscreteParameter	increment(boolean wrap)
DiscreteParameter	increment(int amt)
DiscreteParameter	increment(int amt, boolean wrap)
DiscreteParameter	setDescription(String description)
DiscreteParameter	setNormalized(double normalized) Sets the value or the parameter in normalized space from 0 to 1
DiscreteParameter	setOptions(String[] options) Set the range and option strings for the parameter
DiscreteParameter	setRange(int range) Sets range from [0, range-1] inclusive
DiscreteParameter	setRange(int minValue, int maxValue) Sets the range from [minValue, maxValue-1] inclusive
protected double	updateValue(double value) Invoked when the value has changed.

Methods inherited from class heronarts.lx.parameter.LXListenableNormalizedParameter

getExponent, isMappable, setExponent, setMappable

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, bang, dispose, getDescription, getFormatter, getLabel, getParent, getPath, getPolarity, getUnits, getValue, getValuef, incrementValue, removeListener, reset, reset, setComponent, setFormatter, setPolarity, setUnits, 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.LXParameter

dispose, getDescription, getFormatter, getLabel, getPolarity, getUnits, getValue, getValuef, reset, setComponent, setValue

Methods inherited from interface heronarts.lx.LXPath

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

Constructor Detail

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 Detail

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 int getMinValue()

getMaxValue

public int getMaxValue()

getRange

public int getRange()

getOptions

public String[] getOptions()

The set of string labels for these parameters

Returns:

Strings, may be null

getOption

public String getOption()

The currently selected option

Returns:

String description, or numerical value

setOptions

public DiscreteParameter setOptions(String[] options)

Set the range and option strings for the parameter

Parameters:

options - Array of string labels

Returns:

this

setRange

public 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 range)

Sets range from [0, range-1] inclusive

Parameters:

range - Number of discrete values

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

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

getNormalizedf

public float getNormalizedf()

Description copied from interface: LXNormalizedParameter

Gets the value of the parameter in a normalized space as a float

Returns:

Normalized value of parameter, in range from 0 to 1

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