Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::Parasolid::File Class Reference

The File class provides functions to import and export CAD files via the Parasolid interface. More...

#include <sprk_parasolid.h>

Static Public Member Functions

static ImportNotifier Import (char const *in_file_name, ImportOptionsKit const &in_options)
 Performs an asynchronous import of the specified CAD file with the provided options. More...
 
static ImportNotifier Import (EntityArray const &in_parts, FacetTessellationKit const &in_facet_options, LineTessellationKit const &in_line_options)
 Performs an asynchronous import of the specified entities. More...
 
static void Export (CADModel const &in_cad_model, char const *in_file_name, ExportOptionsKit const &in_options)
 Performs a synchronous export of the given CADModel with the provided options to a given filename. More...
 

Private Member Functions

 File ()
 Private default constructor to prevent instantiation. More...
 

Detailed Description

The File class provides functions to import and export CAD files via the Parasolid interface.

Constructor & Destructor Documentation

◆ File()

HPS::Parasolid::File::File ( )
private

Private default constructor to prevent instantiation.

Member Function Documentation

◆ Export()

static void HPS::Parasolid::File::Export ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportOptionsKit const &  in_options 
)
static

Performs a synchronous export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe CADModel containing the data to export. This CADModel must have come from a CAD file imported via Parasolid, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the Parasolid data to.
in_optionsThe options controlling the export of the Parasolid data.

◆ Import() [1/2]

static ImportNotifier HPS::Parasolid::File::Import ( char const *  in_file_name,
ImportOptionsKit const &  in_options 
)
static

Performs an asynchronous import of the specified CAD file with the provided options.

May throw an IOException prior to starting the asynchronous import.

Parameters
in_file_nameThe name of the CAD file to import.
in_optionsThe options controlling the import of the CAD file.
Returns
An ImportNotfier object that can be used to query the import progress and status.

◆ Import() [2/2]

static ImportNotifier HPS::Parasolid::File::Import ( EntityArray const &  in_parts,
FacetTessellationKit const &  in_facet_options,
LineTessellationKit const &  in_line_options 
)
static

Performs an asynchronous import of the specified entities.

May throw an IOException prior to starting the asynchronous import.

Parameters
in_partsAn array of PK_PART_t entities to import.
in_facet_optionsThe options controlling the import of facets in the CAD file.
in_line_optionsThe options controlling the import of lines in the CAD file.
Returns
An ImportNotfier object that can be used to query the import progress and status.

The documentation for this class was generated from the following file: