HPS.Publish.File

class HPS.Publish.File : public IDisposable 

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

Public Static Functions

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.

Return: A DocumentKey handle for the in-memory PDF document.

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.

Param 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.
Return: A DocumentKey handle for the in-memory PDF document.

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

Warning

This feature is only supported on 64bit builds of HOOPS Visualize. An InvalidOperationException will be thrown if this function is used on 32bit builds. This will create an HTML page using the provided template. An exception will be thrown if a problem is encountered during export.

Param in_cad_model: The CADModel containing the data to export.
Param 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.
Param 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.
Param in_template_name: The name of HTML template to use during export.
Param 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.

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.

Warning

This feature is only supported on 64bit builds of HOOPS Visualize. An InvalidOperationException will be thrown if this function is used on 32bit builds. This will create an HTML page using the provided template. An exception will be thrown if a problem is encountered during export.

Param in_cad_model: The CADModel containing the data to export.
Param 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.
Param in_template_name: The name of HTML template to use during export.
Param 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.

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.

Warning

This feature is only supported on 64bit builds of HOOPS Visualize. An InvalidOperationException will be thrown if this function is used on 32bit builds. This will create an HTML page using the provided template. An exception will be thrown if a problem is encountered during export.

Param in_key_path: The KeyPath containing the data to export.
Param 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.
Param in_template_name: The name of HTML template to use during export.

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.

Warning

This feature is only supported on 64bit builds of HOOPS Visualize. An InvalidOperationException will be thrown if this function is used on 32bit builds. This will create an HTML page using the provided template. An exception will be thrown if a problem is encountered during export.

Param in_key_paths: The KeyPaths containing the data to export.
Param 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.
Param in_template_name: The name of HTML template to use during export.

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.

Param in_cad_model: The CADModel containing the data to export.
Param 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.
Param 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.
Param in_options: The options controlling the export of the 3D PDF data.

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.

Param in_cad_model: The CADModel containing the data to export.
Param 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.
Param in_options: The options controlling the export of the 3D PDF data.

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.

Param in_key_path: The KeyPath containing the data to export.
Param 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.
Param in_options: The options controlling the export of the 3D PDF data.

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.

Param in_key_paths: The KeyPaths containing the data to export.
Param 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.
Param in_options: The options controlling the export of the 3D PDF data.

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.

Param 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.
Param 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.
Param in_options: The options controlling the export of the 3D PDF data.

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.

Param in_document: The DocumentKey from which to create a PDF file on disk.
Param 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.

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.

Param 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.
Param 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.
Param in_options: The options controlling the export of the 3D PDF data.