heronarts.lx.parameter

Interface LXNormalizedParameter

All Superinterfaces:

LXParameter, LXPath

All Known Implementing Classes:

ADEnvelope, ADSREnvelope, BandGate, BooleanParameter, BoundedFunctionalParameter, BoundedParameter, CompoundParameter, DecibelMeter, DiscreteColorParameter, DiscreteParameter, EnumParameter, FunctionalModulator, GraphicMeter, LinearEnvelope, LXListenableNormalizedParameter, LXRangeModulator, MultiStageEnvelope, NormalizedParameter, ObjectParameter, QuadraticEnvelope, SawLFO, SinLFO, SquareLFO, TriangleLFO, VariableLFO

public interface LXNormalizedParameter
extends LXParameter

A parameter that supports values in a normalized form, from 0 to 1. This only makes sense for parameters with fixed, finite ranges. The calls to setNormalized() and getNormalized() operate in this space, while getValue() respects the actual given value range.

Nested Class Summary

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

LXParameter.Formatter, LXParameter.Polarity, LXParameter.Units

Method Summary

Modifier and Type	Method and Description
double	getExponent() Gets the exponent used for scaling this parameter across its normalized range.
double	getNormalized() Gets the value of the parameter in a normalized space from 0 to 1
float	getNormalizedf() Gets the value of the parameter in a normalized space as a float
LXNormalizedParameter	setNormalized(double value) Sets the value or the parameter in normalized space from 0 to 1

Methods inherited from interface heronarts.lx.parameter.LXParameter

dispose, getDescription, getFormatter, getLabel, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setMappable, setValue

Methods inherited from interface heronarts.lx.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter, getParent, getPath

Method Detail

setNormalized

LXNormalizedParameter setNormalized(double value)

Sets the value or the parameter in normalized space from 0 to 1

Parameters:

value - The normalized value, from 0 to 1

Returns:

this, for method chaining

getNormalized

double getNormalized()

Gets the value of the parameter in a normalized space from 0 to 1

Returns:

Value of parameter, normalized to range from 0 to 1

getNormalizedf

float getNormalizedf()

Gets the value of the parameter in a normalized space as a float

Returns:

Normalized value of parameter, in range from 0 to 1

getExponent

double getExponent()

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

Returns:

scaling exponent