#include <sprk_publish.h>
The File class provides functions to export Model objects to 3D PDFs via Publish.
static DocumentKey HPS::Publish::File::CreateDocument |
( |
char const * |
in_file_name = nullptr | ) |
|
|
static |
Creates a DocumentKey based on the given PDF file. The returned object will allow direct interaction with the underlying in-memory copy of that PDF document and any pages in it. If no filename is specified, an empty PDF document will be created. The in-memory PDF document can be written to disk via the File::Export function.
- Parameters
-
in_file_name | The name of the PDF file from which to create an in-memory copy. Defaults to nullptr, which results in an empty in-memory PDF document. |
- Returns
- A DocumentKey handle for the in-memory PDF document.
Performs a synchronous Publish export of the given SprocketPath with the provided options to a given filename. This will create a single page PDF document with a single 3D annotation. An exception will be thrown if a problem is encountered during export.
- Parameters
-
in_source | The SprocketPath containing the data to export. If the Model in the SprocketPath corresponds to a CADModel which was imported via Exchange, the underlying Exchange data for the CADModel will be embedded in the PDF, otherwise, the 3D data will be generated from the tessellation in the Visualize scene graph for the Model. |
in_file_name | The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail. |
in_options | The options controlling the export of the 3D PDF data. |
Performs a synchronous Publish export of the given AnnotationKit with the provided options to a given filename. This will create a single page PDF document with a single 3D annotation. An exception will be thrown if a problem is encountered during export.
- Parameters
-
in_annotation | The AnnotationKit containing the data to export. If the Model in the source SprocketPath for the AnnotationKit corresponds to a CADModel which was imported via Exchange, the underlying Exchange data for the CADModel will be embedded in the PDF, otherwise, the 3D data will be generated from the tessellation in the Visualize scene graph for the Model. |
in_file_name | The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail. |
in_options | The options controlling the export of the 3D PDF data. |
static void HPS::Publish::File::Export |
( |
DocumentKit const & |
in_document, |
|
|
char const * |
in_file_name, |
|
|
ExportOptionsKit const & |
in_options |
|
) |
| |
|
static |
Performs a synchronous Publish export of the given DocumentKit with the provided options to a given filename. This will create a PDF document based on the DocumentKit. An exception will be thrown if a problem is encountered during export.
- Parameters
-
in_document | The DocumentKit containing the data to export. If any Model in the source SprocketPath for any AnnotationKit in the DocumentKit corresponds to a CADModel which was imported via Exchange, the underlying Exchange data for the CADModel will be embedded in the PDF, otherwise, the 3D data will be generated from the tessellation in the Visualize scene graph for the Model. |
in_file_name | The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail. |
in_options | The options controlling the export of the 3D PDF data. |
static void HPS::Publish::File::Export |
( |
DocumentKey const & |
in_document, |
|
|
char const * |
in_file_name |
|
) |
| |
|
static |
Performs a synchronous Publish export of the given DocumentKey to a given filename. This will not close the PDF document underlying the DocumentKey, rather it will just create a copy of it on disk. The DocumentKey can still be used after this call to interact with the in-memory PDF document.
- Parameters
-
in_document | The DocumentKey from which to create a PDF file on disk. |
in_file_name | The name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail. |
The documentation for this class was generated from the following file: