Package heronarts.lx.parameter

Class ObjectParameter<T>

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.DiscreteParameter

heronarts.lx.parameter.ObjectParameter<T>

All Implemented Interfaces:

LXPath, LXNormalizedParameter, LXParameter

Direct Known Subclasses:

EnumParameter, LXViewEngine.Selector, SoundObject.Selector

public class ObjectParameter<T>
extends DiscreteParameter

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

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
ObjectParameter(String label, T[] objects)
ObjectParameter(String label, T[] objects, String[] options)
ObjectParameter(String label, T[] objects, T value)
ObjectParameter(String label, T[] objects, T value, String[] options)

Method Summary

Modifier and Type	Method	Description
T	getBaseObject()
T	getObject()
T[]	getObjects()
ObjectParameter<T>	setDescription(String description)
DiscreteParameter	setIncrementMode(DiscreteParameter.IncrementMode incrementMode)
ObjectParameter<T>	setMappable(boolean mappable)	Sets whether this parameter should be eligible for MIDI/modulation mapping or not.
ObjectParameter<T>	setObjects(T[] objects)	Set a list of objects for the parameter
ObjectParameter<T>	setObjects(T[] objects, String[] options)
ObjectParameter<T>	setRange(int minValue, long maxValue)	Sets the range from [minValue, maxValue-1] inclusive
ObjectParameter<T>	setValue(Object object)
ObjectParameter<T>	setWrappable(boolean wrappable)

Methods inherited from class heronarts.lx.parameter.DiscreteParameter

decrement, decrement, decrement, decrement, getBaseIndex, getBaseOption, getBaseValuei, getIncrementMode, getIndex, getMaxValue, getMinValue, getNormalized, getOption, getOption, getOptions, getRange, getRangei, getValueFromNormalized, getValuei, increment, increment, increment, increment, normalizedToValue, setFormatter, setFormatter, setIndex, setNormalized, setOptions, setOptions, setOptions, setRange, setRange, setUnits, 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, 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

Constructor Details

ObjectParameter

public ObjectParameter(String label,
 T[] objects)

ObjectParameter

public ObjectParameter(String label,
 T[] objects,
 T value)

ObjectParameter

public ObjectParameter(String label,
 T[] objects,
 String[] options)

ObjectParameter

public ObjectParameter(String label,
 T[] objects,
 T value,
 String[] options)

Method Details

setDescription

public ObjectParameter<T> setDescription(String description)

Overrides:

setDescription in class DiscreteParameter

setIncrementMode

public DiscreteParameter setIncrementMode(DiscreteParameter.IncrementMode incrementMode)

Overrides:

setIncrementMode in class DiscreteParameter

setMappable

public ObjectParameter<T> 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

setWrappable

public ObjectParameter<T> setWrappable(boolean wrappable)

Overrides:

setWrappable in class DiscreteParameter

setObjects

public ObjectParameter<T> setObjects(T[] objects)

Set a list of objects for the parameter

Parameters:

objects - Array of arbitrary object values

Returns:

this

setObjects

public ObjectParameter<T> setObjects(T[] objects,
 String[] options)

setRange

public ObjectParameter<T> setRange(int minValue,
 long maxValue)

Description copied from class: DiscreteParameter

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

Overrides:

setRange in class DiscreteParameter

Parameters:

minValue - Minimum value

maxValue - Maximum value, exclusive

Returns:

this

setValue

public ObjectParameter<T> setValue(Object object)

getObjects

public T[] getObjects()

getBaseObject

public T getBaseObject()

getObject

public T getObject()