API Documentation
Loading...
Searching...
No Matches
PDFFactory.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: 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;
41 /**--------------------------------------------------------------------------------------------------
42 \brief Writes to a PDF file using the IOFactory interface.
43 **/
44 class PDFFactory : public IOFactory
45 {
46 public:
48 void setDrawGrid(bool draw_grid);
49 void setTitle(const String& title, const String& subject);
50 void setMargins(uint04 margins);
51 virtual void setdpi(fltp08 dpi);
52 void setDrawBorder(bool border);
53
54 virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models) override;
55 virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
56 virtual bool canRead(const FactoryParameters& file) override;
57 virtual bool canWrite(const FactoryParameters& file) override;
58 virtual bool canWrite(const FileFormat& file) override;
59 virtual bool canWrite(const File& file) override;
60
61 virtual bool readFile(FactoryParameters& file) override;
62 virtual bool writeFile(FactoryParameters& file) override;
63 virtual bool writeFile(const FactoryParameters& file, const DesignObjectLookup* lookup, const Buffer<UUID>& objects_to_write, const Buffer<UUID>& cameras, const FactoryOptions& options);
64 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
66 protected:
73 };
74
75};
76
#define PDF_API
Definition DLLInfo.h:57
The equivelent of std::vector but with a bit more control. The basic array unit of the library.
Definition Buffer.hpp:56
A core class where all Design Objects including models, materials, and geometries are stored....
Definition DesignObjectLookup.h:65
Allows IOFactories to report what features they support to make the import/export dialogs easier to s...
Definition FactoryFeatures.h:44
User-defined options that define preferences for importing and exporting using IOFactory objects.
Definition FactoryOptions.h:49
Data that describes a particular file format and how to use the format with the program....
Definition FileFormat.h:43
Logic for reading or writing to a file as well as navigating filesystems.
Definition File.h:48
A service that provides Import/Export functionality for a model heirarchy. These can be registered wi...
Definition IOFactory.h:117
Writes to a PDF file using the IOFactory interface.
Definition PDFFactory.h:45
virtual bool canRead(const FactoryParameters &file) override
void setTitle(const String &title, const String &subject)
fltp08 m_dpi
Definition PDFFactory.h:72
virtual bool readFile(FactoryParameters &file) override
void setDrawGrid(bool draw_grid)
void setDrawBorder(bool border)
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
uint04 m_margins
Definition PDFFactory.h:69
bool m_draw_grid
Definition PDFFactory.h:70
virtual bool writeFile(FactoryParameters &file) override
String m_title
Definition PDFFactory.h:67
virtual bool canWrite(const FileFormat &file) override
virtual bool canWrite(const File &file) override
void setMargins(uint04 margins)
bool m_draw_border
Definition PDFFactory.h:71
virtual bool writeFile(const FactoryParameters &file, const DesignObjectLookup *lookup, const Buffer< UUID > &objects_to_write, const Buffer< UUID > &cameras, const FactoryOptions &options)
virtual void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
virtual void getSupportedFormats(Buffer< FileFormat > &formats, DesignObjectLookup *lookup, const Buffer< UUID > &models) override
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const override
virtual bool canWrite(const FactoryParameters &file) override
virtual void setdpi(fltp08 dpi)
String m_subject
Definition PDFFactory.h:68
The core String class for the NDEVR API.
Definition String.h:69
Definition ACIColor.h:37
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...
Definition BaseValues.hpp:96
double fltp08
Defines an alias representing an 8 byte floating-point number.
Definition BaseValues.hpp:149
A container of input information that is to be filled with output information by an IOFactory.
Definition IOFactory.h:61