QTModelManagerView.h

/*--------------------------------------------------------------------------------------------
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: QTModelManagerView
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/QTModelManager.h>
 
#include <NDEVR/Model.h>
#include <QAbstractItemModel>
#include <QIcon>
namespace NDEVR
{
    class NDEVR_API QTModelManagerView final : public QAbstractItemModel
    {
        Q_OBJECT
    protected:
        struct ModelCache
        {
            uint04 cache_index = Constant<uint04>::Invalid; 
            Buffer<UUID> children; 
            UUID material = Constant<UUID>::Invalid; 
            UUID parent = Constant<UUID>::Invalid; 
            QString name; 
            QString material_name; 
            String icon; 
            String material_icon; 
            QString tooltip; 
            RGBColor icon_color = Constant<RGBColor>::Invalid; 
            bool is_visible = true; 
            bool is_visible_recursive = true; 
            bool is_selected = false; 
        };
    public:
        friend class ProxyModelViewFilter;
        QTModelManagerView(QTModelManager* manager, QObject *parent = nullptr);
 
        virtual int rowCount(const QModelIndex& parent = QModelIndex()) const override;
        int columnCount(const QModelIndex& parent = QModelIndex()) const override;
        bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
        QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;
        Qt::ItemFlags flags(const QModelIndex& index) const override;
        QVariant headerData(int column, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
        QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;
        QModelIndex parent(const QModelIndex& index) const override;

        QTModelManager& manager();
        virtual ~QTModelManagerView() = default;
        void setRootModels(const Buffer<UUID>& roots);
        const Buffer<UUID>& rootModels() const { return m_root_models; }
        void setIsRootFilter(const std::function<bool(const Model&)>& filter) { m_root_filter = filter; }
    protected slots:
        void clearAll();
        void modelDeleted(Buffer<UUID> id);
        void objectSelected(Buffer<UUID> id, bool selected);
        void modelFocussed(UUID id, bool selected);
        void modelAdded(Buffer<UUID> id);
        void modelUpdatedSlot(const Buffer<UUID>& updated_ids);
        void materialUpdatedSlot(const Buffer<UUID>& updated_ids);
        void projectChanged(UUID id);
        void topLevelChanged(Buffer<UUID> id);
    protected:
        QVariant data(const UUID& id, int role, int column) const;
        bool hasCached(const UUID& id) const;
        QModelIndex getIndex(const Model& model, int column) const;
        QModelIndex getIndex(const UUID& id, int column) const;
        QIcon::Mode iconMode(const QModelIndex& index) const;
        ModelCache createCache(const Model& model, bool recursive, bool parent_visible, bool add_id) const;

        UUID getModelID(const QModelIndex& model_index) const;
        UUID getMaterialID(const QModelIndex& model_index) const;
        Model model(const QModelIndex& model_index) const;
        Model model(uint04 row, const QModelIndex& parent) const;

        void setupCache(const Model& model, bool recursive, bool parent_visible, bool add_id) const;
        void updateModel3DVisible(const UUID& id, bool visible);
        void recursiveCacheRemove(const UUID& id);

        void addModel(UUID id);
        void refreshAll();
        void emitIndexUpdated(const UUID& id, const QList<int>& roles = QList<int>());
        void postMaterialImageRequest(const UUID& id) const;
    protected:
        QTModelManager* m_manager; 
        Buffer<UUID> m_root_models; 
        mutable Buffer<UUID> m_index_ids; 
        mutable Dictionary<UUID, QIcon> m_cached_material_images; 
        mutable Dictionary<UUID, ModelCache> m_cached_model_indices; 
        mutable Dictionary<UUID, Set<UUID>> m_cached_material_indices; 
        std::function<bool(const Model&)> m_root_filter; 
        UUID m_tree_capture_id; 
        UUID m_project_id; 
        bool m_include_materials = true; 
    };
}