HPS::HCA::File Class Reference

#include <sprk_hca.h>

Static Public Member Functions

static ImportNotifier Import (char const *in_file_name, ImportOptionsKit const &in_options)
 
static ImportNotifier Import (char const *in_file_name, NetworkImportOptionsKit const &in_options)
 

Detailed Description

The File class provides functions to import Stream Cache files.

Member Function Documentation

◆ Import() [1/2]

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

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.

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

◆ Import() [2/2]

static ImportNotifier HPS::HCA::File::Import ( char const *  in_file_name,
NetworkImportOptionsKit const &  in_options 
)
static

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.

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

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