HPS::HCA::File

class HPS.HCA.File : public IDisposable 

The File class provides functions to import Stream Cache files.

Public Functions

void Dispose ()

File (HPS.HCA.File in_that)

Public Static Functions

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

Performs an asynchronous local import of the specified Stream Cache file with the provided options. May throw an IOException prior to starting the asynchronous import. After the import has started it will take place on a separate thread. The status of the import can be checked using the returned ImportNotifier. It is possible to wait for the import to complete by using the Wait method from the returned ImportNotifier. While it is possible to interact with the scene’s camera even before the model has fully finished loading, attempting to select the model, highlight it, hide, isolate or show parts of it while it is being loaded will result in an exception being thrown.

Param in_file_name: The name of the file to import.
Param in_options: The options controlling the import of the Stream Cache file.
Return: An ImportNotifier object that can be used to query the import progress and status.

HPS.HCA.ImportNotifier Import (string in_file_name, HPS.HCA.NetworkImportOptionsKit in_options)

Performs an asynchronous import of the specified Stream Cache file with the provided options over the network. May throw an IOException prior to starting the asynchronous import. After the import has started it will take place on a separate thread. The Wait method from the returned ImportNotifier can be used to wait for the minimum necessary model data is imported. Once Wait returns, it is safe to interact with the model, even as geometry continues to stream in. Attempting to select, highlight, isolate, hide, or show parts of the model before Wait returns can result in an exception being thrown.

Param in_file_name: The name of the file to import.
Param in_options: The options controlling the import of the Stream Cache file.
Return: An ImportNotifier object that can be used to query the import progress and status.