LibraryManager.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: LibraryManager
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/QTModelManager.h>
#include <NDEVR/TranslatedString.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Manages loading Models from a group that is stored either on a remote server or locally on
        the disk in a compressed or uncompressed folder.
    **/
    class NDEVR_API LibraryManager : public QObject
    {
        Q_OBJECT
    public:
        LibraryManager(QTModelManager* manager, const File& library_folder);
        String getIcon(const UUID& id) const;
        TranslatedString getName(const UUID& id) const
        {
            return m_names.get(id);
        }
        TranslatedString getName(const UUID& id) const {…}
        String getType(const UUID& id) const
        {
            return m_types.get(id);
        }
        String getType(const UUID& id) const {…}
        TranslatedString getSearchTerms(const UUID& id) const
        {
            return m_search_terms.get(id);
        }
        TranslatedString getSearchTerms(const UUID& id) const {…}
        Model loadObject(const UUID& id, bool center_model);
        void centerModel(Model& model);
        bool hasID(const UUID& id) const;
        Buffer<UUID> getIDs() const { return m_ids; }
        Buffer<String> getTypes() const;
        Buffer<TranslatedString> getCategories() const;
        Buffer<UUID> getIDsByCategory(const TranslatedString& category);
        void updateFromArchive();
        void addToLibrary(const UUID& object, UUID library_object);
        void removeFromLibrary(const UUID& object);
        void saveToArchiveFile(File file);
        void pullFromArchiveFile(File file);
        void saveAllImagesToFolder(File folder);
        void addLayer(Model& model);
        QTModelManager* manager() { return m_manager; }
        void recomputeObject(UUID);
        void recomputeAll();
    protected:
        void updateFromArchive(const UUID& file);
        void updateFromArchive(const File& file);
        bool writeToLibrary(const UUID& object_to_write, UUID library_id);
    signals:
        void modelAdded(UUID id);
        void modelRemoved(UUID id);
    protected:
        DesignObjectLookup m_library_lookup;
        Buffer<UUID> m_ids;
        Dictionary<UUID, TranslatedString> m_names;
        Dictionary<UUID, String> m_types;
        Dictionary<UUID, TranslatedString> m_categories;
        Dictionary<UUID, TranslatedString> m_search_terms;
        QTModelManager* m_manager;
        File m_archive_path;
    };
    class NDEVR_API LibraryManager : public QObject {…};
}