NDEVR
API Documentation
PDFFactory.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: OMFFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/IOFactory.h>
35namespace NDEVR
36{
37 class FactoryOptions;
38 class Model;
39 class Log;
40 class FactoryFeatures;
45 class PDFFactory : public IOFactory
46 {
47 public:
49 PDF_API PDFFactory();
52 void setDrawGrid(bool draw_grid);
56 void setTitle(const String& title, const String& subject);
59 void setMargins(uint04 margins);
62 virtual void setdpi(fltp08 dpi);
65 void setDrawBorder(bool border);
66
71 virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models) override;
75 virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
79 virtual bool canRead(const FactoryParameters& file) override;
83 virtual bool canWrite(const FactoryParameters& file) override;
87 virtual bool canWrite(const FileFormat& file) override;
91 virtual bool canWrite(const File& file) override;
92
96 virtual bool readFile(FactoryParameters& file) override;
100 virtual bool writeFile(FactoryParameters& file) override;
108 virtual bool writeFile(const FactoryParameters& file, const DesignObjectLookup* lookup, const Buffer<UUID>& objects_to_write, const Buffer<UUID>& cameras, const FactoryOptions& options);
113 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
120 static constexpr StringView OptionsGroupName() { return "pdf_paper"; }
121 protected:
128 };
129
130};
131
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
String m_subject
The PDF document subject.
Definition PDFFactory.h:123
PDFFactory()
Constructs the PDFFactory.
virtual bool canWrite(const FactoryParameters &file) override
Checks whether the given parameters describe a writable PDF.
virtual bool canWrite(const FileFormat &file) override
Checks whether the given format is writable.
void setMargins(uint04 margins)
Sets the page margins in points.
virtual void getSupportedFormats(Buffer< FileFormat > &formats, DesignObjectLookup *lookup, const Buffer< UUID > &models) override
Populates supported formats filtered by model context.
uint04 m_margins
The page margins in points.
Definition PDFFactory.h:124
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
Returns the supported factory features for the given file.
virtual bool readFile(FactoryParameters &file) override
Reads a PDF file into the design model.
void setDrawGrid(bool draw_grid)
Enables or disables drawing a grid in the PDF output.
bool m_draw_border
Whether to draw a page border.
Definition PDFFactory.h:126
virtual bool writeFile(FactoryParameters &file) override
Writes design data to a PDF file.
bool m_draw_grid
Whether to draw a grid overlay.
Definition PDFFactory.h:125
virtual void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the list of supported PDF file formats.
void setTitle(const String &title, const String &subject)
Sets the title and subject metadata for the PDF.
virtual bool canRead(const FactoryParameters &file) override
Checks whether the given parameters describe a readable PDF.
void setDrawBorder(bool border)
Enables or disables drawing a page border.
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const override
Returns the default write options for PDF export.
String m_title
The PDF document title.
Definition PDFFactory.h:122
virtual bool writeFile(const FactoryParameters &file, const DesignObjectLookup *lookup, const Buffer< UUID > &objects_to_write, const Buffer< UUID > &cameras, const FactoryOptions &options)
Writes specific objects and camera views to a PDF file.
fltp08 m_dpi
The output resolution in dots per inch.
Definition PDFFactory.h:127
static constexpr StringView OptionsGroupName()
Returns the options group name used for PDF paper settings.
Definition PDFFactory.h:120
virtual void setdpi(fltp08 dpi)
Sets the output resolution in dots per inch.
virtual bool canWrite(const File &file) override
Checks whether the given file can be written as PDF.
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.
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...
double fltp08
Defines an alias representing an 8 byte floating-point number.
@ 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