Система экспорта
The Export System allows you to use default plugins and write custom ones to export UNIGINE's nodes to a file of different format and store it on a disk.Система экспорта позволяет вам использовать плагины по умолчанию и писать собственные плагины для экспорта нод UNIGINE в файл другого формата и сохранения его на диске.
The structure of Export System is shown below. It includes Export Manager and a dynamic set of exporters for various external file formats.Структура системы экспорта показана ниже. Он включает в себя диспетчер экспорта и динамический набор экспортеры для различных форматов внешних файлов.
Export Manager is used to create and manage exporters, as well as to directly export files to non-native formats, if an exporter for such files was previously registered.Менеджер экспорта используется для создания экспортеров и управления ими, а также для прямого экспорта файлов в неродные форматы, если ранее был зарегистрирован экспортер для таких файлов.
ExporterЭкспортер#
Exporter is a module used by Export System to transfer UNIGINE's objects to files in various non-native formats. A single exporter can be used to export multiple nodes, but there shouldn't be two or more exporters registered for a single node type.Exporter — это модуль, используемый системой экспорта для передачи объектов UNIGINE в файлы в различных неродных форматах. Один экспортер может использоваться для экспорта нескольких нод, но не должно быть двух или более экспортеров, зарегистрированных для одного типа ноды.
Each exporter has a set of parameters that control the whole export process (e.g., whether to export lights, cameras, and material normal maps, reset root node transformation, etc.). The exporter should be initialized before the use.Каждый экспортер имеет набор параметров, управляющих всем процессом экспорта (например, экспортировать ли источники света, камеры и карты нормалей материалов, сбросить преобразование корневой ноды и т. д.). Экспортер должен быть инициализирован перед использованием.
Basic WorkflowОсновной рабочий процесс#
In order to be used, exporters must be registered in the system via Export Manager. You can manage the list of available modules dynamically by adding them to or removing from the registry. When you export a node to any external format, Export System automatically tries to find and use an appropriate exporter registered for the specified file extension.Для использования экспортеры должны быть зарегистрированы в системе через Export Manager. Вы можете динамически управлять списком доступных модулей, добавляя их в реестр или удаляя из него. Когда вы экспортируете ноду в любой внешний формат, система экспорта автоматически пытается найти и использовать соответствующий экспортер, зарегистрированный для указанного расширения файла.
The basic node export workflow is as follows:Основной рабочий процесс экспорта ноды выглядит следующим образом:
- Check the extension of the specified output file and find the appropriate exporter among the registered ones.Проверьте расширение указанного выходного файла и найдите подходящий экспортер среди зарегистрированных.
- Extract scene data from the node, create the export scene and put the data to the corresponding export structures (e.g., FBX nodes).Извлеките данные сцены из ноды, создайте сцену экспорта и поместите данные в соответствующие структуры экспорта (например, ноды FBX).
- Use the appropriate exporter to generate output files on the basis of scene metadata.Используйте соответствующий экспортер для создания выходных файлов на основе метаданных сцены.
CustomizationНастройка#
You can consider the FbxExporter plugin as an example to build your own custom exporting modules. You can also modify and rebuild this plugin to use your own custom exporter in the Editor.Вы можете рассмотреть плагин FbxExporter в качестве примера для создания собственных пользовательских модулей экспорта. Вы также можете изменить и перестроить этот плагин, чтобы использовать свой собственный экспортер в редакторе.
To use the FbxExporter plugin, just load it via the plugin_load console command or the following command line option on the application start-up:Чтобы использовать плагин FbxExporter, просто загрузите его с помощью консольной команды plugin_load или следующей параметр командной строки при запуске приложения:
-extern_plugin UnigineFbxExporter
In general, the workflow via the C++ API may be represented as follows:В общем виде рабочий процесс через C++ API можно представить следующим образом:
// create an exporter for the exported file ("1.fbx" in our case)
Unigine::Exporter* exporter = Unigine::Export::get()->createExporterByFileName("1.fbx");
// enable the "export_material_normal_maps" parameter
exporter->setParameterInt("export_material_normal_maps", 1);
// initialize exporter
exporter->init();
// get the node
NodePtr node = World::getNodeByName("material_ball");
// export the node to the specified file path
exporter->doExport(node, "1.fbx");
// exporter deinitialization
exporter->deinit();
You can also export a node with default settings simply like this:Вы также можете экспортировать ноду с настройками по умолчанию следующим образом:
// get the node
NodePtr node = World::getNodeByName("material_ball");
// export the node to the file of specified format
Unigine::Export::get()->doExport(node, "../data/1/1.fbx")
Built-in Export OptionsВстроенные параметры экспорта#
The engine's built-in exporters (FbxExporter plugin, UsdExchanger plugin) have a number of export options that customize the exporter's behavior and can also be used in custom exporters.Встроенные экспортеры движка (плагин FbxExporter, плагин UsdExchanger) имеют ряд параметров экспорта, которые настраивают поведение экспортера, а также могут использоваться в пользовательских экспортерах.
Parameter NamesИмена параметров#
The following table lists the names for the parameters available out of the box that can be set via the setParameterInt("name", value) method.В следующей таблице перечислены имена параметров, доступных из коробки, которые можно установить с помощью метода setParameterInt("name", value).
See AlsoСмотрите также#
- FbxExporter plugin as an a example for your custom export plugin: source/plugins/Export/FbxExporter.FbxExporter в качестве примера вашего пользовательского плагина экспорта: source/plugins/Export/FbxExporter.
- UsdExchanger pluginПлагин UsdExchanger
Fbx Export System API:API системы экспорта:
Export Functionality classes for more details on managing the Export System via code.Для получения более подробной информации об управлении системой экспорта с помощью кода обратитесь к статье Классы функциональности экспорта
Export System API is not available for the Community SDK edition.Системное API экспорта недоступно для версии Community SDK.