Unigine.Export Class

Export Class

Members

---

Export ( ) #

Constructor. Creates an exporter with default settings.

void RegisterExporter ( const char * type_name, ICollection<string> & extensions ) #

Registers a new exporter with a given name for the specified list of file extensions.

Arguments

• const char * type_name - Exporter type name.
• ICollection<string> & extensions - List of file extensions for which the specified Exporter is to be used.

Exporter * CreateExporter ( const char* type_name ) #

Creates a new exporter of the specified type.

Arguments

• const char* type_name - Exporter type name.

Return value

Pointer to a new created exporter of a given type, if it was created successfully; otherwise, nullptr.

Exporter * CreateExporterByFileName ( const char* file_name ) #

Creates an exporter for the output file with a given name by its extension, if such an exporter was previously registered.

Arguments

• const char* file_name - Name of the output file containing the data to be exported.

Return value

Pointer to the exporter, if it was successfully created for the file with a given name; otherwise, nullptr.

ICollection<string> & GetExporterTypes ( ) #

Returns the list of all exporter types registered by the Export Manager.

Return value

List of all exporter types registered by the Export Manager as a vector of strings.

void GetExporterTypes ( ICollection<string> & types ) #

Returns the list of all exporter types registered by the Export Manager and puts it to the given vector.

Arguments

• ICollection<string> & types - Vector to put the list of all registered exporter types to.

bool IsSupportedExtension ( const char* extension ) #

Returns a value indicating whether the specified file extension is supported by the exporter.

Arguments

• const char* extension - Null-terminated string with file extension to be checked.

Return value

true if the specified file extension is supported by the exporter; otherwise, false.

ICollection<string> & getSupportedExtensions ( ) #

Returns the list of all supported file extensions as a vector of strings.

Return value

List of all supported extensions as a vector of strings.

void GetSupportedExtensions ( ICollection<string> & extensions ) #

Returns the list of all supported file extensions and puts it to the given vector.

Arguments

• ICollection<string> & extensions - Vector to put the list of all supported extensions to.

String getExporterTypeByExtension ( const char* extension ) #

Returns the type of exporter for the specified extension.

Arguments

• const char* extension - Null-terminated string with file extension.

Return value

Type of exporter for the specified extension, if it exists, as a string; otherwise, null string.

bool DoExport ( const NodePtr& root_node, const char* output_filepath ) #

Creates an exporter and then exports the node to the specified output file.

Arguments

• const NodePtr& root_node - Root node of the hierarchy to be exported.
• const char* output_filepath - Output path to be used to store generated file(s) with exported data.

Return value

true if the file is exported successfully; otherwise, false.