Package heronarts.lx.parameter

Interface LXNormalizedParameter

All Superinterfaces:
LXParameter, LXPath
All Known Subinterfaces:
LXCompoundModulation.Target
All Known Implementing Classes:
AHDSREnvelope, BandGate, BooleanParameter, BoundedFunctionalParameter, BoundedParameter, CompoundDiscreteParameter, CompoundEnumParameter, CompoundObjectParameter, CompoundParameter, Damper, DecibelMeter, DiscreteColorParameter, DiscreteParameter, DmxModulator, EnumParameter, FunctionalModulator, GraphicMeter, LinearEnvelope, LXAudioEngine.Meter, LXListenableNormalizedParameter, LXPalette.IndexSelector, LXRangeModulator, LXVariablePeriodModulator, LXViewEngine.Selector, LXViewEngine.SelectorNormal, LXViewEngine.SelectorPriority, MultiModeEnvelope, MultiStageEnvelope, NoiseModulator, NormalizedParameter, ObjectParameter, OperatorModulator, QuadraticEnvelope, Randomizer, SawLFO, Scaler, SinLFO, Smoother, SoundObject, SoundObject.Selector, Spring, SquareLFO, Timer, TriangleLFO, TriggerParameter, 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.

  • Method Details

    • 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

      default 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

    • getBaseNormalized

      default double getBaseNormalized()
      Get the base parameter value, for modulated parameters this may differ from getValue()
      Returns:
      Base normalized parameter value

    • getBaseNormalizedf

      default float getBaseNormalizedf()
      Get the base parameter value, for modulated parameters this may differ from getValue()
      Returns:
      Base normalized parameter value

    • getValueFromNormalized

      default double getValueFromNormalized(double normalized)
      Get the equivalent raw parameter value from a normalized value
      Parameters:
      normalized - Normalized value
      Returns:
      The equivalent raw value

    • getExponent

      default double getExponent()
      Gets the exponent used for scaling this parameter across its normalized range. Default is 1 which means linear scaling.
      Returns:
      scaling exponent

    • isWrappable

      default boolean isWrappable()
      Whether this parameter should wrap when incremented or decremented at the extent of its range.
      Returns:
      true if wrappable, false if otherwise

    • getOscMode

      default LXNormalizedParameter.OscMode getOscMode()