heronarts.lx.parameter

Class CompoundParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.BoundedParameter

heronarts.lx.parameter.CompoundParameter

All Implemented Interfaces:

LXPath, LXNormalizedParameter, LXParameter

public class CompoundParameter
extends BoundedParameter

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.parameter.BoundedParameter

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
List<LXCompoundModulation>	modulations

Fields inherited from class heronarts.lx.parameter.BoundedParameter

range

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CompoundParameter	addModulation(LXCompoundModulation modulation) Adds a modulation to this parameter
double	getBaseNormalized()
float	getBaseNormalizedf()
double	getBaseValue()
float	getBaseValuef()
double	getNormalized() Gets a normalized value of the parameter from 0 to 1
double	getValue() Retrieves the value of the parameter
CompoundParameter	removeModulation(LXCompoundModulation modulation) Removes a modulation from this parameter
CompoundParameter	setDescription(String description)
CompoundParameter	setExponent(double exponent)
CompoundParameter	setPolarity(LXParameter.Polarity polarity)

Methods inherited from class heronarts.lx.parameter.BoundedParameter

getNormalizedf, getRange, incrementValue, setNormalized, updateValue

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

modulations

public final List<LXCompoundModulation> modulations

Constructor Detail

CompoundParameter

public CompoundParameter(String label)

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

Parameters:

label - Label for parameter

CompoundParameter

public CompoundParameter(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

CompoundParameter

public CompoundParameter(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

CompoundParameter

public CompoundParameter(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

CompoundParameter

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

Creates a CompoundParameter which limits the value of an underlying MutableParameter to a given range. Changes to the CompoundParameter 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

Method Detail

setPolarity

public CompoundParameter setPolarity(LXParameter.Polarity polarity)

Overrides:

setPolarity in class BoundedParameter

setExponent

public CompoundParameter setExponent(double exponent)

Overrides:

setExponent in class BoundedParameter

setDescription

public CompoundParameter setDescription(String description)

Overrides:

setDescription in class BoundedParameter

addModulation

public CompoundParameter addModulation(LXCompoundModulation modulation)

Adds a modulation to this parameter

Parameters:

modulation - Modulation mapping to add to this parameter

Returns:

this

removeModulation

public CompoundParameter removeModulation(LXCompoundModulation modulation)

Removes a modulation from this parameter

Parameters:

modulation - Modulation mapping to remove

Returns:

this

getBaseValue

public double getBaseValue()

getBaseValuef

public float getBaseValuef()

getBaseNormalized

public double getBaseNormalized()

getBaseNormalizedf

public float getBaseNormalizedf()

getNormalized

public double getNormalized()

Description copied from class: BoundedParameter

Gets a normalized value of the parameter from 0 to 1

Specified by:

getNormalized in interface LXNormalizedParameter

Overrides:

getNormalized in class BoundedParameter

Returns:

Normalized value, from 0 to 1

getValue

public double getValue()

Description copied from interface: LXParameter

Retrieves the value of the parameter

Specified by:

getValue in interface LXParameter

Overrides:

getValue in class LXListenableParameter

Returns:

Parameter value