Unigine.Export Class

Export Class

Members

---

Export ( ) #

Constructor. Creates an exporter with default settings.

Exporter * CreateExporter ( String type_name ) #

Creates a new exporter of the specified type.

Arguments

• String 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 ( String file_name ) #

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

Arguments

• String 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.

bool IsSupportedExporterType ( String type_name ) #

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

Arguments

• String type_name - Null-terminated string with the exporter type to be checked.

Return value

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

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 ( String extension ) #

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

Arguments

• String 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.

ICollection<string> GetSupportedExtensionsByType ( String type_name ) #

Returns the list of all supported file extensions for the specified exporter type as a vector of strings.

Arguments

• String type_name - Exporter type name.

Return value

List of all supported extensions as a vector of strings.

void GetSupportedExtensionsByType ( String type_name, ICollection<string> extensions ) #

Returns the list of all supported file extensions for the specified exporter type and puts it to the given vector.

Arguments

• String type_name - Exporter type name.
• ICollection<string> extensions - Vector to put the list of all supported extensions to.

String getExporterTypeByExtension ( String extension ) #

Returns the type of exporter for the specified extension.

Arguments

• String 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 ( Node root_node, String output_filepath ) #

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

Arguments

• Node root_node - Root node of the hierarchy to be exported.
• String 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.