tracktion_SelectionManager.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 SelectionManager  : public juce::ChangeBroadcaster,
                          private SelectableListener
{
public:
    //==============================================================================
    SelectionManager (Engine&);
    ~SelectionManager() override;
 
    //==============================================================================
    int getNumObjectsSelected() const;
    Selectable* getSelectedObject (int index) const;
    bool isSelected (const Selectable*) const;
    bool isSelected (const Selectable&) const;
    const SelectableList& getSelectedObjects() const;
    SelectableClass* getFirstSelectableClass() const;
 
    void selectOnly (Selectable*);
    void selectOnly (Selectable&);
    void addToSelection (Selectable*);
    void addToSelection (Selectable&);
    void select (Selectable*, bool addToCurrentSelection);
    void select (Selectable&, bool addToCurrentSelection);
    void select (const SelectableList&);
 
    void deselectAll();
    void deselect (Selectable*);
 
    void selectOtherObjects (SelectableClass::Relationship, bool keepOldItemsSelected);
 
    //==============================================================================
    template <typename SelectableClass>
    bool containsType() const
    {
        return selected.containsType<SelectableClass>();
    }
 
    template <typename SelectableClass>
    int getNumObjectsSelectedOfType() const
    {
        int numOfType = 0;
 
        for (auto s : selected)
            if (dynamic_cast<SelectableClass*> (s) != nullptr)
                ++numOfType;
 
        return numOfType;
    }
 
    template <typename SelectableClass>
    juce::Array<SelectableClass*> getItemsOfType() const
    {
        juce::Array<SelectableClass*> items;
 
        for (auto s : selected)
            if (auto item = dynamic_cast<SelectableClass*> (s))
                items.add (item);
 
        return items;
    }
 
    template <typename SelectableClass>
    SelectableClass* getFirstItemOfType() const
    {
        for (auto s : selected)
            if (auto item = dynamic_cast<SelectableClass*> (s))
                return item;
 
        return {};
    }
 
    //==============================================================================
    void deleteSelected();
    bool copySelected();
    bool cutSelected();
 
    bool pasteSelected();
 
    void keepSelectedObjectsOnScreen();
 
    void refreshPropertyPanel();
    static void refreshAllPropertyPanels();
    static void refreshAllPropertyPanelsShowing (Selectable&);
 
    static void deselectAllFromAllWindows();
 
    //==============================================================================
    struct ChangedSelectionDetector
    {
        bool isFirstChangeSinceSelection (SelectionManager*);
        void reset();
 
        int lastSelectionChangeCount = 0;
    };
 
    // This gets incremented each time the selection changes
    int selectionChangeCount = 0;
 
    //==============================================================================
    struct ScopedSelectionState
    {
        ScopedSelectionState (SelectionManager&);
        ~ScopedSelectionState();
 
    private:
        SelectionManager& manager;
        SelectableList selected;
 
        JUCE_DECLARE_NON_COPYABLE (ScopedSelectionState)
    };
 
    //==============================================================================
    // (used internally)
    void selectableObjectChanged (Selectable*) override;
    void selectableObjectAboutToBeDeleted (Selectable*) override;
 
    struct Iterator
    {
        Iterator();
        bool next();
        SelectionManager* get() const;
        SelectionManager* operator->() const   { return get(); }
 
        int index = -1;
    };
 
    //==============================================================================
    // This is a utility base-class that Components can inherit from, and which can then
    // be found by calling SelectionManager::findSelectionManager()
    struct ComponentWithSelectionManager
    {
        ComponentWithSelectionManager() {}
        virtual ~ComponentWithSelectionManager() {}
 
        virtual SelectionManager* getSelectionManager() = 0;
    };
 
    // walks up the parent hierarchy of a component, looking for a ComponentWithSelectionManager,
    // and if it finds one, returns its SelectionManager.
    static SelectionManager* findSelectionManager (const juce::Component*);
    static SelectionManager* findSelectionManager (const juce::Component&);
 
    //==============================================================================
    static SelectionManager* findSelectionManagerContaining (const Selectable*);
    static SelectionManager* findSelectionManagerContaining (const Selectable&);
 
    Edit* getEdit() const;
 
    SafeSelectable<Edit> edit;
    int editViewID = -1;
    EditInsertPoint* insertPoint = nullptr;
 
    Engine& engine;
 
private:
    //==============================================================================
    SelectableList selected;
    friend class Selectable;
    juce::CriticalSection lock;
 
    void selectionChanged();
    void clearList();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SelectionManager)
};
 
}} // namespace tracktion { inline namespace engine