tracktion_ParameterChangeHandler.h

Go to the documentation of this file.

 /*
    ,--.                     ,--.     ,--.  ,--.
  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
 
    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
*/
 
namespace tracktion { inline namespace engine
{
 
class ParameterChangeHandler   : public juce::ChangeBroadcaster
{
public:
    //==============================================================================
    ParameterChangeHandler (Edit&);
 
    bool isEventPending() const noexcept;
 
    struct Disabler
    {
        Disabler (ParameterChangeHandler& p) : owner (p)    { p.enabled = false; }
        ~Disabler()                                         { owner.enabled = true; }
 
        ParameterChangeHandler& owner;
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Disabler)
    };
 
    //==============================================================================
    void parameterChanged (AutomatableParameter& parameter, bool fromAutomation);
 
    bool isParameterPending() const noexcept;
 
    AutomatableParameter::Ptr getPendingParam (bool consumeEvent) noexcept;
 
    //==============================================================================
    void actionFunctionTriggered (int externalControllerID);
 
    bool isActionFunctionPending() const noexcept;
 
    int getPendingActionFunctionId (bool consumeEvent) noexcept;
 
    //==============================================================================
    void setParameterLearnActive (bool a)     { parameterLearnActive = a; }
 
private:
    //==============================================================================
    Edit& edit;
    int pendingActionId = -1;
    bool enabled = true;
    bool parameterLearnActive = false;
    AutomatableParameter::Ptr pendingParam;
    juce::CriticalSection eventLock;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ParameterChangeHandler)
};
 
}} // namespace tracktion { inline namespace engine