Package heronarts.lx.parameter

Class CompoundObjectParameter<T>

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.DiscreteParameter

heronarts.lx.parameter.CompoundDiscreteParameter

heronarts.lx.parameter.CompoundObjectParameter<T>

All Implemented Interfaces:

LXPath, LXCompoundModulation.Target, LXNormalizedParameter, LXParameter

Direct Known Subclasses:

CompoundEnumParameter

public class CompoundObjectParameter<T>
extends CompoundDiscreteParameter

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

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
CompoundObjectParameter(String label, T[] objects)
CompoundObjectParameter(String label, T[] objects, String[] options)
CompoundObjectParameter(String label, T[] objects, T value)
CompoundObjectParameter(String label, T[] objects, T value, String[] options)

Method Summary

Modifier and Type	Method	Description
T	getBaseObject()
T	getObject()
T[]	getObjects()
CompoundObjectParameter<T>	setDescription(String description)
CompoundObjectParameter<T>	setObjects(T[] objects)	Set a list of objects for the parameter
CompoundObjectParameter<T>	setObjects(T[] objects, String[] options)
CompoundObjectParameter<T>	setRange(int minValue, int maxValue)	Sets the range from [minValue, maxValue-1] inclusive
CompoundObjectParameter<T>	setValue(Object object)

Methods inherited from class heronarts.lx.parameter.CompoundDiscreteParameter

addModulation, addModulationListener, getBaseIndex, getBaseNormalized, getBaseValue, getBaseValuei, getModulations, getNormalized, getValue, removeModulation, removeModulationListener, setMappable, setUnits, setWrappable

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

Constructor Details

CompoundObjectParameter

public CompoundObjectParameter(String label,
 T[] objects)

CompoundObjectParameter

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

CompoundObjectParameter

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

CompoundObjectParameter

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

Method Details

setDescription

public CompoundObjectParameter<T> setDescription(String description)

Overrides:

setDescription in class CompoundDiscreteParameter

setObjects

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

Set a list of objects for the parameter

Parameters:

objects - Array of arbitrary object values

Returns:

this

setObjects

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

setRange

public CompoundObjectParameter<T> setRange(int minValue,
 int 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 CompoundObjectParameter<T> setValue(Object object)

getObjects

public T[] getObjects()

getObject

public T getObject()

getBaseObject

public T getBaseObject()