Unigine::Import Class

Import Class

Members

---

bool isInitialized ( ) #

Returns a value indicating if the import manager is initialized;.

Return value

true if the import manager is initialized; otherwise, false.

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

Returns a value indicating if there is an importer with the specified name and vendor name available for processing files with the specified extension.

Arguments

• const Import::ImporterID & id - ImporterID structure.
• const char * extension - Extension of files supported by the importer.

Return value

true if there is an importer with the specified ID available for processing files with the specified extension; otherwise, false.

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

Returns a value indicating if there is an importer with the specified name and vendor name available for processing files with the specified extension.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * importer_name - Importer name.
• const char * extension - Extension of files supported by the importer.

Return value

true if there is an importer with the specified name and vendor name available for processing files with the specified extension; otherwise, false.

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 - ImporterID structure.
• const char * extension - Extension of files supported by the importer.
• ImporterCreationFunction creation_func - Importer creation function having the following signature:
  Source code (C++)

  Importer * (*)(void *args)

  .
• ImporterDeletionFunction deletion_func - Importer removal function having the following signature:
  Source code (C++)

  void (*)(Importer *importer, void *args)

  .
• const char * args - List of importer arguments.
• int int - Priority of the importer for processing files with the specified extension.

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 of files supported by the importer.
• ImporterCreationFunction creation_func - Importer creation function having the following signature:
  Source code (C++)

  Importer * (*)(void *args)

  .
• ImporterDeletionFunction deletion_func - Importer removal function having the following signature:
  Source code (C++)

  void (*)(Importer *importer, void *args)

  .
• const char * args - List of importer arguments.
• int int - Priority of the importer for processing files with the specified extension.

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

Returns a priority for the importer with the specified ID for processing files with the specified extension.

Arguments

• const Import::ImporterID & id - ImporterID structure.
• const char * extension - Extension of a file to be imported.

Return value

Priority of the importer with the specified ID for the specified extension.

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

Returns a priority for the importer with the specified name and vendor name for processing files with the specified extension.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * importer_name - Importer name.
• const char * extension - Extension of a file to be imported.

Return value

Priority of the importer with the specified name and vendor name for the specified extension.

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 ( ) 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.

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

Returns the list of all extensions supported by an importer with the specified name and vendor name.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * importer_name - Importer name.

Return value

List of all extensions supported by an importer with the specified name and vendor name.

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

Returns the list of all extensions supported by an importer with the specified ID.

Arguments

• const Import::ImporterID & id - ImporterID structure.

Return value

List of all extensions supported by an importer with the specified ID.

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

Returns the list of identifiers (ImporterID) of importers available for processing files with the specified extension.

Arguments

• const char * extension - Extension of files to be imported.
• bool sort_by_priority - Set true if you want to sort importers by the priority value; otherwise, set false.

Return value

List of identifiers (ImporterID structures) of importers available for the specified extension.

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

Returns the list of identifiers (ImporterID) of importers from the specified vendor available for processing files with the specified extension.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * extension - Extension of files to be imported.
• bool sort_by_priority - Set true if you want to sort importers by the priority value; otherwise, set false.

Return value

List of identifiers (ImporterID structures) of importers from the specified vendor available for the specified extension.

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

Returns the list of identifiers (ImporterID) of importers with the specified ID for processing files with the specified extension.

Arguments

• const Import::ImporterID & id - ImporterID structure.
• const char * extension - Extension of files to be imported.
• bool sort_by_priority - Set true if you want to sort importers by the priority value; otherwise, set false.

Return value

List of identifiers (ImporterID structures) of importers with the specified ID for the specified extension.

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

Returns the list of identifiers (ImporterID) of importers with the specified name and vendor name for processing files with the specified extension.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * importer_name - Importer name.
• const char * extension - Extension of files to be imported.
• bool sort_by_priority - Set true if you want to sort importers by the priority value; otherwise, set false.

Return value

List of identifiers (ImporterID structures) of importers with the specified name and vendor name for the specified extension.

Vector<Import::ImporterID> getImporterIDs ( ) #

Returns the list of identifiers (ImporterID structures) of all available importers.

Return value

List of identifiers (ImporterID structures) of all available importers.

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

Creates an importer with the specified ID for processing files with the specified extension.

Arguments

• const Import::ImporterID & id - ImporterID structure.
• const char * extension - Extension of files to be imported.

Return value

New created importer with the specified ID for processing files with the specified extension (if it was created successfully).

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

Creates an importer with the specified name and vendor name for processing files with the specified extension.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * importer_name - Importer name.
• const char * extension - Extension of files to be imported.

Return value

New created importer with the specified name and vendor name for processing files with the specified extension (if it was created successfully).

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

Creates an importer for processing the specified file based on the extension provided.

Arguments

• const char * filename - Name of the file to be imported.

Return value

New created importer for processing files with the specified extension (if it was created successfully).

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

Creates an importer with the specified vendor name for processing the specified file based on the extension provided.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * filename - Name of the file to be imported.

Return value

New created importer with the specified vendor name for processing the specified file based on the extension provided (if it was created successfully).

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

Creates an importer with the specified ID for processing the specified file based on the extension provided.

Arguments

• const Import::ImporterID & id - ImporterID structure.
• const char * filename - Name of the file to be imported.

Return value

New created importer with the specified ID for processing the specified file based on the extension provided (if it was created successfully).

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

Creates an importer with the specified name and vendor name for processing the specified file based on the extension provided.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * importer_name - Importer name.
• const char * filename - Name of the file to be imported.

Return value

New created importer with the specified name and vendor name for processing the specified file based on the extension provided (if it was created successfully).

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

Imports the contents from the specified input file to the specified output path using a suitable importer. This method returns the path to the resulting output file.

Arguments

• const char * filepath - Path to an input file to be imported.
• const char * output_path - Output path to be used to put files with imported scene elements to.

Return value

Path to the resulting output file.

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

Imports the contents from the specified input file to the specified output path using a suitable importer from the specified vendor. This method returns the path to the resulting output file.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * filepath - Path to an input file to be imported.
• const char * output_path - Output path to be used to put files with imported scene elements to.

Return value

Path to the resulting output file.

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

Imports the contents from the specified input file to the specified output path using the importer with the specified ID. This method returns the path to the resulting output file.

Arguments

• const Import::ImporterID & id - ImporterID structure.
• const char * filepath - Path to an input file to be imported.
• const char * output_path - Output path to be used to put files with imported scene elements to.

Return value

Path to the resulting output file.

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

Imports the contents from the specified input file to the specified output path using the importer with the specified name and vendor name. This method returns the path to the resulting output file.

Arguments

• const char * vendor_name - Importer vendor name.
• const char * importer_name - Importer name.
• const char * filepath - Path to an input file to be imported.
• const char * output_path - Output path to be used to put files with imported scene elements to.

Return value

Path to the resulting output file.

bool containsImportProcessor ( const char * type_name ) #

Returns a value indicating if there is an import processor with the specified type name available.

Arguments

• const char * type_name - Import processor type name.

Return value

true if there is an import processor with the specified type name available; otherwise, false.

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

Creates a new import processor of the specified type.

Arguments

• const char * type_name - Import processor type name.

Return value

New created import processor with the specified type name (if it was created successfully).

static void * registerImportProcessor ( const char * type_name, ImportProcessorCreationFunction creation_func, ImportProcessorDeletionFunction deletion_func, void * args = nullptr ) #

Registers a new import processor with the specified parameters.

Arguments

• const char * type_name - Import processor type name.
• ImportProcessorCreationFunction creation_func - Import processor creation function having the following signature:
  Source code (C++)

  ImportProcessor * (*)(void *args)

  .
• ImportProcessorDeletionFunction deletion_func - Import processor removal function having the following signature:
  Source code (C++)

  void (*)(ImportProcessor *processor, void *args);

  .
• void * args - Import processor arguments.

Return value

Import processor handle, if it was registered successfully; otherwise, nullptr.

bool unregisterImportProcessor ( void * handle ) #

Unregisters the specified import processor.

Arguments

• void * handle - Import processor handle.

Return value

true if the specified import processor was successfully unregistered; otherwise false.