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

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()
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, setDescription, setFormatter, setMappable, setPolarity, setUnits, 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, 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()

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