heronarts.lx.parameter

Interface LXParameter

All Superinterfaces:

LXPath

All Known Subinterfaces:

LXNormalizedParameter

All Known Implementing Classes:

Accelerator, Accumulator, ADEnvelope, ADSREnvelope, BandGate, BooleanParameter, BoundedFunctionalParameter, BoundedParameter, Click, ColorParameter, CompoundParameter, DampedParameter, DecibelMeter, DiscreteColorParameter, DiscreteParameter, EnumParameter, FixedParameter, FunctionalModulator, FunctionalParameter, GraphicMeter, HistoryBuffer, LinearEnvelope, LXClipEngine.FocusedClipParameter, LXListenableNormalizedParameter, LXListenableParameter, LXModulator, LXPeriodicModulator, LXRangeModulator, LXVirtualParameter, MacroKnobs, MultiStageEnvelope, MutableParameter, NormalizedParameter, ObjectParameter, QuadraticEnvelope, SawLFO, SinLFO, SquareLFO, StringParameter, TriangleLFO, VariableLFO

public interface LXParameter
extends LXPath

This class provides a common interface for system components to have parameters that can modify their operation. Any LXComponent can have parameters, such as a pattern, effect, or transition.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LXParameter.Formatter
static class	LXParameter.Polarity
static class	LXParameter.Units

Method Summary

Modifier and Type	Method and Description
void	dispose() Invoked when the parameter is done being used and none of its resources are needed anymore.
String	getDescription() Returns a contextual help message explaining the purpose of this parameter to the user, or null if none is available.
LXParameter.Formatter	getFormatter() Gets the formatter to be used for printing this parameter's value
String	getLabel() Gets the label for this parameter
LXParameter.Polarity	getPolarity() Gets the polarity of this parameter.
LXParameter.Units	getUnits() Gets the unit format that this parameter's value stores.
double	getValue() Retrieves the value of the parameter
float	getValuef() Utility helper function to get the value of the parameter as a float.
default boolean	isMappable() Whether this parameter should be eligible for mapping via MIDI or modulation control.
Object	reset() A method to reset the value of the parameter, if a default is available.
LXParameter	setComponent(LXComponent component, String path) Sets the component that owns this parameter
default LXParameter	setMappable(boolean mappable) Sets whether this parameter should be eligible for MIDI/modulation mapping or not.
LXParameter	setValue(double value) Sets the value of the parameter.

Methods inherited from interface heronarts.lx.LXPath

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

Method Detail

setComponent

LXParameter setComponent(LXComponent component,
                         String path)

Sets the component that owns this parameter

Parameters:

component - Component

path - Path name for parameter

Returns:

this

getDescription

String getDescription()

Returns a contextual help message explaining the purpose of this parameter to the user, or null if none is available.

Returns:

Contextual help string explaining purpose of parameter.

getUnits

LXParameter.Units getUnits()

Gets the unit format that this parameter's value stores.

Returns:

Units

getFormatter

LXParameter.Formatter getFormatter()

Gets the formatter to be used for printing this parameter's value

Returns:

Formatter

getPolarity

LXParameter.Polarity getPolarity()

Gets the polarity of this parameter.

Returns:

polarity of this parameter

dispose

void dispose()

Invoked when the parameter is done being used and none of its resources are needed anymore.

reset

Object reset()

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

Returns:

this

setValue

LXParameter setValue(double value)

Sets the value of the parameter.

Parameters:

value - The value

Returns:

this

getValue

double getValue()

Retrieves the value of the parameter

Returns:

Parameter value

getValuef

float getValuef()

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

Returns:

Parameter value as float

getLabel

String getLabel()

Gets the label for this parameter

Specified by:

getLabel in interface LXPath

Returns:

Label of parameter

setMappable

default LXParameter setMappable(boolean mappable)

Sets whether this parameter should be eligible for MIDI/modulation mapping or not.

Parameters:

mappable - Whether parameter should be available for mapping

Returns:

this

isMappable

default boolean isMappable()

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

Returns:

true if mappable, false if otherwise