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

#include <hps.h>

Static Public Member Functions
static ImportNotifier	Import (char const *in_file_name, ImportOptionsKit const &in_options)
	Performs an asynchronous import of the specified OBJ file with the provided options. More...

static ExportNotifier	Export (char const *in_file_name, HPS::KeyPath const &in_key_path_to_export)
	Performs an asynchronous export of the specified key path to an OBJ file. More...

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

Detailed Description

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

Constructor & Destructor Documentation

HPS::OBJ::File::File ( )

private

Private default constructor to prevent instantiation.

static ExportNotifier HPS::OBJ::File::Export	(	char const *	in_file_name,
		HPS::KeyPath const &	in_key_path_to_export
	)

static

Performs an asynchronous export of the specified key path to an OBJ file.

May throw IOException in case of errors.

Parameters

in_file_name	Name of OBJ file to export.
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.

Returns: An ExportNotfier object that can be used to query the export progress and status.

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

static

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

May throw an IOException prior to starting the asynchronous import.

Parameters

in_file_name	Name of OBJ file to import.
in_options	Options controlling the import of the OBJ file (e.g., segment to import into).

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: