heronarts.lx.parameter

Class BoundedFunctionalParameter

java.lang.Object

heronarts.lx.parameter.FunctionalParameter

heronarts.lx.parameter.BoundedFunctionalParameter

All Implemented Interfaces:

LXPath, LXNormalizedParameter, LXParameter

public abstract class BoundedFunctionalParameter
extends FunctionalParameter
implements LXNormalizedParameter

A FunctionalParameter that is bounded by a range. This enables the calculation of normalized values which enables mapping with the modulation engine.

Nested Class Summary

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

description

Constructor Summary

Constructors

Modifier	Constructor and Description
	BoundedFunctionalParameter(String label) A bounded functional parameter with a range of 0-1
protected	BoundedFunctionalParameter(String label, double max) A bounded functional parameter with a range of 0 to max
protected	BoundedFunctionalParameter(String label, double v0, double v1) A bounded functional parameter with a range from v0 to v1.

Method Summary

Modifier and Type	Method and Description
protected abstract double	computeValue() Retrieves the raw value of the parameter, subclass must implement.
double	getExponent() Gets the exponent used for scaling this parameter across its normalized range.
double	getNormalized() Gets a normalized value of the parameter from 0 to 1
float	getNormalizedf() Normalized value as a float
double	getValue() Retrieves the value of the parameter, subclass must implement.
float	getValuef() Utility helper function to get the value of the parameter as a float.
BoundedFunctionalParameter	setDescription(String description)
LXNormalizedParameter	setExponent(double exponent)
BoundedFunctionalParameter	setNormalized(double normalized) Sets the value of parameter using normal 0-1
LXParameter	setValue(double value) Not supported for this parameter type unless subclass overrides.

Methods inherited from class heronarts.lx.parameter.FunctionalParameter

dispose, getDescription, getFormatter, getLabel, getParent, getPath, getPolarity, getUnits, reset, setComponent

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, isMappable, reset, setComponent, setMappable

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

BoundedFunctionalParameter

public BoundedFunctionalParameter(String label)

A bounded functional parameter with a range of 0-1

Parameters:

label - Label for parameter

BoundedFunctionalParameter

protected BoundedFunctionalParameter(String label,
                                     double max)

A bounded functional parameter with a range of 0 to max

Parameters:

label - Label for parameter

max - Maximum value

BoundedFunctionalParameter

protected BoundedFunctionalParameter(String label,
                                     double v0,
                                     double v1)

A bounded functional parameter with a 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 for parameter

v0 - Start of range

v1 - End of range

Method Detail

setDescription

public BoundedFunctionalParameter setDescription(String description)

Overrides:

setDescription in class FunctionalParameter

setValue

public LXParameter setValue(double value)

Not supported for this parameter type unless subclass overrides.

Specified by:

setValue in interface LXParameter

Overrides:

setValue in class FunctionalParameter

Parameters:

value - The value

Returns:

this

computeValue

protected abstract double computeValue()

Retrieves the raw value of the parameter, subclass must implement. This value will be constrained to the range.

Returns:

Parameter value

getValue

public final double getValue()

Description copied from class: FunctionalParameter

Retrieves the value of the parameter, subclass must implement.

Specified by:

getValue in interface LXParameter

Specified by:

getValue in class FunctionalParameter

Returns:

Parameter value

getValuef

public final float getValuef()

Description copied from class: FunctionalParameter

Utility helper function to get the value of the parameter as a float.

Specified by:

getValuef in interface LXParameter

Overrides:

getValuef in class FunctionalParameter

Returns:

Parameter value as float

setNormalized

public BoundedFunctionalParameter setNormalized(double normalized)

Sets the value of parameter using normal 0-1

Specified by:

setNormalized in interface LXNormalizedParameter

Parameters:

normalized - Value from 0-1 through the parameter range

Returns:

this, for method chaining

getNormalized

public double getNormalized()

Gets a normalized value of the parameter from 0 to 1

Specified by:

getNormalized in interface LXNormalizedParameter

Returns:

Normalized value, from 0 to 1

getNormalizedf

public float getNormalizedf()

Normalized value as a float

Specified by:

getNormalizedf in interface LXNormalizedParameter

Returns:

Normalized value from 0-1 as a float

setExponent

public LXNormalizedParameter setExponent(double exponent)

getExponent

public double getExponent()

Description copied from interface: LXNormalizedParameter

Gets the exponent used for scaling this parameter across its normalized range. Default is 1 which means linear scaling.

Specified by:

getExponent in interface LXNormalizedParameter

Returns:

scaling exponent