UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm (Experimental)
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes

Unigine::Export Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Engineering / Sim SDK edition to use it.
Header: #include <UnigineExport.h>

This is the export manager class. It is used to create and manage exporters.

You can manage the set of available exporters dynamically by adding them to or removing from the registry.

You can also get the list of all currently supported file extensions.

Export Class

Members


static ExportPtr create ( ) #

Constructor. Creates an exporter with default settings.

Export * get ( ) #

Returns a pointer to the Export manager.

Return value

Export manager instance.

void registerExporter ( const char * type_name, const int & extensions ) #

Registers a new exporter with a given name.

Arguments

  • const char * type_name - Exporter type name.
  • const int & extensions

bool unregisterExporter ( const char * type_name ) #

Unregisters the specified exporter type.

Arguments

  • const char * type_name - Exporter type name.

Exporter * createExporter ( const char * type_name ) const#

Creates a new exporter of the specified type.
Notice
The exporter type name specified must be previously registered.

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 ) const#

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.

Vector<String> getExporterTypes ( ) const#

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 ( Vector<String *> & types ) const#

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

Arguments

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

bool isSupportedExtension ( const char * extension ) const#

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.

Vector<String> getSupportedExtensions ( ) const#

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 ( Vector<String> & extensions ) const#

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

Arguments

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

String getExporterTypeByExtension ( const char * extension ) const#

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 ) const#

Arguments

  • const NodePtr & root_node
  • 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.
Last update: 2020-11-25