NDEVR
API Documentation
KMLFactory.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: KMLFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/IOFactory.h>
35#include <NDEVR/FileFormat.h>
36#include <NDEVR/Buffer.h>
37class LASreader;
38namespace NDEVR
39{
40 class File;
41 class Model;
42 class FactoryFeatures;
43 class FactoryOptions;
49 class KMLFactory : public IOFactory
50 {
51 public:
53 KML_INTERFACE_API KMLFactory();
57 KML_INTERFACE_API void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
61 KML_INTERFACE_API bool canRead(const FactoryParameters& file) override;
65 KML_INTERFACE_API bool readFile(FactoryParameters& file) override;
69 KML_INTERFACE_API bool writeFile(FactoryParameters& file) override;
75 Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
80 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
89
92 static constexpr StringView CustomOptionsLabel() { return "kml_options"; }
95 static constexpr StringView PlaceAllOnGround() { return "place_all_on_ground"; }
96 };
97}
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.
FactoryOptions defaultReadOptions(const FactoryParameters &file) const override
Returns the default read options for KML files.
void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the list of supported KML file formats.
bool writeFile(FactoryParameters &file) override
Writes design data to a KML/KMZ file.
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
Returns the supported factory features for the given file.
KMLFactory()
Constructs the KMLFactory.
Buffer< UUID > filterModelsToExport(Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const override
Filters the list of models to only those exportable in KML format.
bool readFile(FactoryParameters &file) override
Reads a KML/KMZ file into the design model.
static constexpr StringView PlaceAllOnGround()
Returns the custom option key for placing all objects on ground level.
Definition KMLFactory.h:95
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const override
Returns the default write options for KML files.
bool canRead(const FactoryParameters &file) override
Checks whether the given parameters describe a readable KML file.
static constexpr StringView CustomOptionsLabel()
Returns the custom options group label key.
Definition KMLFactory.h:92
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 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