NDVFactory.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: NDVFactory
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/SoftwareService.h>
#include <NDEVR/IOFactory.h>
#include <NDEVR/Material.h>
#include <NDEVR/Model.h>
#include <NDEVR/File.h>
namespace NDEVR
{
    class FactoryOptions;
    class Model;
    class Log;
    class ImageFactory;
    class FactoryFeatures;
    /**--------------------------------------------------------------------------------------------------
    \brief Used to modify objects when they are imported using the NDVFactory.
    **/
    class NDVSetupCallback : public SoftwareService
    {
    public:
        NDVSetupCallback(std::function<void(Model&)> callback)
            : callback(callback)
        {}
        std::function<void(Model&)> callback;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief reads and writes to NDV Files. NDV Files are optionally compressed data dumps of the internal
        structure of model heirarchies.
 
    NDVSetupCallbacks can be used to modify objects when they are imported.
    **/
    class NDEVR_FACTORY_API NDVFactory : public IOFactory, public SoftwareServiceManager
    {
    protected:
        NDVFactory();
    public:
        static NDVFactory& DefaultFactory();
        static String ReadIcon(const File& file, ImageFactory& factory);
        String getIcon(const File& file) override;
        String getData(const File& file);
        FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
        FactoryOptions defaultReadOptions(const FactoryParameters& file) const override;
        FactoryOptions defaultWriteOptions(const FactoryParameters& file) const override;
        static void AddSetupCallback(NDVSetupCallback* callback);
        static FileFormat NDVFormat();
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
        virtual bool readFile(FactoryParameters& params) override;
        virtual bool writeFile(FactoryParameters& params) override;
        uint08 version(const File& file);
        static uint08 CurrentVersion();
        virtual bool determineExtension(const File& file, String& extension) override;
        virtual bool canRead(const FactoryParameters& file) override;
        virtual bool canWrite(const FactoryParameters& file) override;
        virtual bool canWrite(const FileFormat& file) override;
    private:
        void tidyUpScene(const FactoryParameters& file
            , Scene& scene
            , const Buffer<UUID>& objects_read
            , uint08 version_number
            , Buffer<Model>& read_models
            , Buffer<Material>& read_materials
            , bool ignore_project
            , Time current_time);
        static void EnsureSaneModel(Model& model, Time& current_time);
        static Buffer<NDVSetupCallback*> s_setup_callbacks;
    };
    
}