NDEVR
API Documentation
SceneDump.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2020, 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: OpenXLSXInterface
28File: SceneDump
29Included in API: True
30Author(s): tyler.parke
31 *-----------------------------------------------------------------------------------------**/
32
33#pragma once
34#include <NDEVR/IOFactory.h>
35#include <NDEVR/File.h>
36namespace NDEVR
37{
38 class Model;
39 class Log;
40 class FactoryFeatures;
41 class ProgressInfo;
46 class SceneDump : public IOFactory
47 {
48 public:
49 static SceneDump* DefaultFactory();
50 protected:
51 SceneDump();
52 void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) final override;
53 String getIcon(const File & file) final override;
54 bool readFile(FactoryParameters & file) final override;
55 bool canRead(const File& file) final override;
56 bool canWrite(const File& file) final override;
57 bool writeFile(FactoryParameters&) final override;
58 static void DumpScenes(const Set<Scene>& scenes, File file, ProgressInfo& log);
59 bool isAutoEnabled() const final override;
62 Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const final override;
63 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
64 bool determineExtension(const File& file, String & extension) final override;
65 };
66}
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.
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
Used with InfoPipe to signal that the system will be using progress.
FactoryOptions defaultReadOptions(const FactoryParameters &file) const final override
Returns the default read options for the given factory parameters.
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const final override
Returns the default write options for the given factory parameters.
bool canRead(const File &file) final override
Checks whether this factory can read the given file.
bool writeFile(FactoryParameters &) final override
Writes data from the design object hierarchy to a file.
void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) final override
Populates the given buffer with supported file formats for reading or writing.
bool readFile(FactoryParameters &file) final override
Reads data from a file into the design object hierarchy.
bool isAutoEnabled() const final override
Checks whether this factory is automatically enabled without requiring a password.
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) 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 final override
Filters a list of model UUIDs to only those that can be exported in the given format.
bool determineExtension(const File &file, String &extension) final override
Attempts to determine the file extension for the given file.
bool canWrite(const File &file) final override
Checks whether this factory can write the given file.
String getIcon(const File &file) final override
Returns the icon name associated with the given file type.
Container that stores unique elements in no particular order, and which allow for fast retrieval or i...
Definition Set.h:59
The core String class for the NDEVR API.
Definition String.h:95
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer s...
Definition UUID.h:61
The primary namespace for the NDEVR SDK.
@ file
The source file path associated with this object.
A container of input information that is to be filled with output information by an IOFactory.
Definition IOFactory.h:105