NDEVR
API Documentation
ImageModelFactory.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: ImageModelFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/IOFactory.h>
34#include <NDEVR/FileFormat.h>
35#if NDEVR_IMAGE_MODEL
36namespace NDEVR
37{
46 class ImageModelFactory : public IOFactory
47 {
48 public:
50 NDEVR_FACTORY_API ImageModelFactory();
51 private:
55 virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
56
60 virtual bool canRead(const File& file) override;
61
65 virtual bool readFile(FactoryParameters& file) override;
66
70 virtual bool writeFile(FactoryParameters& file) override;
71
76 virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models) override;
77
83 virtual Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
84
88 FactoryOptions defaultReadOptions(const FactoryParameters& file) const override;
89
93 FactoryOptions defaultWriteOptions(const FactoryParameters& file) const override;
94
99 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
100 public:
103 static constexpr StringView CustomOptionsLabel() { return "image_options"; }
104
107 static constexpr StringView CustomOptionsCreatePinIfPossible() { return "create_pin_if_possible"; }
108
111 static constexpr StringView CustomOptionsReadMetadata() { return "read_metadata"; }
112
115 static constexpr StringView CustomOptionsJGWFile() { return "jgw_file"; }
116
119 static constexpr StringView CustomOptionsJGWMode() { return "jgw_mode"; }
120 };
121}
122#endif
#define NDEVR_FACTORY_API
GCC/Clang symbol visibility — marks symbols as visible in the shared library.
Definition DLLInfo.h:92
A service that provides Import/Export functionality for a model hierarchy.
Definition IOFactory.h:248
The primary namespace for the NDEVR SDK.