heronarts.lx.parameter

Class BoundedParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.BoundedParameter

All Implemented Interfaces:

LXPath, LXNormalizedParameter, LXParameter

Direct Known Subclasses:

CompoundParameter

public class BoundedParameter
extends LXListenableNormalizedParameter

Simple parameter class with a double value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoundedParameter.Range

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

LXParameter.Formatter, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields

Modifier and Type	Field and Description
BoundedParameter.Range	range Range of the parameter

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Constructor Summary

Constructors

Modifier	Constructor and Description
	BoundedParameter(LXListenableParameter underlying, double v0, double v1) Creates a BoundedParameter which limits the value of an underlying MutableParameter to a given range.
	BoundedParameter(String label) Labeled parameter with value of 0 and range of 0-1
	BoundedParameter(String label, double value) A bounded parameter with label and value, initial value of 0 and a range of 0-1
	BoundedParameter(String label, double value, double max) A bounded parameter with an initial value, and range from 0 to max
	BoundedParameter(String label, double value, double v0, double v1) A bounded parameter with initial value and range from v0 to v1.
protected	BoundedParameter(String label, double value, double v0, double v1, LXListenableParameter underlying)

Method Summary

Modifier and Type	Method and Description
double	getNormalized() Gets a normalized value of the parameter from 0 to 1
float	getNormalizedf() Normalized value as a float
double	getRange() Get the range of values for this parameter
BoundedParameter	incrementValue(double amount, boolean wrap)
BoundedParameter	setDescription(String description)
BoundedParameter	setExponent(double exponent)
BoundedParameter	setNormalized(double normalized) Sets the value of parameter using normal 0-1
BoundedParameter	setPolarity(LXParameter.Polarity polarity)
protected double	updateValue(double value) Invoked when the value has changed.

Methods inherited from class heronarts.lx.parameter.LXListenableNormalizedParameter

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

Field Detail

range

public final BoundedParameter.Range range

Range of the parameter

Constructor Detail

BoundedParameter

public BoundedParameter(String label)

Labeled parameter with value of 0 and range of 0-1

Parameters:

label - Label for parameter

BoundedParameter

public BoundedParameter(String label,
                        double value)

A bounded parameter with label and value, initial value of 0 and a range of 0-1

Parameters:

label - Label

value - value

BoundedParameter

public BoundedParameter(String label,
                        double value,
                        double max)

A bounded parameter with an initial value, and range from 0 to max

Parameters:

label - Label

value - value

max - Maximum value

BoundedParameter

public BoundedParameter(String label,
                        double value,
                        double v0,
                        double v1)

A bounded parameter with initial value and range from v0 to v1. Note that it is not necessary for v0 to be less than v1, if it is desired for the knob's value to progress negatively.

Parameters:

label - Label

value - Initial value

v0 - Start of range

v1 - End of range

BoundedParameter

public BoundedParameter(LXListenableParameter underlying,
                        double v0,
                        double v1)

Creates a BoundedParameter which limits the value of an underlying MutableParameter to a given range. Changes to the BoundedParameter are forwarded to the MutableParameter, and vice versa. If the MutableParameter is set to a value outside the specified bounds, this BoundedParmaeter will ignore the update and the values will be inconsistent. The typical use of this mode is to create a parameter suitable for limited-range UI control of a parameter, typically a MutableParameter.

Parameters:

underlying - The underlying parameter

v0 - Beginning of range

v1 - End of range

BoundedParameter

protected BoundedParameter(String label,
                           double value,
                           double v0,
                           double v1,
                           LXListenableParameter underlying)

Method Detail

setDescription

public BoundedParameter setDescription(String description)

Overrides:

setDescription in class LXListenableParameter

setPolarity

public BoundedParameter setPolarity(LXParameter.Polarity polarity)

Overrides:

setPolarity in class LXListenableParameter

setExponent

public BoundedParameter setExponent(double exponent)

Overrides:

setExponent in class LXListenableNormalizedParameter

incrementValue

public BoundedParameter incrementValue(double amount,
                                       boolean wrap)

setNormalized

public BoundedParameter setNormalized(double normalized)

Sets the value of parameter using normal 0-1

Parameters:

normalized - Value from 0-1 through the parameter range

Returns:

this, for method chaining

getRange

public double getRange()

Get the range of values for this parameter

Returns:

range from min and max

getNormalized

public double getNormalized()

Gets a normalized value of the parameter from 0 to 1

Returns:

Normalized value, from 0 to 1

getNormalizedf

public float getNormalizedf()

Normalized value as a float

Returns:

Normalized value from 0-1 as a float

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