This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
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
Content Creation
Content Optimization
Materials
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Import 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.

This is an import manager class. It is used to create and manage importers, processors as well as to directly import files in non-native formats, if an importer for such files was previously registered.

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

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

Import Class

Members


Importer CreateImporter ( string type_name ) #

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

Arguments

  • string type_name - Importer type name.

Return value

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

Importer CreateImporterByFileName ( string file_name ) #

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

Arguments

  • string file_name - Name of the input file containing the data to be imported.

Return value

bool IsSupportedExtension ( const char * extension ) #

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

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 importer; otherwise, false.

Vector<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 GetImporterTypeByExtension ( const char * extension ) #

Returns the type of importer for the specified extension.

Arguments

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

Return value

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

void GetImporterTypes ( ICollection<string> & types ) #

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

Arguments

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

ICollection<string> & GetImporterTypes ( ) #

Returns the list of all importer types registered by the Import Manager.

Return value

List of all importer types registered by the Import Manager as a vector of strings.

string DoImport ( string filepath, string output_path ) #

Imports the contents from the specified input file to the specified output path and returns the path to the resulting output file.

Arguments

  • string filepath - Path to an input file containing the data to be imported.
  • string output_path - Output path to be used to store generated file(s) with imported data.

Return value

Path to the resulting output file.
Last update: 2021-04-29
Build: ()