IOFactory.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: IOFactory
File: IOFactory
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/FactoryOptions.h>
#include <NDEVR/Model.h>
#include <NDEVR/File.h>
#include <NDEVR/FileFormat.h>
namespace NDEVR
{
    class Model;
    class Log;
    class SpatialObject;
    class DesignObjectLookup;
    class FactoryFeatures;
    struct FileFactoryWarning
    {
        FileFactoryWarning(const TranslatedString& title, const TranslatedString& message)
            : title(title)
            , message(message)
        {}
        FileFactoryWarning(const TranslatedString& title, const File& file, uint04 line_number = Constant<uint04>::NaN);
        TranslatedString title;
        TranslatedString message;
    };
    struct NDEVR_FACTORY_API FactoryParameters
    {
        FactoryParameters(const File& file, const FileFormat& format, const String& name = "default")
        {
            requests.add(name, FileRequest(file, format));
        }
        FactoryParameters(const FileRequest& request, const String& name = "default")
        {
            requests.add(name, request);
        }
        const FileFormat& format(const String& name = "default") const
        {
            return requests.get(name).format;
        }
        FileFormat& format(const String& name = "default")
        {
            return requests.get(name).format;
        }
        const File& file(const String& name = "default") const
        {
            return requests.get(name).file;
        }
        bool shouldWriteModel(const Model& model) const
        {
            Model m = model;
            while (m.isValid())
            {
                if (models.contains(m.uuid()))
                    return true;
                m = m.getParent();
            }
            return false;
        }
        void addWarning(const FileFactoryWarning& warning);
        Dictionary<String, FileRequest> requests;
        FactoryOptions options;
        Buffer<FileFactoryWarning> warnings;
        Buffer<UUID> models;
        Buffer<UUID> cameras;
        DesignObjectLookup* lookup = nullptr;
        ProgressInfo* log = nullptr;
    };
    
    class NDEVR_FACTORY_API IOFactory
    {
    public:
        friend class ModelFactory;
        IOFactory(const String& factory_name);
        const String& name() const { return m_factory_name; }
        virtual ~IOFactory();
        bool writeScenesToFile(const File& file, const Buffer<Scene>& scene);
        bool readFileWithDefaultSettings(const File& file, DesignObjectLookup* lookup);
        void getSupportedFormats(Buffer<FileFormat>& formats);
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) = 0;
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, const File& file);
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models);
        virtual void getSupportedFormatsForExtension(Buffer<FileFormat>& formats, bool is_read, const String& extension);
        virtual void getSupportedFormatsByModelType(Buffer<FileFormat>& formats, bool is_read, const String& model_type);
        virtual Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const;
        virtual bool isFactoryEnabled(bool is_read) const;
        virtual bool canRead(const File& file);
        virtual bool determineExtension(const File& file, String& extension);
        virtual bool canWrite(const File& file);
        virtual bool isAutoEnabled() const;
        virtual String getIcon(const File& file);
        virtual bool canRead(const FactoryParameters& file);
        virtual bool canWrite(const FactoryParameters& file);
        virtual bool canRead(const FileFormat& file);
        virtual bool canWrite(const FileFormat& file);
        Buffer<Scene> readScenesFromFile(const File& file);
        virtual FactoryOptions defaultReadOptions(const FactoryParameters& file) const;
        virtual FactoryOptions defaultWriteOptions(const FactoryParameters& file) const;
        virtual bool updateFromFile(const FactoryParameters& file, const FactoryOptions& old_options);
        virtual FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const = 0;
        String factoryReadAppFeature() const;
        String factoryWriteAppFeature() const;
        void throwIfNotEnabled(bool is_read);
        static void EnableFactory(IOFactory* factory, const String& read_password, const String& write_password);
        static void EnableFactory(const String& factory, const String& read_password, const String& write_password);
        static void EnableExtension(const String& extension, const String& read_password, const String& write_password);
    private:
        virtual bool readFile(FactoryParameters& file) = 0;
        virtual bool writeFile(FactoryParameters& file) = 0;
    private:
        String m_factory_name;
    };
}