Package heronarts.lx.parameter

Class MutableParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.MutableParameter

All Implemented Interfaces:

LXPath, LXParameter

Direct Known Subclasses:

LXClipEngine.FocusedClipParameter

public class MutableParameter
extends LXListenableParameter

A MutableParameter is a parameter that has a value which can be changed to anything.

Nested Class Summary

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

description

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
MutableParameter()
MutableParameter(double value)
MutableParameter(String label)
MutableParameter(String label, double value)

Method Summary

Modifier and Type	Method	Description
MutableParameter	decrement()
int	getValuei()
MutableParameter	increment()
MutableParameter	setDescription(String description)
MutableParameter	setFormatter(LXParameter.Formatter formatter)	Sets the formatter used for printing this parameter's value
MutableParameter	setMappable(boolean mappable)	Sets whether this parameter should be eligible for MIDI/modulation mapping or not.
MutableParameter	setMaximum(double maximum)
MutableParameter	setMinimum(double minimum)
MutableParameter	setPolarity(LXParameter.Polarity polarity)
MutableParameter	setUnits(LXParameter.Units units)
protected double	updateValue(double value)	Invoked when the value has changed.

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

getBaseValue, getBaseValuef, getValuef

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Constructor Details

MutableParameter

public MutableParameter()

MutableParameter

public MutableParameter(String label)

MutableParameter

public MutableParameter(String label,
 double value)

MutableParameter

public MutableParameter(double value)

Method Details

increment

public MutableParameter increment()

decrement

public MutableParameter decrement()

setMinimum

public MutableParameter setMinimum(double minimum)

setMaximum

public MutableParameter setMaximum(double maximum)

setDescription

public MutableParameter setDescription(String description)

Overrides:

setDescription in class LXListenableParameter

setFormatter

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

setMappable

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

setPolarity

public MutableParameter setPolarity(LXParameter.Polarity polarity)

Overrides:

setPolarity in class LXListenableParameter

setUnits

public MutableParameter setUnits(LXParameter.Units units)

Overrides:

setUnits 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

getValuei

public int getValuei()