ModelChooserCombo.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: ModelChooserCombo
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/QTModelManager.h>
#include <NDEVR/QCustomCombobox.h>
#include <NDEVR/Set.h>
namespace NDEVR
{
    class NDEVR_API ModelChooserCombo : public QCustomComboBox
    {
        Q_OBJECT
    public:
        ModelChooserCombo(QWidget* parent = nullptr);
        void setIncludeParentName(bool include_parent_name, const String& parent_type = String());
        void setIncludePath(bool include_parent_name, const String& parent_type = String());
        void setManager(QTModelManager* manager);
        bool canAddModel(const Model& model)
        {
            return !m_models.hasKey(model.uuid()) && isModelAllowed(model);
        }
        bool isModelAllowed(const Model& model);
        void setModelFilter(const std::function<bool(const Model&)>& model_filter)
        {
            m_model_type.clear();
            m_model_filter = model_filter;
        }
        void setModelType(const String& type);
        void setIDs(const Buffer<UUID>& ids)
        {
            lib_assert(m_manager != nullptr, "Need to set Model Manager");
            if (m_manager != nullptr)
                setModels(m_manager->getModelsByID(ids));
        }
        void addID(const UUID& id);
        void removeID(const UUID& id)
        {
            if (m_models.hasKey(id))
            {
                _removeID(id);
                refreshWidget();
            }
        }
        void setModels(const Buffer<Model>& models);
        TranslatedString displayName(const Model& m);
        void refreshFromManager()
        {
 
        }
        void setAllowNew(bool allow_new, const TranslatedString& new_title);
        void setCurrentSelection(UUID id);
        void setToNew()
        {
            lib_assert(m_allow_add_new, "Tried to set to new when new not enabled");
            setValue(UUID::CreateUUID("New Model"));
        }
        bool isNewSelected() const
        {
            return getAs<UUID>() == UUID::CreateUUID("New Model");
        }
        void setExclusionList(const Buffer<UUID>& exclusion_list)
        {
            m_exclusion_list.clear();
            for (uint04 i = 0; i < exclusion_list.size(); i++)
                m_exclusion_list.insert(exclusion_list[i]);
        }
        UUID selectedID() const
        {
            UUID id = getAs<UUID>();
            if (id == UUID::CreateUUID("New Model"))
                id = Constant<UUID>::Invalid;
            return id;
        }
        virtual void onSorted(const Buffer<uint04>& sorted_indices);
        void setDisplayNameCallback(std::function<TranslatedString(const Model&)>& callback)
        {
            m_display_name_callback = callback;
        }
        void setModelParentID(const UUID& parent);
    signals:
        void newModelSelectedSignal();
        void modelSelectedSignal(UUID id);
    protected slots:
        void onObjectsDeletedSlot();
        void onObjectAddedSlot(const Buffer<UUID>& ids);
        void addModel(const Model& m)
        {
            if (canAddModel(m))
            {
                _addModel(m);
                refreshWidget();
            }
        }
        void onObjectUpdatedSlot(Buffer<UUID> ids);
        void onEdited();
    private:
        void _removeID(const UUID& id);
        void _addModel(const Model& m);
    protected:
        Set<UUID> m_exclusion_list;
        std::function<TranslatedString(const Model&)> m_display_name_callback;
        Dictionary<UUID, uint04> m_models;
        Dictionary<UUID, Buffer<UUID>> m_model_parents;
        UUID m_model_parent = Constant<UUID>::Invalid;
        String m_model_type;
        String m_parent_type;
        QTModelManager* m_manager;
        std::function<bool(const Model&)> m_model_filter;
        bool m_allow_add_new;
        bool m_include_parent_name;
        bool m_include_path;
    };
}