tracktion_SelectableClass.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 SelectableClass
{
public:
    //==============================================================================
    SelectableClass();
    virtual ~SelectableClass();
 
    static SelectableClass* findClassFor (const Selectable&);
    static SelectableClass* findClassFor (const Selectable*);
 
    template<typename SelectableType>
    static SelectableClass* findClassFor();
 
    //==============================================================================
    virtual juce::String getDescriptionOfSelectedGroup (const SelectableList&);
 
    virtual bool canBeSelected (const Selectable& object);
 
    virtual bool canClassesBeSelectedAtTheSameTime (SelectableClass* otherClass);
 
    virtual bool canObjectsBeSelectedAtTheSameTime (Selectable& object1, Selectable& object2);
 
    //==============================================================================
    struct AddClipboardEntryParams
    {
        AddClipboardEntryParams (Clipboard& c) : clipboard (c) {}
 
        SelectableList items;
        Edit* edit = nullptr;
        int editViewID = -1;
        Clipboard& clipboard;
    };
 
    virtual void addClipboardEntriesFor (AddClipboardEntryParams&);
 
    struct DeleteSelectedParams
    {
        SelectionManager* selectionManager = nullptr;
        SelectableList items;
        bool partOfCutOperation;
    };
 
    virtual void deleteSelected (const DeleteSelectedParams& params);
 
    virtual bool pasteClipboard (const SelectableList& currentlySelectedItems, int editViewID);
 
    virtual bool canCutSelected (const SelectableList& selectedObjects);
 
    //==============================================================================
    enum class Relationship
    {
        moveUp, moveDown, moveLeft, moveRight,
        moveToHome, moveToEnd,
        selectAll
    };
 
    struct SelectOtherObjectsParams
    {
        SelectionManager& selectionManager;
        SelectableList currentlySelectedItems;
        Relationship relationship;
        bool keepExistingItemsSelected = false;
        int editViewID = -1;
    };
 
    virtual void selectOtherObjects (const SelectOtherObjectsParams&);
 
    virtual void keepSelectedObjectOnScreen (const SelectableList& currentlySelectedObjects);
 
    static bool areAllObjectsOfUniformType (const SelectableList& selectedObjects);
 
    //==============================================================================
    struct ClassInstanceBase
    {
        ClassInstanceBase();
        virtual ~ClassInstanceBase();
        virtual SelectableClass* getClassForObject (const Selectable*) = 0;
    };
 
    template <typename ClassType, typename ObjectType>
    struct ClassInstance  : public ClassInstanceBase
    {
        SelectableClass* getClassForObject (const Selectable* s) override  { return dynamic_cast<const ObjectType*> (s) != nullptr ? &cls : nullptr; }
        ClassType cls;
    };
 
    #define DECLARE_SELECTABLE_OBJECT_AND_CLASS(ObjectType, ClassType) \
        static SelectableClass::ClassInstance<ClassType, ObjectType> JUCE_JOIN_MACRO (selectableClass ## ClassType, __LINE__);
 
    #define DECLARE_SELECTABLE_CLASS(ObjectType) \
        DECLARE_SELECTABLE_OBJECT_AND_CLASS (ObjectType, ObjectType ## SelectableClass)
 
private:
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SelectableClass)
};
 
 
//==============================================================================
class SelectableClassWithVolume
{
public:
    virtual ~SelectableClassWithVolume() {}
 
    virtual void setVolumeDB (const SelectableList&, float dB, SelectionManager*) = 0;
    virtual float getVolumeDB (const SelectableList&) = 0;
    virtual void resetVolume (const SelectableList&) = 0;
};
 
//==============================================================================
class SelectableClassWithPan
{
public:
    virtual ~SelectableClassWithPan() {}
 
    virtual void setPan (const SelectableList&, float pan, SelectionManager*) = 0;
    virtual float getPan (const SelectableList&) = 0;
    virtual void resetPan (const SelectableList&) = 0;
};
 
}} // namespace tracktion { inline namespace engine