The File class provides functions to export Model objects to 3D PDFs via Publish. More...

Public Member Functions | |
virtual void | Dispose () |
File (HPS.Publish.File in_that) | |
Static Public Member Functions | |
static HPS.Publish.DocumentKey | CreateDocument (string in_file_name) |
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. More... | |
static HPS.Publish.DocumentKey | CreateDocument () |
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. More... | |
static void | Export (HPS.CADModel in_cad_model, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
Performs a synchronous Publish export of the given CAD Model 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. More... | |
static void | Export (HPS.KeyPath[] in_key_paths, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
Performs a synchronous Publish export of the given KeyPathArray 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. More... | |
static void | Export (HPS.KeyPath in_key_path, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
Performs a synchronous Publish export of the given KeyPath 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. More... | |
static void | Export (HPS.CADModel in_cad_model, HPS.KeyPath[] in_additional_key_paths, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
Performs a synchronous Publish export of the given CAD Model 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. More... | |
static void | Export (HPS.Publish.AnnotationKit in_annotation, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
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. More... | |
static void | Export (HPS.Publish.DocumentKit in_document, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
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. More... | |
static void | Export (HPS.Publish.DocumentKey in_document, string in_file_name) |
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. More... | |
static void | ExportHTML (HPS.CADModel in_cad_model, string in_file_name, string in_template_name, bool in_include_measurement_information) |
Performs a synchronous Publish export of the given CAD Model with the provided options to a given filename. More... | |
static void | ExportHTML (HPS.KeyPath[] in_key_paths, string in_file_name, string in_template_name) |
Performs a synchronous Publish export of the given KeyPathArray with the provided options to a given filename. More... | |
static void | ExportHTML (HPS.KeyPath in_key_path, string in_file_name, string in_template_name) |
Performs a synchronous Publish export of the given KeyPath with the provided options to a given filename. More... | |
static void | ExportHTML (HPS.CADModel in_cad_model, HPS.KeyPath[] in_additional_key_paths, string in_file_name, string in_template_name, bool in_include_measurement_information) |
Performs a synchronous Publish export of the given CAD Model with the provided options to a given filename More... | |
static void | ExportPDF (HPS.CADModel in_cad_model, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
Performs a synchronous Publish export of the given CAD Model 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. More... | |
static void | ExportPDF (HPS.KeyPath[] in_key_paths, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
Performs a synchronous Publish export of the given KeyPathArray 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. More... | |
static void | ExportPDF (HPS.KeyPath in_key_path, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
Performs a synchronous Publish export of the given KeyPath 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. More... | |
static void | ExportPDF (HPS.CADModel in_cad_model, HPS.KeyPath[] in_additional_key_paths, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
Performs a synchronous Publish export of the given CAD Model 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. More... | |
static void | ExportPDF (HPS.Publish.AnnotationKit in_annotation, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
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. More... | |
static void | ExportPDF (HPS.Publish.DocumentKit in_document, string in_file_name, HPS.Publish.ExportOptionsKit in_options) |
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. More... | |
static void | ExportPDF (HPS.Publish.DocumentKey in_document, string in_file_name) |
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. More... | |
Protected Member Functions | |
virtual void | deleteCptr () |
Protected Attributes | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
Member Function Documentation
|
inlinestatic |
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.
|
inlinestatic |
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.
- Returns
- A DocumentKey handle for the in-memory PDF document.
|
inlinestatic |
Performs a synchronous Publish export of the given CAD Model 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.
- Deprecated:
- This function has been superseded by ExportPDF. in_cad_modelThe CADModel containing the data to export. in_file_nameThe 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_optionsThe options controlling the export of the 3D PDF data.
|
inlinestatic |
Performs a synchronous Publish export of the given KeyPathArray 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.
- Deprecated:
- This function has been superseded by ExportPDF. in_key_pathsThe KeyPaths containing the data to export. in_file_nameThe 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_optionsThe options controlling the export of the 3D PDF data.
|
inlinestatic |
Performs a synchronous Publish export of the given KeyPath 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.
- Deprecated:
- This function has been superseded by ExportPDF. in_key_pathThe KeyPath containing the data to export. in_file_nameThe 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_optionsThe options controlling the export of the 3D PDF data.
|
inlinestatic |
Performs a synchronous Publish export of the given CAD Model 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.
- Deprecated:
- This function has been superseded by ExportPDF. in_cad_modelThe CADModel containing the data to export. in_additional_key_pathsAn array of KeyPaths for which PRC data will be created and which will be added to in_cad_model during export. Use this parameter to specify non-Exchange data you have added to the scene which you want to export. in_file_nameThe 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_optionsThe options controlling the export of the 3D PDF data.
|
inlinestatic |
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.
- Deprecated:
- This function has been superseded by ExportPDF. in_annotationThe 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_nameThe 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_optionsThe options controlling the export of the 3D PDF data.
|
inlinestatic |
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.
- Deprecated:
- This function has been superseded by ExportPDF. in_documentThe 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_nameThe 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_optionsThe options controlling the export of the 3D PDF data.
|
inlinestatic |
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.
- Deprecated:
- This function has been superseded by ExportPDF. in_documentThe DocumentKey from which to create a PDF file on disk. in_file_nameThe name of the file to write the 3D PDF data to. This filename should be a fully-qualified path, otherwise the export may fail.
|
inlinestatic |
Performs a synchronous Publish export of the given CAD Model with the provided options to a given filename.
- Parameters
-
in_cad_model The CADModel containing the data to export. in_file_name The name of the file to write the HTML data to. This filename should be a fully-qualified path, otherwise the export may fail. in_template_name The name of HTML template to use during export. in_include_measurement_information Whether to retain information which will allow accurate measurements to be performed on the HTML data if the input CADModel was imported with BRep data.
|
inlinestatic |
Performs a synchronous Publish export of the given KeyPathArray with the provided options to a given filename.
- Parameters
-
in_key_paths The KeyPaths containing the data to export. in_file_name The name of the file to write the HTML data to. This filename should be a fully-qualified path, otherwise the export may fail. in_template_name The name of HTML template to use during export.
|
inlinestatic |
Performs a synchronous Publish export of the given KeyPath with the provided options to a given filename.
- Parameters
-
in_key_path The KeyPath containing the data to export. in_file_name The name of the file to write the HTML data to. This filename should be a fully-qualified path, otherwise the export may fail. in_template_name The name of HTML template to use during export.
|
inlinestatic |
Performs a synchronous Publish export of the given CAD Model with the provided options to a given filename
- Parameters
-
in_cad_model The CADModel containing the data to export. in_additional_key_paths An array of KeyPaths for which PRC data will be created and which will be added to in_cad_model during export. Use this parameter to specify non-Exchange data you have added to the scene which you want to export. in_file_name The name of the file to write the HTML data to. This filename should be a fully-qualified path, otherwise the export may fail. in_template_name The name of HTML template to use during export. in_include_measurement_information Whether to retain information which will allow accurate measurements to be performed on the HTML data if the input CADModel was imported with BRep data.
|
inlinestatic |
Performs a synchronous Publish export of the given CAD Model 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_cad_model The CADModel containing the data to export. 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.
|
inlinestatic |
Performs a synchronous Publish export of the given KeyPathArray 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_key_paths The KeyPaths containing the data to export. 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.
|
inlinestatic |
Performs a synchronous Publish export of the given KeyPath 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_key_path The KeyPath containing the data to export. 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.
|
inlinestatic |
Performs a synchronous Publish export of the given CAD Model 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_cad_model The CADModel containing the data to export. in_additional_key_paths An array of KeyPaths for which PRC data will be created and which will be added to in_cad_model during export. Use this parameter to specify non-Exchange data you have added to the scene which you want to export. 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.
|
inlinestatic |
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.
|
inlinestatic |
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.
|
inlinestatic |
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:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs