This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
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
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::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.
Header: #include <UnigineImport.h>

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


bool containsImporter ( const Import::ImporterID & id, const char * extension ) #

Arguments

bool containsImporter ( const char * vendor_name, const char * importer_name, const char * extension ) #

Arguments

  • const char * vendor_name
  • const char * importer_name
  • const char * extension

static void * registerImporter ( ImporterID id, const char * extension, ImporterCreationFunction creation_func, ImporterDeletionFunction deletion_func, const char* args = nullptr, int int = 0 ) #

Registers a new importer with the specified parameters.

Arguments

  • ImporterID id - Importer ID.
  • const char * extension - extension.
  • ImporterCreationFunction creation_func - Importer type name.
  • ImporterDeletionFunction deletion_func - Importer type name.
  • const char* args - Importer type name.
  • int int - Priority.

Return value

Importer handle, if it was registered successfully; otherwise, nullptr.

static void * registerImporter ( const char * vendor_name, const char * importer_name, const char * extension, ImporterCreationFunction creation_func, ImporterDeletionFunction deletion_func, const char* args = nullptr, int int = 0 ) #

Registers a new importer with the specified parameters.

Arguments

  • const char * vendor_name - Importer vendor name.
  • const char * importer_name - Name of the importer.
  • const char * extension - extension.
  • ImporterCreationFunction creation_func - Importer type name.
  • ImporterDeletionFunction deletion_func - Importer type name.
  • const char* args - Importer type name.
  • int int - Priority.

Return value

Importer handle, if it was registered successfully; otherwise, nullptr.

bool unregisterImporter ( void * handle ) #

Unregisters the specified importer.

Arguments

  • void * handle - Importer handle.

Return value

true if the specified importer was successfully unregistered; otherwise false.

int getImporterPriority ( const Import::ImporterID & id, const char * extension ) #

Arguments

int getImporterPriority ( const char * vendor_name, const char * importer_name, const char * extension ) #

Arguments

  • const char * vendor_name
  • const char * importer_name
  • const char * extension

bool isSupportedExtension ( const char * extension ) #

Arguments

  • const char * extension

Vector<String> getSupportedExtensions ( ) const#

Vector<String> getImporterExtensions ( const char * vendor_name, const char * importer_name ) #

Arguments

  • const char * vendor_name
  • const char * importer_name

Vector<String> getImporterExtensions ( const Import::ImporterID & id ) #

Arguments

Vector<Import::ImporterID> getImporterIDsByExtension ( const char * extension, bool sort_by_priority = true ) #

Arguments

  • const char * extension
  • bool sort_by_priority

Vector<Import::ImporterID> getImporterIDsByExtension ( const char * vendor_name, const char * extension, bool sort_by_priority = true ) #

Arguments

  • const char * vendor_name
  • const char * extension
  • bool sort_by_priority

Vector<Import::ImporterID> getImporterIDsByExtension ( const Import::ImporterID & id, const char * extension, bool sort_by_priority = true ) #

Arguments

Vector<Import::ImporterID> getImporterIDsByExtension ( const char * vendor_name, const char * importer_name, const char * extension, bool sort_by_priority = true ) #

Arguments

  • const char * vendor_name
  • const char * importer_name
  • const char * extension
  • bool sort_by_priority

Vector<Import::ImporterID> getImporterIDs ( ) #

Ptr<Importer> createImporter ( const Import::ImporterID & id, const char * extension ) #

Arguments

Ptr<Importer> createImporter ( const char * vendor_name, const char * importer_name, const char * extension ) #

Arguments

  • const char * vendor_name
  • const char * importer_name
  • const char * extension

Ptr<Importer> createImporterByFileName ( const char * filename ) #

Arguments

  • const char * filename

Ptr<Importer> createImporterByFileName ( const char * vendor_name, const char * filename ) #

Arguments

  • const char * vendor_name
  • const char * filename

Ptr<Importer> createImporterByFileName ( const Import::ImporterID & id, const char * filename ) #

Arguments

Ptr<Importer> createImporterByFileName ( const char * vendor_name, const char * importer_name, const char * filename ) #

Arguments

  • const char * vendor_name
  • const char * importer_name
  • const char * filename

String doImport ( const char * filepath, const char * output_path ) #

Arguments

  • const char * filepath
  • const char * output_path

String doImport ( const char * vendor_name, const char * filepath, const char * output_path ) #

Arguments

  • const char * vendor_name
  • const char * filepath
  • const char * output_path

String doImport ( const Import::ImporterID & id, const char * filepath, const char * output_path ) #

Arguments

String doImport ( const char * vendor_name, const char * importer_name, const char * filepath, const char * output_path ) #

Arguments

  • const char * vendor_name
  • const char * importer_name
  • const char * filepath
  • const char * output_path

bool containsImportProcessor ( const char * type_name ) #

Arguments

  • const char * type_name

Ptr<ImportProcessor> createImportProcessor ( const char * type_name ) #

Arguments

  • const char * type_name

bool unregisterImportProcessor ( void * handle ) #

Arguments

  • void * handle - Import processor handle.
Last update: 2022-11-28
Build: ()