heronarts.lx.parameter

Class LXListenableNormalizedParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

All Implemented Interfaces:

LXPath, LXNormalizedParameter, LXParameter

Direct Known Subclasses:

BooleanParameter, BoundedParameter, DiscreteParameter

public abstract class LXListenableNormalizedParameter
extends LXListenableParameter
implements LXNormalizedParameter

A parameter that can be listened to and has normalized values. This is needed for things like UI components such as a slider or a knob, which need to be able to listen for changes to the parameter value and to update it in a normalized range of values.

Nested Class Summary

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

LXParameter.Formatter, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LXListenableNormalizedParameter(String label, double value)

Method Summary

Modifier and Type	Method and Description
double	getExponent() Gets the exponent used for scaling this parameter across its normalized range.
boolean	isMappable() Whether this parameter should be eligible for mapping via MIDI or modulation control.
LXListenableNormalizedParameter	setExponent(double exponent)
LXListenableNormalizedParameter	setMappable(boolean mappable) Sets whether this parameter should be eligible for MIDI/modulation mapping or not.

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, setDescription, setFormatter, setPolarity, setUnits, setValue, updateValue

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

getNormalized, getNormalizedf, setNormalized

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

Constructor Detail

LXListenableNormalizedParameter

protected LXListenableNormalizedParameter(String label,
                                          double value)

Method Detail

setExponent

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

setMappable

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

isMappable

public boolean isMappable()

Description copied from interface: LXParameter

Whether this parameter should be eligible for mapping via MIDI or modulation control.

Specified by:

isMappable in interface LXParameter

Overrides:

isMappable in class LXListenableParameter

Returns:

true if mappable, false if otherwise