This page has been translated automatically.
Видеоуроки
Interface
Essentials
Advanced
Подсказки и советы
Основы
Программирование на C#
Рендеринг
Professional (SIM)
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров ноды
Setting Up Materials
Настройка свойств
Освещение
Landscape Tool
Sandworm
Использование инструментов редактора для конкретных задач
Расширение функционала редактора
Встроенные объекты
Ноды (Nodes)
Объекты (Objects)
Эффекты
Декали
Источники света
Geodetics
World-ноды
Звуковые объекты
Объекты поиска пути
Players
Программирование
Основы
Настройка среды разработки
Примеры использования
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Плагины
Форматы файлов
Materials and Shaders
Rebuilding the Engine Tools
GUI
Двойная точность координат
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
Работа с контентом
Оптимизация контента
Материалы
Визуальный редактор материалов
Сэмплы материалов
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Работа с проектами

A project is an independent entity that contains all data on your application content organized in a set of directories. The .project file containing metadata is associated with the project. Проект - это независимый объект, который содержит все данные о содержимом вашего приложения, организованные в наборе каталогов. Файл .project, содержащий метаданные, связан с проектом.

Примечание
One project can consist of several worlds. So, there is no need to create a separate project for each world.Один проект может состоять из нескольких миров . Таким образом, нет необходимости создавать отдельный проект для каждого мира.

Creating New ProjectСоздание нового проекта#

Before starting to create new projects you should have an SDK installed. Once you have the required version of the SDK, you can create a new project as follows:Перед тем, как начать создавать новые проекты, у вас должен быть установлен SDK . Когда у вас будет необходимая версия SDK, вы можете создать новый проект следующим образом:

  1. Open the Projects tab in the SDK browser.

    Откройте вкладку Projects в браузере SDK.

  2. Click Create New. The new project creation window will be opened.Нажмите Create New. Откроется окно создания нового проекта.
  3. Define the name of the project, choose a path to store project files, specify the SDK and UNIGINE Engine build to be used.

    The project will be created in the <project path>/<unigine_project> folder.The project will be created in the <project path>/<unigine_project> folder.

    The project will be created in the <project path>/<unigine_project> folder.
    Определите имя проекта, выберите путь для хранения файлов проекта, укажите SDK и UNIGINE Engine build , которые будут использоваться.

    The project will be created in the <project path>/<unigine_project> folder.Проект будет создан в папке <project path>/<unigine_project>.

  4. Specify the required application and general settings.Укажите необходимое приложение и общие настройки .
  5. Specify the add-ons to be added (optional).Укажите надстройки , которые нужно добавить (необязательно).
  6. Click Create New Project. The project will appear in the projects list.

    Нажмите Create New Project. Проект появится в списке проектов.

Примечание
You can change the project settings any time by clicking Other Actions -> Configure.Вы можете изменить настройки проекта в любое время, нажав Other Actions -> Configure.

Application SettingsНастройки приложения#

The project can be created with the following application settings:Проект может быть создан со следующими настройками приложения:

Template A template that is used as a basis for the project:
  • Empty — no template is used for the project. Empty — no template is used for the project.
  • VR — a template is used to facilitate creation of a custom application for VR. VR — a template is used to facilitate creation of a custom application for VR.
  • IG — a template is used to facilitate creation of a custom Image Generator application. IG — a template is used to facilitate creation of a custom Image Generator application.
Empty — no template is used for the project. VR — a template is used to facilitate creation of a custom application for VR. IG — a template is used to facilitate creation of a custom Image Generator application.
Шаблон, который используется в качестве основы для проекта:
  • Empty — no template is used for the project.Empty - для проекта не используется шаблон.
  • VR — a template is used to facilitate creation of a custom application for VR.VR - шаблон используется для облегчения создания пользовательского приложения для VR .
  • IG — a template is used to facilitate creation of a custom Image Generator application.IG - шаблон используется для облегчения создания пользовательского приложения Image Generator .
API+IDE Programming language to be used for project creation. The following APIs are available: UnigineScript only — UnigineScript will be used to implement the project. C++ — C++ API will be used to implement the project. For a project using a template, one of the following variants should be used depending on the OS: On Windows: C++ (Qt-based) — Qt Creator, QMake, or CMake is required for building the project.
Примечание
App* plugins (AppProjection, AppSurround, AppWall, AppPanorama, and others) cannot be used in Qt-based applications.App* plugins (AppProjection, AppSurround, AppWall, AppPanorama, and others) cannot be used in Qt-based applications.
App* plugins (AppProjection, AppSurround, AppWall, AppPanorama, and others) cannot be used in Qt-based applications.On Linux:
  • C++ GNU Make
C# (.NET 5) — C# API and Component System will be used to implement the project. .NET 5 is required for building the project.
Programming language to be used for project creation. The following APIs are available:
Precision The coordinates precision to be used: Float — single precision Doubledouble precisionИспользуемая точность координат:

FeaturesОбщие настройки#

The project can be created with the following features:Проект может быть создан со следующими общими настройками:

Command-line Runtimes Generator Enables Command-line Runtimes Generator for the project.Включает генератор времени выполнения через командную строку для проекта.
Command-line Build Tool Enables the Command-line Build Tool for the project.Включает инструмент сборки через командную строку для проекта.
Sandworm Distributed & Headless Mode Enables creation of the console application required on Worker computers for distributed computing and headless generation of terrain using the Sandworm tool for the project.Позволяет создать консольное приложение, необходимое на компьютерах Worker для распределенных вычислений и генерации рельефа с помощью инструмента Sandworm для проекта.
Editor Plugin Template

Enables the creation of an editor plugin based on available templates for the project.Позволяет создать плагин редактора на основе доступных шаблонов для проекта.

Примечание
After the plugin template is selected and the project created (or reconfigured), you won't be able to change the template anymore.После выбора шаблона плагина и создания (или изменения конфигурации) проекта вы больше не сможете изменить шаблон.

The Plugins (0) button opens the list of available plugins:Кнопка Plugins (0) открывает список доступных плагинов:

STEREO 3D
Oculus support (AppOculus plugin) Create project with the Oculus Rift virtual display support.Создайте проект с поддержкой виртуального дисплея Oculus Rift .
Dual output stereo 3D (AppSeparate plugin) Output 2 separate images for each eye.
Примечание
The AppSeparate supports DirectX 11 only.The AppSeparate supports DirectX 11 only.
The AppSeparate supports DirectX 11 only.
Выведите 2 отдельных изображения для каждого глаза.
Примечание
The AppSeparate supports DirectX 11 only.AppSeparate поддерживает только DirectX 11 .
Varjo support (AppVarjo plugin) Create project with the Varjo output support.Создайте проект с поддержкой Varjo output.
HTC Vive support (AppVive plugin) Create project with the HTC Vive output support.Создайте проект с поддержкой HTC Vive output .
MULTI-MONITOR
3-monitor output (AppSurround plugin) Render the application across 3 monitors simultaneously.Визуализируйте приложение на 3 мониторах одновременно .
Monitor wall (AppWall plugin) Render the application into the configurable number of monitors.Выполните рендеринг приложения на настраиваемое количество мониторов .
PROJECTIONS
Multi-projector setups (AppProjection plugin) Create a project with the AppProjection plugin. All necessary files are copied and the launcher with the corresponding settings is generated.Создайте проект с помощью плагина AppProjection. Копируются все необходимые файлы и генерируется лаунчер с соответствующими настройками.
EasyBlend support (AppEasyBlend plugin) Create a project with the AppEasyBlend plugin.Создайте проект с помощью плагина AppEasyBlend.
NETWORK
ARTTracker plugin Create a project with the ARTTracker plugin.Создайте проект с помощью плагина ARTTracker .
SSLSocket plugin Create a project with the SSLSocket plugin.Создайте проект с помощью подключаемого модуля SSLSocket .
Steam plugin Create a project with the plugin for Steam integration.Создайте проект с плагином для интеграции со Steam.
Syncker plugin Create a project with the Syncker plugin for multi-channel rendering synchronization.Создайте проект с плагином Syncker для синхронизации многоканального рендеринга.
VRPN Client plugin Create a project with the VRPN Client plugin.Создайте проект с помощью плагина VRPN Client.
SPECIALS
GPU Monitor plugin Enable GPU frequencies and temperature monitoring for your project.Включите мониторинг частоты и температуры графического процессора для вашего проекта.
Interface plugin Create a project with the Interface plugin.Создайте проект с помощью плагина Interface.
Kinect2 Plugin Create a project with the Kinect2 plugin.Создайте проект с помощью плагина Kinect2 .
Leap Motion plugin Tracking hands and fingers with Leap Motion.Отслеживание рук и пальцев с помощью Leap Motion
TeslaSuit plugin Creating sensations, tracing the body motions, and capturing the user's biometrics with Teslasuit.Создание ощущений, отслеживание движений тела и снятие биометрических данных пользователя с помощью Teslasuit.
GEODETIC
Geodetics plugin Plugin that allows translating GPS latitude, longitude, and altitude coordinates to X, Y, and Z and vice versa.Плагин, позволяющий переводить GPS-координаты широты, долготы и высоты в координаты X, Y и Z и наоборот.

Add-OnsДополнения#

The project can be created including any add-on available in the Add-Ons tab. All required add-ons can be added both on and after project's creation.Проект может быть создан, включая любые надстройки, доступные во вкладке Add-Ons. Все необходимые дополнения могут быть добавлены как при создании проекта, так и после него.

Specifying Add-Ons on Project's CreationУказание надстроек при создании проекта#

To create the project with an add-on:Чтобы создать проект с надстройкой:

  1. Download the required add-on in the Add-Ons tab by clicking Install.

    Примечание
    Any amount of add-ons could be added to a project afterwards.Any amount of add-ons could be added to a project afterwards.
    Any amount of add-ons could be added to a project afterwards.
    Загрузите необходимое дополнение во вкладке Add-Ons, нажав Install.

    Примечание
    Any amount of add-ons could be added to a project afterwards.Впоследствии в проект можно было добавить любое количество надстроек.
  2. On the project creation, specify the add-ons to be included by clicking the Add-ons (0) button.

    В проекте creation укажите надстройки, которые нужно включить, нажав кнопку Add-ons (0).

  3. Drag and drop the required add-ons from the Available field to In Use. You can add any amount of add-ons to the project. After all add-ons are dropped, click Ok.

    Примечание
    If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.
    If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.
    Перетащите необходимые дополнения из поля Available в In Use. Вы можете добавить в проект любое количество надстроек. После сброса всех надстроек нажмите Ok.

    Примечание
    If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.Если вы не скачали надстройку, нажмите Manage installed add-ons. Вы будете перенаправлены на страницу с доступными надстройками.
  4. Click Create New Project. To enable added add-ons in the project, you should follow instructions on each add-on.Нажмите Create New Project. Чтобы включить добавленные надстройки в проект, вы должны следовать инструкциям для каждого надстройки .

Specifying Add-Ons for Existing ProjectУказание надстроек для существующего проекта#

To extend an existing project with add-ons:Чтобы расширить существующий проект надстройками:

  1. Download the required add-on in the Add-Ons tab by clicking Install.

    Примечание
    Any amount of add-ons could be added to a project afterwards.Any amount of add-ons could be added to a project afterwards.
    Any amount of add-ons could be added to a project afterwards.
    Загрузите необходимое дополнение во вкладке Add-Ons, нажав Install.

    Примечание
    Any amount of add-ons could be added to a project afterwards.Впоследствии в проект можно было добавить любое количество надстроек.
  2. Click Other Actions -> Configure Project.
    Нажмите Other Actions -> Configure Project.
  3. Click the Add-ons (0) button and drag and drop the required add-ons from the Available field to In Use.

    Примечание
    If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.
    If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.
    Нажмите кнопку Add-ons (0) и перетащите нужные надстройки из поля Available в In Use.

    Примечание
    If you haven't downloaded the add-on, click Manage installed add-ons. You will be redirected to the page with available add-ons.Если вы не скачали надстройку, нажмите Manage installed add-ons. Вы будете перенаправлены на страницу с доступными надстройками.
  4. Click Ok and then click Update Configuration.Нажмите Ok, а затем нажмите Update Configuration.

Adding Existing ProjectДобавление существующего проекта#

To add an existing project to the browser:Чтобы добавить существующий проект в браузер:

  1. Click Add Existing in the Projects tab.
    Нажмите Add Existing на вкладке Projects.
  2. In the file dialog window that opens, specify the path to the project folder and click Apply. The project will appear in the projects list.
    В открывшемся диалоговом окне файла укажите путь к папке проекта и нажмите Apply. Проект появится в списке проектов.
Примечание
If the added project was created in the SDK of a previous version, it will be marked with the Upgrade label.Если добавленный проект был создан в SDK предыдущей версии, он будет отмечен меткой Upgrade.

Upgrading Existing ProjectОбновление существующего проекта#

Projects that require upgrade are marked with the Upgrade label: Проекты, требующие обновления, отмечены меткой Upgrade:

To upgrade your project to the newest installed version of UNIGINE SDK:Чтобы обновить свой проект до последней установленной версии UNIGINE SDK:

  1. Choose the newest installed version of the SDK and click CONFIGURE PROJECT. Выберите самую последнюю установленную версию SDK и нажмите Update Configuration.
  2. Specify a path to the backup folder into which the original project will be copied. Keep Migrate Content checked and click UPGRADE PROJECT.
    Укажите путь к папке резервного копирования, в которую будет скопирован исходный проект. Оставьте Migrate Content отмеченным и нажмите UPGRADE PROJECT.

The project will be upgraded automatically. You can also manually upgrade the project by running the upgrade script. In both cases, the same script will be used.Проект будет обновлен автоматически. Вы также можете обновить проект вручную, запустив сценарий обновления . В обоих случаях будет использоваться один и тот же сценарий.

Примечание
The source code should be upgraded manually by using the Migration Guide.Исходный код следует обновить вручную с помощью Руководства по миграции .

Running a ProjectЗапуск проекта#

You can also use launchers created by default in the project folder:Вы также можете использовать пусковые установки , созданные по умолчанию в папке проекта:

  • launch_debug — the launcher of the project's debug version. launch_debug - лаунчер отладочной версии проекта.
  • launch_editor — the launcher of the project's with the loaded editor. launch_editor - лаунчер проекта с загруженным редактором.
  • launch_release — the launcher of the project's release version. launch_release - лаунчер релизной версии проекта.

    Примечание
    Чтобы использовать программу запуска релиза, необходимо сначала перенастроить проект на бинарные файлы Release.

Running Project with Custom SettingsЗапуск проекта с пользовательскими настройками#

Depending on the value of the Application option, different sets of options are available:В зависимости от значения параметра Application доступны разные наборы параметров:

  • Default — the default main application (<project_name>_x*.exe) will be run:

    The default main application should be used when only UnigineScript is used to implement the project. In this case, the following options can be customized:The default main application should be used when only UnigineScript is used to implement the project. In this case, the following options can be customized:

    Debug Indicates whether debug or release version of the application should be run.Indicates whether debug or release version of the application should be run.
    Microprofile Enabled Run the application with the Microprofile tool enabled.Run the application with the Microprofile tool enabled.
    Arguments Start-up command-line options. Start-up command-line options.
    Remember Indicates whether to remember the specified custom settings for future run or not.Indicates whether to remember the specified custom settings for future run or not.
    The default main application should be used when only UnigineScript is used to implement the project. In this case, the following options can be customized:Indicates whether debug or release version of the application should be run.Run the application with the Microprofile tool enabled. Start-up command-line options.Indicates whether to remember the specified custom settings for future run or not.
    Default - будет запущено основное приложение по умолчанию (<project_name>_x*.exe):

    The default main application should be used when only UnigineScript is used to implement the project. In this case, the following options can be customized:Главное приложение по умолчанию следует использовать, если для реализации проекта используется только UnigineScript . В этом случае можно настроить следующие параметры:

    Debug Indicates whether debug or release version of the application should be run.Указывает, следует ли запускать отладочную или выпускную версию приложения.
    Microprofile Enabled Run the application with the Microprofile tool enabled.Запустите приложение с включенным инструментом Microprofile .
    Arguments Start-up command-line options. Параметры командной строки запуска .
    Remember Indicates whether to remember the specified custom settings for future run or not.Указывает, следует ли запоминать указанные пользовательские настройки для будущего запуска или нет.
  • Custom — a custom main application will be run:

    This option should be chosen if the C++ or C# API is used to implement the project (besides UnigineScript). In this case, the following options can be customized:This option should be chosen if the C++ or C# API is used to implement the project (besides UnigineScript). In this case, the following options can be customized:

    Binary Name of the custom main application. Here the name of the compiled binary executable located in the bin folder of the project should be specified. If the binary executable is located outside this folder, a path to it relative to the bin folder should be specified.Name of the custom main application. Here the name of the compiled binary executable located in the bin folder of the project should be specified. If the binary executable is located outside this folder, a path to it relative to the bin folder should be specified.
    Arguments Start-up command-line options. Start-up command-line options.
    Remember Indicates whether to remember the specified custom settings for future run or not.Indicates whether to remember the specified custom settings for future run or not.
    This option should be chosen if the C++ or C# API is used to implement the project (besides UnigineScript). In this case, the following options can be customized:Name of the custom main application. Here the name of the compiled binary executable located in the bin folder of the project should be specified. If the binary executable is located outside this folder, a path to it relative to the bin folder should be specified. Start-up command-line options.Indicates whether to remember the specified custom settings for future run or not.
    Custom - будет запущено собственное основное приложение:

    This option should be chosen if the C++ or C# API is used to implement the project (besides UnigineScript). In this case, the following options can be customized:Этот вариант следует выбрать, если для реализации проекта используется C++ or C# API(помимо UnigineScript). В этом случае можно настроить следующие параметры:

    Binary Name of the custom main application. Here the name of the compiled binary executable located in the bin folder of the project should be specified. If the binary executable is located outside this folder, a path to it relative to the bin folder should be specified.Имя настраиваемого основного приложения. Здесь необходимо указать имя скомпилированного двоичного исполняемого файла, расположенного в папке bin проекта. Если исполняемый двоичный файл находится за пределами этой папки, необходимо указать путь к нему относительно папки bin.
    Arguments Start-up command-line options. Параметры командной строки запуска .
    Remember Indicates whether to remember the specified custom settings for future run or not.Указывает, следует ли запоминать указанные пользовательские настройки для будущего запуска или нет.

Editing a ProjectРедактирование проекта#

Customizing UNIGINE Editor OptionsНастройка параметров UnigineEditor#

Additional arguments Start-up command-line options. Параметры командной строки запуска .
Debug The editor version (debug or release) that will be used for project's editing.Версия редактора (отладочная или выпускная), которая будет использоваться для редактирования проекта.
Microprofile Enabled Run the application with the Microprofile tool enabled.Запустите приложение с включенным инструментом Microprofile .
Remember Indicates whether to remember the specified custom settings for a future run or not.Указывает, следует ли запоминать указанные пользовательские настройки для будущего запуска или нет.

Customizing IDE OptionsНастройка параметров IDE#

  • Choose Custom in the drop-down list and specify a path to a custom tool (e.g. IDE or editor) with required arguments:В раскрывающемся списке выберите Custom и укажите путь к настраиваемому инструменту (например, IDE или редактору) с необходимыми аргументами:

  • On Linux, click Open Folder and then edit code in an associated tool.

    В Linux нажмите Open folder и затем отредактируйте код в соответствующем инструменте:

Смотрите также

Release and Development BuildsСборки для выпуска и разработки#

You can choose the Development or Release build of UNIGINE Engine:Вы можете выбрать сборку UNIGINE Engine Development или Release:

  • The Development build includes additional features that can be useful for project's development (Microprofile, etc.)Сборка Development включает дополнительные функции, которые могут быть полезны при разработке проекта (Microprofile и т.д.)
  • The Release build allows checking the final performance of the application.Сборка Release позволяет проверить конечную производительность приложения.

By default, the project is configured to use Development Engine binaries that contain additional debugging tools. Development binaries of the Engine require a running SDK Browser instance, just the same way as for the UnigineEditor.По умолчанию проект настроен на использование бинарных файлов версии Development движка, которые содержат дополнительные инструменты отладки. Бинарные файлы Development движка требуют запущенного экземпляра SDK Browser, точно так же, как и для UnigineEditor.

You can run your application without running SDK Browser via the launch_release file in the project folder, but first, you should reconfigure the project to use the Release binaries.Вы можете запустить свое приложение без SDK Browser с помощью файла launch_release в папке проекта, но сначала необходимо перенастроить проект на использование бинарных файлов Release.

To reconfigure the project:Чтобы изменить конфигурацию проекта:

  1. Click Other Actions -> Configure.Нажмите Other Actions -> Configure.

  2. Select the Release option in the Engine drop-down.Выберите опцию Release в раскрывающемся списке Engine.

  3. Click the Update Configuration button at the bottom of the configuration window to save the configuration.Нажмите кнопку Update Configuration в нижней части окна конфигурации, чтобы сохранить конфигурацию.

As soon as the project has been reconfigured to the Release build, it can be run without SDK Browser — run the launch_release file in the project folder.Как только проект будет перенастроен на сборку Release, его можно запускать без SDK Browser — запустите файл launch_release в папке проекта.

The Release binaries should be used in the final build of the project.Бинарные файлы Release должны быть использованы в финальной сборке проекта.

Other ActionsДругие действия#

When clicking the Other Actions button, the following options are available:При нажатии на кнопку Other Actions доступны следующие опции:

Configure Change project settings. Изменить настройки проекта.
Open Folder Open the project folder.Откройте папку проекта.
Delete Delete the project.Удалите проект.

Updating Project ConfigurationОбновление конфигурации проекта#

When clicking Other Actions -> Configure, the following form opens: При нажатии Other Actions -> Configure открывается следующая форма:

Via this form, you can change settings of an existing project: the UNIGINE Engine build used for the project, the version of the release application, the coordinates precision, and the general settings. This option should also be used when you need to upgrade the existing project to the newest SDK version.С помощью этой формы вы можете изменить настройки существующего проекта: сборка UNIGINE Engine , используемая для проекта, версия релизного приложения, точность координат и общие настройки . Эту опцию также следует использовать, когда вам нужно обновить существующий проект до последней версии SDK.

Moreover, you can restore the project's files that were corrupted, missed, or mistakenly modified. For this, you should leave settings in the form unchanged and press the Update Configuration button. In this case, the following files of the project will be restored (they will be copied from the SDK):Кроме того, вы можете восстановить файлы проекта, которые были повреждены, пропущены или по ошибке изменены. Для этого следует оставить настройки в форме без изменений и нажать кнопку Update Configuration. В этом случае будут восстановлены следующие файлы проекта (они будут скопированы из SDK):

  • Бинарные файлы
  • core.ung, editor.ung and scripts.ung
  • Файлы запуска (Launchers)
Примечание
If some of the files listed above are changed, the .modified postfix is added to names of such files. At that, the files from the SDK will also be copied.Если некоторые из файлов, перечисленных выше, изменены, к именам таких файлов добавляется постфикс .modified. При этом также будут скопированы файлы из SDK.
Последнее обновление: 20.06.2022
Build: ()