NDEVR
API Documentation
AssimpFactory.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: IOFactory
28File: AssimpFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/IOFactory.h>
35
36struct aiScene;
37struct aiNode;
38struct aiMaterial;
39struct aiMesh;
40namespace NDEVR
41{
42 class Model;
43 class Log;
44 class FactoryOptions;
45 class FactoryFeatures;
46 class FileFormat;
47 class File;
48 class FactoryOptions;
72
80 class ASSIMP_INTERFACE_API AssimpFactory : public IOFactory
81 {
82 private:
84 AssimpFactory();
85 public:
86 virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
87 Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
88 virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models) override;
89 virtual String getIcon(const File& file) override;
90 virtual bool readFile(FactoryParameters& file) override;
91 virtual bool writeFile(FactoryParameters& file) override;
101 static bool ConvertFromAiScene(const aiScene* scene, FactoryParameters& params);
104 virtual FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_read) const override;
107 static AssimpFactory* DefaultFactory();
110 static constexpr StringView FactoryID() { return "Assimp Factory"; }
111 };
112}
static constexpr StringView FactoryID()
Returns the unique identifier string for this factory.
virtual String getIcon(const File &file) override
Returns the icon name associated with the given file type.
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const override
Returns the default write options for the given factory parameters.
static AssimpFactory * DefaultFactory()
Returns the singleton AssimpFactory instance.
virtual void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the given buffer with supported file formats for reading or writing.
virtual bool writeFile(FactoryParameters &file) override
Writes data from the design object hierarchy to a file.
virtual bool readFile(FactoryParameters &file) override
Reads data from a file into the design object hierarchy.
static bool ConvertFromAiScene(const aiScene *scene, FactoryParameters &params)
Converts an imported Assimp scene into NDEVR design objects.
virtual FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_read) const override
Returns the features and configurable options for this factory given the parameters.
Buffer< UUID > filterModelsToExport(Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const override
Filters a list of model UUIDs to only those that can be exported in the given format.
static bool ConvertToAiScene(AssimpSceneMemory &scene, FactoryParameters &params)
Converts NDEVR design objects into an Assimp scene for export.
virtual void getSupportedFormats(Buffer< FileFormat > &formats, DesignObjectLookup *lookup, const Buffer< UUID > &models) override
Populates the given buffer with formats supported for writing the specified models.
FactoryOptions defaultReadOptions(const FactoryParameters &file) const override
Returns the default read options for the given factory parameters.
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58
A core class where all Design Objects including models, materials, and geometries are stored.
A hash-based key-value store, useful for quick associative lookups.
Definition Dictionary.h:64
Allows IOFactories to report what features they support to make the import/export dialogs easier to s...
User-defined options that define preferences for importing and exporting using IOFactory objects.
Data that describes a particular file format and how to use the format with the program.
Definition FileFormat.h:45
Logic for reading or writing to a file as well as navigating filesystems or other common file operati...
Definition File.h:53
IOFactory(const StringView &factory_name)
Constructs an IOFactory with the given factory name.
Serves as the primary program interface for processes to report issues and allows any number of LogSt...
Definition Log.h:50
A core class that represents a node on model hierarchy.
Definition Model.h:292
The core String View class for the NDEVR API.
Definition StringView.h:58
The core String class for the NDEVR API.
Definition String.h:95
The primary namespace for the NDEVR SDK.
Stores all of the objects needed for an aiScene in a way that is efficient and uses native containers...
Buffer< aiMaterial * > ai_materials
All Assimp materials accumulated for the scene.
~AssimpSceneMemory()
Destructor.
Buffer< aiMesh * > ai_meshes
All Assimp meshes accumulated for the scene.
AssimpSceneMemory()
Constructs an empty scene memory container.
Dictionary< UUID, uint04 > mat_offset
Maps model UUIDs to their starting material index offset.
Dictionary< UUID, std::pair< Geometry, uint04 > > mesh_offset
Maps model UUIDs to their geometry and mesh index offset.
bool preserve_memory
Whether to keep memory alive after destruction.
aiScene * scene
The Assimp scene being managed.
AssimpSceneMemory(aiScene *scene)
Constructs scene memory from an existing aiScene pointer.
Dictionary< String, uint04 > material_names
Tracks material names to prevent duplicate entries.
Dictionary< UUID, Buffer< aiNode * > > ai_models
Maps NDEVR model UUIDs to their Assimp scene nodes.
A container of input information that is to be filled with output information by an IOFactory.
Definition IOFactory.h:105