juce_ParameterAttachments.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{

class ParameterAttachment   : private AudioProcessorParameter::Listener,
                              private AsyncUpdater
{
public:
    ParameterAttachment (RangedAudioParameter& parameter,
                         std::function<void (float)> parameterChangedCallback,
                         UndoManager* undoManager = nullptr);

    ~ParameterAttachment() override;

    void sendInitialUpdate();

    void setValueAsCompleteGesture (float newDenormalisedValue);

    void beginGesture();

    void setValueAsPartOfGesture (float newDenormalisedValue);

    void endGesture();
 
private:
    float normalise (float f) const   { return parameter.convertTo0to1 (f); }
 
    template <typename Callback>
    void callIfParameterValueChanged (float newDenormalisedValue, Callback&& callback);
 
    void parameterValueChanged (int, float) override;
    void parameterGestureChanged (int, bool) override {}
    void handleAsyncUpdate() override;
 
    RangedAudioParameter& parameter;
    std::atomic<float> lastValue { 0.0f };
    UndoManager* undoManager = nullptr;
    std::function<void (float)> setValue;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ParameterAttachment)
};
 
//==============================================================================
class SliderParameterAttachment   : private Slider::Listener
{
public:
    SliderParameterAttachment (RangedAudioParameter& parameter, Slider& slider,
                               UndoManager* undoManager = nullptr);

    ~SliderParameterAttachment() override;

    void sendInitialUpdate();
 
private:
    void setValue (float newValue);
    void sliderValueChanged (Slider*) override;
 
    void sliderDragStarted (Slider*) override { attachment.beginGesture(); }
    void sliderDragEnded   (Slider*) override { attachment.endGesture(); }
 
    Slider& slider;
    ParameterAttachment attachment;
    bool ignoreCallbacks = false;
};
 
//==============================================================================
class ComboBoxParameterAttachment   : private ComboBox::Listener
{
public:
    ComboBoxParameterAttachment (RangedAudioParameter& parameter, ComboBox& combo,
                                 UndoManager* undoManager = nullptr);

    ~ComboBoxParameterAttachment() override;

    void sendInitialUpdate();
 
private:
    void setValue (float newValue);
    void comboBoxChanged (ComboBox*) override;
 
    ComboBox& comboBox;
    RangedAudioParameter& storedParameter;
    ParameterAttachment attachment;
    bool ignoreCallbacks = false;
};
 
//==============================================================================
class ButtonParameterAttachment   : private Button::Listener
{
public:
    ButtonParameterAttachment (RangedAudioParameter& parameter, Button& button,
                               UndoManager* undoManager = nullptr);

    ~ButtonParameterAttachment() override;

    void sendInitialUpdate();
 
private:
    void setValue (float newValue);
    void buttonClicked (Button*) override;
 
    Button& button;
    ParameterAttachment attachment;
    bool ignoreCallbacks = false;
};
 
} // namespace juce