HPS::OBJ::File

class HPS.OBJ.File : public IDisposable 

The File class provides functions to import and export OBJ files.

Public Functions

void Dispose ()

File (HPS.OBJ.File in_that)

Public Static Functions

HPS.OBJ.ExportNotifier Export (string in_file_name, HPS.KeyPath in_key_path_to_export)

Performs an asynchronous export of the specified key path to an OBJ file. May throw IOException in case of errors.

Param in_file_name: Name of OBJ file to export.
Param in_key_path_to_export: KeyPath from the segment where to start the export to the WindowKey. When using Sprocket, if you wish to export the Model, construct a SprocketPath and pass the KeyPath obtained from its GetKeyPath() method.
Return: An ExportNotfier object that can be used to query the export progress and status.

HPS.OBJ.ImportNotifier Import (string in_file_name, HPS.OBJ.ImportOptionsKit in_options)

Performs an asynchronous import of the specified OBJ file with the provided options. May throw an IOException prior to starting the asynchronous import.

Param in_file_name: Name of OBJ file to import.
Param in_options: Options controlling the import of the OBJ file (e.g., segment to import into).
Return: An ImportNotfier object that can be used to query the import progress and status.