DesignTableModel.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVR
File: DesignTableModel
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/DesignObject.h>
#include <NDEVR/DesignParameter.h>
#include <QSortFilterProxyModel>
#include <QAbstractTableModel>
#include <functional>
namespace NDEVR
{
    class QTModelManager;
    class Button;
    class QTDesignObject;
    struct PopupInfo;
    class QTResourceListener;
    constexpr int model_table_is_clicked_index = Qt::UserRole + 1;
    constexpr int model_table_is_selected_index = Qt::UserRole + 2;
    /**--------------------------------------------------------------------------------------------------
    \brief Provides the ability to pull specific data from a DesignObjectLookup for display in a column
        of a table.
    **/
    struct NDEVR_API ModelTableColumnSpec
    {
        enum ModelTableType
        {
              e_design_parameter
            , e_model_material
            , e_custom_callback
        };
        enum RelativePath
        {
              e_parent
            , e_last_child
            , e_child_index = 10
            , e_child_0 = e_child_index
            , e_child_1
            , e_child_2
            , e_child_3
            , e_child_4
            , e_child_5
            , e_child_6
            , e_child_7
        };
        struct RelativePathObject
        {
            RelativePath path;
            String type;
            std::function<void(DesignObject&)> create_callback = nullptr;//A callback for creating the missing child, if it does not exist
            RelativePathObject(RelativePath path)
                : path(path)
            {}
            RelativePathObject(RelativePath path, String type)
                : path(path)
                , type(std::move(type))
            {}
        };
        ModelTableType column_type;
        TranslatedString custom_column_name;
        TranslatedString custom_text;
        String custom_icon;
        bool is_clicked = false;
        bool is_editable;
        bool is_currently_editable = false;
        uint04 max_decimal_places;
        uint04 min_decimal_places;
        std::function<void(UUID)> callback;
        DesignParameter design_parameter;
        Buffer<RelativePathObject> relative_path;
    public:
        ModelTableColumnSpec();
        explicit ModelTableColumnSpec(const std::function<void(UUID)>& callback);
        explicit ModelTableColumnSpec(const DesignParameter& parameter);
        explicit ModelTableColumnSpec(const DesignParameter& parameter, Buffer<RelativePathObject> relative_mode);
        explicit ModelTableColumnSpec(ModelTableType type);
        ModelTableColumnSpec(const TranslatedString& text, const String& icon, const std::function<void(UUID)>& callback);
        [[nodiscard]] DesignObject getTarget(const DesignObject& a, bool try_to_create) const;
        [[nodiscard]] String stringDisplayData(const DesignObject& obj) const;
        [[nodiscard]] QVariant data(const DesignObject& obj, int role = Qt::DisplayRole) const;
        [[nodiscard]] bool setData(const DesignObject& obj, const QVariant& value, int role);
        [[nodiscard]] TranslatedString headerTitle() const;
        [[nodiscard]] bool isValid() const;
        [[nodiscard]] bool isTextEditable() const;
        [[nodiscard]] bool isCheckEditable() const;
        [[nodiscard]] bool isSortEqual(const DesignObject& a, const DesignObject& b) const;
        [[nodiscard]] bool isSortLessThan(const DesignObject& a, const DesignObject& b) const;
    protected:
        [[nodiscard]] QVariant parameterData(const DesignObject& obj, int role) const;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Provides the ability to pull data from a DesignObjectLookup for display in tables within the
        NDEVR API.
    **/
    class NDEVR_API DesignTableModel : public QAbstractTableModel
    {
        Q_OBJECT
    public:
        explicit DesignTableModel(QObject* parent = nullptr);
        virtual ~DesignTableModel();
        void setup();
        [[nodiscard]] int rowCount(const QModelIndex& parent = QModelIndex()) const override;
        [[nodiscard]] int columnCount(const QModelIndex& parent = QModelIndex()) const override;
        void setList(const Buffer<UUID>& models);
        [[nodiscard]] QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;
        [[nodiscard]] QVariant userData(const QModelIndex& index, int role) const;
        [[nodiscard]] bool isMaterialIndex(const QModelIndex& index) const;
        [[nodiscard]] bool isSpecialCallbackIndex(const QModelIndex& index) const;
        [[nodiscard]] bool setData(const QModelIndex& index, const QVariant& value, int role) override;
        [[nodiscard]] QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
        void setModelManager(QTModelManager* manager);
        void setAddedFilter(const std::function<bool(const Model&)>& callback) { m_added_filter = callback; }
        uint04 addColumn(DesignObject::DesignProperty property, bool is_editable);
        uint04 addColumn(const DesignParameter& parameter, bool is_editable);
        uint04 addColumn(const TranslatedString& name, const String& icon, const std::function<void(UUID)>& callback);
        uint04 addColumn(const ModelTableColumnSpec& column);
        uint04 addParentPathColumn(const TranslatedString& custom_column_name = TranslatedString());
        uint04 addParentDataColumn(const DesignParameter& param, bool is_editable, const TranslatedString& custom_column_name = TranslatedString());
        uint04 addGrandparentNameColumn(const TranslatedString& custom_column_name = TranslatedString());
        uint04 addMaterialDataColumn(const TranslatedString& custom_column_name = TranslatedString());
        
        [[nodiscard]] const ModelTableColumnSpec& getColumnSpec(uint04 column) const;
        [[nodiscard]] Qt::ItemFlags flags(const QModelIndex& index) const override;
        [[nodiscard]] QTModelManager* modelManager() const { return m_manager; };
        [[nodiscard]] UUID getUUID(QModelIndex index) const;
        [[nodiscard]] UUID getUUID(QModelIndex index, int row) const;
        [[nodiscard]] DynamicPointer<QTDesignObject> getDesignObject(QModelIndex index) const;
        [[nodiscard]] DynamicPointer<QTDesignObject> getDesignObject(QModelIndex index, int row) const;
        [[nodiscard]] Model getModel(QModelIndex index) const;
        [[nodiscard]] DesignObject getObject(QModelIndex index, int row) const;
        [[nodiscard]] DesignObject getObject(QModelIndex index) const;
        void onSelected(QModelIndex index, const QRect& rect);
        bool isEditable() const;
        bool isObjectAllowed(const UUID& object) const;
        bool canAddObject(const Model& object) const;
        bool isObjectAllowed(const Model& object) const;
        void setIsEditable(bool is_editable);
        void setColumnEditable(uint04 column, bool is_editable);
 
        void refreshAll();
        virtual void objectAdded(const Buffer<UUID>& ids);
        virtual void objectDeleted(const Buffer<UUID>& ids);
        virtual void modelUpdated(const Buffer<UUID>& ids);
    protected:
        void updateColumn(uint04 index);
    public slots:
        void objectAddedSlot(const Buffer<UUID>& ids);
        void objectDeletedSlot(const Buffer<UUID>& ids);
        void modelUpdatedSlot(const Buffer<UUID>& ids);
    protected:
        QTModelManager* m_manager;
        Buffer<UUID> m_models;//List of all models in the Table
        std::function<bool(const Model&)> m_added_filter;//Filter for added/valid objects
        Buffer<ModelTableColumnSpec> m_columns;
        Buffer<TranslatedString> m_custom_column_titles;
        Buffer<BitFlag> m_callback_clicked;
        QTResourceListener* m_coord_listener = nullptr;
        QTResourceListener* m_orientation_listener = nullptr;
        QTResourceListener* m_angle_listener = nullptr;
        bool m_is_editable;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Provides the ability to pull data from a DesignObjectLookup for display in tables within the
        NDEVR API and filter and sort it.
    **/
    class NDEVR_API DesignSortFilterProxyModel : public QSortFilterProxyModel
    {
        Q_OBJECT
    public:
        explicit DesignSortFilterProxyModel(DesignTableModel* model, QObject* parent = nullptr);
        void setSearchString(const String& search_string);
        DesignTableModel* model();
        void sort(Qt::SortOrder order = Qt::DescendingOrder);
        void sort(int column, Qt::SortOrder order = Qt::DescendingOrder) override;
        void sortBy(DesignObject::DesignProperty property, Qt::SortOrder order = Qt::DescendingOrder);
        void sortBy(ModelTableColumnSpec spec, Qt::SortOrder order = Qt::DescendingOrder);
        void sortBy(const Buffer<ModelTableColumnSpec>& specs, Qt::SortOrder order = Qt::DescendingOrder);
        void onSelected(const QModelIndex& index, const QRect& rect);
        Model getModel(const QModelIndex& index);
        UUID getUUID(const QModelIndex& index);
        ModelTableColumnSpec columnSpec(const QModelIndex& index);
        void setSearchParameter(const ModelTableColumnSpec& search_parameter);
        TranslatedString searchByTitle() const;
        [[nodiscard]] bool isMaterialIndex(const QModelIndex& index) const;
        [[nodiscard]] bool isSpecialCallbackIndex(const QModelIndex& index) const;
        bool isEditable() const;
        void setIsEditable(bool is_editable);
        void setColumnEditable(uint04 column, bool is_editable);
        [[nodiscard]] QTModelManager* modelManager() const { return m_design_model->modelManager(); };
        void setSelectedCallback(const std::function<void(Model, PopupInfo)>& callback) { m_selected_callback = callback; };
        void setSortCallback(const std::function<bool(const Model& a, const Model& b)>& callback);
        [[nodiscard]] const std::function<void(Model, PopupInfo)>& selectedCallback() const { return m_selected_callback; };
    signals:
        void searchByParameterChangedSignal();
    protected:
        virtual bool filterAcceptsRow(int sourceRow, const QModelIndex& sourceParent) const override;
        virtual bool lessThan(const QModelIndex& left, const QModelIndex& right) const override;
        bool modelIsShown(const DynamicPointer<QTDesignObject>& a) const;
        ModelTableColumnSpec currentSearchParameter() const;
    protected:
        String m_search_string;
        std::function<void(Model, PopupInfo)> m_selected_callback;
        std::function<bool(const Model& a, const Model& b)> m_sort_function;
        ModelTableColumnSpec m_search_parameter;
        ModelTableColumnSpec m_current_search_parameter;
        DesignTableModel* m_design_model;
        Buffer<ModelTableColumnSpec> m_sort_by;
    };
}