Package 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	Description
static enum	BoundedParameter.NormalizationCurve
static class	BoundedParameter.Range

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

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

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Modifier	Constructor	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	Description
BoundedParameter.NormalizationCurve	getNormalizationCurve()
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
double	getValueFromNormalized(double normalized)	Get the equivalent raw parameter value from a normalized value
LXListenableNormalizedParameter	incrementDetentTicks(boolean increase)
LXListenableNormalizedParameter	incrementDetentTicks(boolean increase, boolean wrap)
LXListenableNormalizedParameter	incrementNormalized(double amount, boolean wrap)
BoundedParameter	incrementValue(double amount)
BoundedParameter	incrementValue(double amount, boolean wrap)
boolean	isDetentEnabled()
BoundedParameter	nextDetent()	Set the parameter to the next detent value
BoundedParameter	nextDetent(boolean wrap)	Set the parameter to the next detent value, with wrapping specified
BoundedParameter	prevDetent()	Set the parameter to the previous detent value
BoundedParameter	prevDetent(boolean wrap)	Set the parameter to the previous detent value, with wrapping specified
BoundedParameter	reset()	A method to reset the value of the parameter, if a default is available.
BoundedParameter	setDescription(String description)
BoundedParameter	setDetents(double... detents)
protected BoundedParameter	setDetents(double[] detents, boolean normalized)
BoundedParameter	setDetentsEnabled(boolean detentEnabled)
BoundedParameter	setDetentsNormalized(double... detents)
BoundedParameter	setExponent(double exponent)
BoundedParameter	setMappable(boolean mappable)	Sets whether this parameter should be eligible for MIDI/modulation mapping or not.
BoundedParameter	setNormalizationCurve(BoundedParameter.NormalizationCurve curve)
BoundedParameter	setNormalized(double normalized)	Sets the value of parameter using normal 0-1
BoundedParameter	setPolarity(LXParameter.Polarity polarity)
BoundedParameter	setUnits(LXParameter.Units units)
BoundedParameter	setWrappable(boolean wrappable)
protected double	updateValue(double value)	Invoked when the value has changed.

Methods inherited from class heronarts.lx.parameter.LXListenableNormalizedParameter

getExponent, getNormalizedWithModulation, getOscMode, incrementNormalized, isWrappable, setOscMode

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, addListener, bang, dispose, getDescription, getFormatter, getLabel, getParent, getParentParameter, getPath, getPolarity, getUnits, getValue, isDefault, isMappable, removeListener, reset, setComponent, setFormatter, 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

Methods inherited from interface heronarts.lx.parameter.LXParameter

dispose, getBaseValue, getBaseValuef, getFormatter, getLabel, getParentParameter, getPolarity, getUnits, getValue, getValuef, isMappable, setComponent, setFormatter, setValue

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Field Details

range

public final BoundedParameter.Range range

Range of the parameter

Constructor Details

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 Details

setWrappable

public BoundedParameter setWrappable(boolean wrappable)

Overrides:

setWrappable in class LXListenableNormalizedParameter

setMappable

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

setUnits

public BoundedParameter setUnits(LXParameter.Units units)

Overrides:

setUnits in class LXListenableNormalizedParameter

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

setNormalizationCurve

public BoundedParameter setNormalizationCurve(BoundedParameter.NormalizationCurve curve)

getNormalizationCurve

public BoundedParameter.NormalizationCurve getNormalizationCurve()

isDetentEnabled

public boolean isDetentEnabled()

setDetentsEnabled

public BoundedParameter setDetentsEnabled(boolean detentEnabled)

setDetents

public BoundedParameter setDetents(double... detents)

setDetentsNormalized

public BoundedParameter setDetentsNormalized(double... detents)

setDetents

protected BoundedParameter setDetents(double[] detents,
 boolean normalized)

reset

public BoundedParameter reset()

Description copied from interface: LXParameter

A method to reset the value of the parameter, if a default is available. Not necessarily defined for all parameters, may be ignored.

Specified by:

reset in interface LXParameter

Overrides:

reset in class LXListenableParameter

Returns:

this

incrementValue

public BoundedParameter incrementValue(double amount)

Overrides:

incrementValue in class LXListenableParameter

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

incrementDetentTicks

public LXListenableNormalizedParameter incrementDetentTicks(boolean increase)

incrementDetentTicks

public LXListenableNormalizedParameter incrementDetentTicks(boolean increase,
 boolean wrap)

incrementNormalized

public LXListenableNormalizedParameter incrementNormalized(double amount,
 boolean wrap)

Overrides:

incrementNormalized in class LXListenableNormalizedParameter

nextDetent

public BoundedParameter nextDetent()

Set the parameter to the next detent value

Returns:

this

nextDetent

public BoundedParameter nextDetent(boolean wrap)

Set the parameter to the next detent value, with wrapping specified

Parameters:

wrap - Whether wrapping is enabled

Returns:

this

prevDetent

public BoundedParameter prevDetent()

Set the parameter to the previous detent value

Returns:

this

prevDetent

public BoundedParameter prevDetent(boolean wrap)

Set the parameter to the previous detent value, with wrapping specified

Parameters:

wrap - Whether wrapping is enabled

Returns:

this

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

getValueFromNormalized

public double getValueFromNormalized(double normalized)

Description copied from interface: LXNormalizedParameter

Get the equivalent raw parameter value from a normalized value

Parameters:

normalized - Normalized value

Returns:

The equivalent raw value

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