ParameterManager.h

Go to the documentation of this file.

namespace krotos
{
    //==============================================================================
    class ParameterManager final
    {
      public:
        ParameterManager(AudioProcessor& processor,
                         /* If we want this more than 999 we have to rework the
                         parameter naming logic(prefix 0000). */
                         int numParams = 1000,
                         const String& namePrefix = "#");
 
        static const float DefaultModDepth;
 
        static const float OnOffThreshold;
 
        Kwidget* getKwidget(const String& kwidgetID);
 
        bool addKwidget(Kwidget* kwidget, bool useEndParams = false, bool isChildKwidget = false);
 
        void removeKwidget(const String& kwidgetID);
 
        void clearKwidgets();
 
        void addConnection(const String& sourceID, const String& destinationID);
 
        void removeConnection(const String& sourceID, const String& destinationID);
 
        void removeConnectionsInvolving(const String& kwidgetID);
 
        void clearConnections();
 
        bool connectionExists(const String& sourceID, const String& destID);
 
        ValueTree addModulation(const String& sourceID, int modulatorIdx, const String& destinationID,
                                const String& paramID, float depth = DefaultModDepth,
                                KAttachment::Polarity = KAttachment::Polarity::Bipolar);
 
        void removeModulation(const String& sourceID, int modulatorIdx, const String& destinationID,
                              const String& paramID);
 
        void removeModulation(ValueTree modulationChildTree);
 
        void setModulationDepth(const String& sourceID, int modulatorIdx, const String& destinationID,
                                const String& paramID, float depth);
 
        void setModulationPolarity(const String& src, int modulatorIdx, const String& dest, const String& paramID,
                                   KAttachment::Polarity polarity);
 
        void removeModulationInvolving(const String& kwidgetID);
 
        void clearModulation();
 
        void clearModulationExcept(const String& allowedSource);
 
        ValueTree& getState();
 
        const ValueTree& getModulationTree();
 
        const ValueTree& getKwidgetsTree();
 
        const ValueTree& getConnectionTree() { return m_connectionTree; };
 
        inline const bool isAStaticConnectionDestination(const String& destName)
        {
            return std::find(StaticConnectionDestinations.begin(), StaticConnectionDestinations.end(), destName) !=
                   StaticConnectionDestinations.end();
        };
 
        void setCurrentState(const ValueTree& newState);
 
        void addNonStaticConnections(juce::ValueTree& newConnectionTree);
 
        AudioProcessor& getProcessor();
 
        AudioProcessorValueTreeState& getProcessorState();
 
        UndoManager* getUndoManager();
 
        void resetUndoManager();
 
        void debugState() const;
 
        void addCustomDataNode(const ValueTree& customDataNode);
 
        ValueTree& getCustomDataTree();
 
        bool validateKwidgetState(ValueTree& kwidgetTree, ValueTree& paramTree, bool repairEnabled);
 
        bool initialiseLinkIndexUsageTable(const ValueTree& state, bool repairEnabled);
 
        bool initialiseKwidgetIDUsageTable(const ValueTree& state, bool repairEnabled);
 
        String generateKwidgetID(const String& kwidgetType, const String& idModifier = "", int typeInstanceLimit = 0);
 
        static Result rewriteCustomParameterValue(ValueTree& kwidgetTree, const var& parameterID, const var& newValue,
                                                  UndoManager* undoManager = nullptr);
 
      private:
        static const StringArray StaticConnectionDestinations;
 
        // One bool for every link index to indicate whether it is used or not
        std::vector<bool> m_linkIndexAllocation;
 
        int getUnusedLinkIndex();
 
        bool flagUsedIndexes(juce::ValueTree& kwidget, bool repairEnabled);
 
        bool registerKwidget(juce::ValueTree& kwidget, StringArray& kwidgetIDArray, bool repairEnabled);
 
        void setGenericParameterValue(ValueTree& paramTreeGeneric, int index, var newValue);
 
        using Property = XmlType::Property;
        using Tag = XmlType::Tag;
 
        void addGenericParameters();
 
        std::vector<int> findGenericParameters(int numParametersToLink, bool useEndParams);
        ValueTree createKwidgetTree(Kwidget* k, bool useEndParams = false);
 
        void attachParameters(Kwidget* kwidget, const ValueTree& kwidgetTree);
        void detachParameters(Kwidget* kwidget, const ValueTree& kwidgetTree);
 
        ValueTree getModulationTree(const String& sourceID, int modulatorIdx, const String& destinationID,
                                    const String& paramID);
 
        void copyModulationTree(ValueTree modTree);
 
        AudioProcessor& m_processor;
        UndoManager m_undoManager;
        AudioProcessorValueTreeState m_vts;
        std::vector<GenericParameter*> m_genericParameters;
 
        ValueTree m_parentTree;
        ValueTree m_processorTree;
        ValueTree m_kwidgetTree;
        ValueTree m_connectionTree;
        ValueTree m_modulationTree;
        ValueTree m_customDataTree;
 
        std::map<Kwidget*, ValueTree> m_kwidgetData;
        std::map<String, Kwidget*> m_activeKwidgets;
 
        const int m_numGenericParameters;
        const String m_parameterNamePrefix;
        int m_numDigitsInGenericParamName;
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(ParameterManager)
    };
} // namespace krotos