AssimpFactory.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: AssimpFactory
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/IOFactory.h>
 
struct aiScene;
struct aiNode;
struct aiMaterial;
struct aiMesh;
namespace NDEVR
{
    class Model;
    class Log;
    class FactoryOptions;
    class FactoryFeatures;
    class FileFormat;
    class File;
    class FactoryOptions;
    /**--------------------------------------------------------------------------------------------------
    Class: AssimpSceneMemory
 
    \brief Stores all of the objects needed for an aiScene in a way that is efficient and uses native
    containers.
    *-----------------------------------------------------------------------------------------------**/
    struct ASSIMP_INTERFACE_API AssimpSceneMemory
    {
    public:
        AssimpSceneMemory();
        AssimpSceneMemory(aiScene* scene);
        ~AssimpSceneMemory();
        aiScene* scene;
        Dictionary<UUID, Buffer<aiNode*>> ai_models;
        Dictionary<UUID, uint04> mat_offset;
        Dictionary<UUID, uint04> mesh_offset;
        Buffer<aiMaterial*> ai_materials;
        Buffer<aiMesh*> ai_meshes;
        Dictionary<String, uint04> material_names;//prevent duplicate names
        bool preserve_memory;
    };
 
    /**--------------------------------------------------------------------------------------------------
    Class: AssimpFactory
 
    \brief IOFactory for writing to files using the ASSIMP 3rd party library. Assimp supports many file
    types. For more information see: https://assimp.org/
    *-----------------------------------------------------------------------------------------------**/
    class ASSIMP_INTERFACE_API AssimpFactory : public IOFactory
    {
    public:
        AssimpFactory();
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
        Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
        virtual String getIcon(const File& file) override;
        virtual bool readFile(FactoryParameters& file) override;
        virtual bool writeFile(FactoryParameters& file) override;
        static bool ConvertToAiScene(AssimpSceneMemory& scene, FactoryParameters& params);
        static bool ConvertFromAiScene(const aiScene* scene, FactoryParameters& params);
        FactoryOptions defaultReadOptions(const FactoryParameters& file) const override;
        FactoryOptions defaultWriteOptions(const FactoryParameters& file) const override;
        virtual FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_read) const override;
    };
}