API Documentation
Loading...
Searching...
No Matches
ModelFactory.h
Go to the documentation of this file.
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: ModelFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/IOFactory.h>
34#include <NDEVR/File.h>
35#include <NDEVR/FactoryOptions.h>
36namespace NDEVR
37{
39 {
40 protected:
43 public:
44 static ModelFactory& DefaultFactory();
45 virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
46 virtual void getSupportedFormats(Buffer<FileFormat>& formats, const File& file) override { IOFactory::getSupportedFormats(formats, file); };
47 virtual void getSupportedFormatsByModelType(Buffer<FileFormat>& formats, bool is_read, const String& model_type) override;
48 virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models) override;
49 virtual String getIcon(const File& file) override;
50 virtual bool canRead(const FactoryParameters& file) override;
51 virtual bool canWrite(const FactoryParameters& file) override;
52 virtual bool determineExtension(const File& file, String& extension) override;
53 virtual FactoryOptions defaultReadOptions(const FactoryParameters& file) const override;
54 virtual FactoryOptions defaultWriteOptions(const FactoryParameters& file) const override;
55 virtual Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
56 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
57 virtual bool canRead(const File& file) override;
58 virtual bool canWrite(const File& file) override;
59 virtual bool readFile(FactoryParameters& file) override;
60 virtual bool updateFromFile(const FactoryParameters& file, const FactoryOptions& old_options) override;
61 virtual bool writeFile(FactoryParameters& file) override;
62 void addFactory(IOFactory* factory);
63 void addFactory(String extension, IOFactory* factory);
64 void enableExtension(String extension, const String& read_password, const String& write_password);
65 void enableFactory(IOFactory* factory, const String& read_password, const String& write_password);
66 void enableFactory(const String& factory, const String& read_password, const String& write_password);
67 void clearFactories();
68 protected:
74 };
75}
#define NDEVR_FACTORY_API
Definition DLLInfo.h:79
The equivelent of std::vector but with a bit more control. The basic array unit of the library.
Definition Buffer.hpp:64
Definition DesignObjectLookup.h:61
Definition Dictionary.h:48
Definition FactoryFeatures.h:40
Definition FactoryOptions.h:46
Definition FileFormat.h:38
Definition File.h:47
Definition IOFactory.h:99
Definition ModelFactory.h:39
Dictionary< String, String > m_extension_read_passwords
Definition ModelFactory.h:72
Dictionary< String, IOFactory * > m_named_factories
Definition ModelFactory.h:71
virtual void getSupportedFormats(Buffer< FileFormat > &formats, const File &file) override
Definition ModelFactory.h:46
Buffer< IOFactory * > * m_factory_objects
Definition ModelFactory.h:69
Dictionary< String, String > m_extension_write_passwords
Definition ModelFactory.h:73
Dictionary< String, IOFactory * > m_extension_factories
Definition ModelFactory.h:70
Definition String.h:40
Definition ACIColor.h:37
Definition IOFactory.h:56