Light Stream Plugin - Unreal Engine

Материал из Light Stream (RU)


LSPlugin для Unreal Engine

Страница загрузки ПО с официального сайта Light Stream

Добро пожаловать на страницу документации LSPlugin.

Установка LSPlugin

Скачайте плагин с официального сайта lightstream.pro.

Рекомендуем устанавливать LSPlugin в ваш проект, а не в сам движок. Таким образом вы не потеряете настройки для каждого проекта

  1. Создайте проект в Unreal Engine с нужными для вас предустановками.
  2. Создайте папку Plugins в в корневом каталоге вашего проекта в Unreal Engine.
  3. Разархивируйте содержимое LSPlugin.zip в созданную папку Plugins.


Корневой каталог проекта Unreal Engine
Корневой каталог проекта.


Папка с LSPlugin в проекте Unreal Engine
Папка с LSPlugin в проекте Unreal Engine


Запустите ваш Unreal Engine проект:

  1. Зайдите в раздел Plugins в движке и найдите поиском Light Stream Plugin
  2. Активируйте плагин, нажав галочку
  3. Перезагрузить движок, если внизу появится надпись Restart


Активируйте LSPlugin
Активируйте LSPlugin

После установки плагина в верхней панели действий появится значок LSPlugin Активируйте LSPlugin. Данная кнопка открывает User Widget в отдельном окне. Widget является основной панелью управления плагина.


Внешний вид LSPlugin
Внешний вид LSPlugin


Также для работы LSPlugin вам нужно включить или проверить включены ли у вас плагины DMX Engine и DMX Protocol. Это встроенные в движок плагины.

Активируйте LSPlugin
Активируйте LSPlugin


Активируйте LSPlugin
Активируйте LSPlugin

Начальная настройка

Запустите Unreal Engine и зайдите в настройки плагина DMX (Edit > Project Settings > Plugins > DMX)

Активируйте LSPlugin
Активируйте LSPlugin


Добавьте Input Ports и в разделе Network Interface Card IP Address выберите адрес 0.0.0.0

Активируйте LSPlugin
Активируйте LSPlugin

LSPlugin работает на всю сеть.

Экспорт анимаций

Вся работа с плагином в Unreal Engine, подразумевает, что у вас уже есть 3D модель архитектурного объекта, а также уже готовы анимации в Light Stream.

Чтобы вывести анимации в формате *.CUE из программы Light Stream:

  1. Запустите ваш проект с подсветкой в программе Light Stream
  2. Зайдите в раздел Export.
  3. Выберите нужные анимации галочками.
  4. Выберите путь сохранения анимаций.
  5. Нажмите кнопку Start и дождитесь окончания экспорта анимаций. По окончании экспорта снова загорится кнопка Start.


Активируйте LSPlugin
Активируйте LSPlugin

Экспорт 3D модели

Установите плагин Datasmith на ваш 3D пакет для дальнейшего экспорта и импорта модели в Unreal Engine


Рассмотрим работу Datasmith на примере 3Ds Max.

  1. Откройте ваш проект в 3Ds Max.

Работа с плагином

Сейчас мы разберём пошаговую инструкцию работы с плагином.

Запуск

  1. Откройте ваш проект в Unreal Engine.
  2. Создайте папку в корневом каталоге Content, где вы будете хранить файлы вашего проекта.

Запустите Light Stream Plugin нажав на значок Активируйте LSPlugin в верхней панели движка.

Панель запуска
Панель запуска

Вкладка "Import"

Активируйте LSPlugin
Активируйте LSPlugin
  • В первом пункте плагина в разделе "Import" вам нужно выбрать файл проекта Light Stream. Нажмите Browse и откройте файл проекта (*.ls). Имя загруженного вами проекта, появится в шапке виджета LSPlugin. В_ы всегда сможете посмотреть с каким файлом проекта вы работаете.


Шапка LSPlugin
Шапка LSPlugin

LS Plugin автоматически создаст папку в директории плагина, где будет хранить все необходимые и загруженные вами файлы через виджет плагина. LightStreamPlugin / Data


Папка LSPlugin
Папка LSPlugin


  • Во втором шаге виджета вам предлагается выбрать IES файлы вашего проекта, которые автоматически будут подставлены в нужные светильники. LightStreamPlugin / Data / IES
  • Третий шаг - это загрузка вашей модели в движок. Нажмите значок "Quickly add to the project" в верхнем меню. Выберите "Datasmith > File Improt". Выберите файл *.udatasmith. Далее выберите папку, в которую будет добавлена ваша модель. 3D модель будет добавлена в сцену автоматически.


Папка LSPlugin
Папка LSPlugin
  • В четвёртом шаге вам предлагается Открыть основную таблицу настроек спауна светильников в сцену.

Все основные настройки в LS Plugin проходят в интерфейсе Data Table

Настройки | Spawn DT settings

В таблице "Spawn DT settings" отображаются все Fixtures, которые вы импортировали вместе с проектом Light Stream (*.ls)

DataTable rows
DataTable rows
Описание колонок таблицы "Spawn DT settings"

Raw Name

Fixture Name

Scene Item Actor Class

IES Texture

Spawn with IES

Override IES

Уникальный индификатор

Типа светильника. Тип светильника соотносится с типом светильников в программе Light Stream.

Fixture Library (LS)

Fixture type (LS)

Fixture Name (UE)

LED Pixel

RGB

RGB

LED Wallwasher

Wallwasher

Wallwasher

LED Spotlight

Spotlight

Spotlight

Выбранный вами класс светильника. Если говорить о RGB, то у вас есть 2 варианта выбора класса. Оставить дефолтным или создать Blueprint самому.

Подгруженная вами IES текстура.

Выбор спауна светильника с IES или без

Заменит IES вместо подгруженного вам IES из LSPlugin на тот, что будет в блюпринте Scene Item Actor Class


Row Settings - детальные настройки каждого светильника в "Spawn DT settings" Fixture Name - Дублирует колонку в таблице Fixture Name. Показывает тип Светильника (RGB, Wallwasher или Spotlight)

Scene Item Actor Class - Возможность выбора кастомного эктора для спауна Пиксей.

IESTexture - Показывает подгруженную IES текстуру. Если вы не подгружали IES через LSPlugin, то поле останется пустым.

Spawn with IES - Настройка позволяет выбрать: спаунить с IES или без.

Override IES - Заменит IES вместо подгруженного вам IES из LSPlugin на тот, что будет в блюпринте Scene Item Actor Class

DataTable rows
DataTable rows


  • Последний шестой пункт вкладки "Import" - это "Spawn" всех ваших светильников в сценку.

Вкладка "Spawn"

В таблице "Setup spawn Data Table" отображаются все Fixtures, которые вы импортировали вместе с проектом Light Stream (*.ls) . Данная таблица также дублируется во вкладке "Import"

DataTable rows
DataTable rows


Описание вкладки "Spawn" LS Plugin

Spawn

Общее название вкладки

Setup spawn Data Table

Таблица настроек спауна светильников, которая дублируется также во вкладку Import

Spawn

Despawn

Reset

Спаун всех светильников, которые есть в таблице "Setup Spawn Data Table"

Убирает со сцены все светильники, которые были заспаунены

Полная отчистка проекта. Удаление всех загруженных файлов, которые были загружены через LSPlugin


Вкладка "Detailed"


DataTable rows
DataTable rows


Описание вкладки "Detailed" LS Plugin

Detailed

Название подраздела детальных настроек

Spline / Pixel

Fixtures

Allow / Deny

Дополнительные настройки, которые действуют только на Spline / RGB Fixture Name

Настройки, которые действуют только на Wallwasher и Spotlight

Разрешенные и не разрешённые имена для спауна.

Настройка "Spline / Pixel"

В таблице "Spline / Pixel" отображаются все добавленные светильники типа RGB

DataTable rows
DataTable rows
Описание таблицы "Spline / Pixel"
Row Name Rotate Static Mesh Static Mesh Rotation Static Mesh Relative Scale Static Mesh Relative Scale
Имя сплайна Разрешение поворота мешей на сплайне Отображение углов поворота мешей на сплайне Разрешение масштабирование мешей на сплайне Отображение масштаба

Поворот мешей на сплайне

После спауна сплайнов в сцену они все повёрнуты в одну сторону.

  • Что бы повернуть конкретный сплайн на котором находятся пикселе, найдите в Outliner или во Viewport нужный сплайн и запомните его имя. Перейдите в таблицу "Spline / Pixel", найдите нужный сплайн и внизу таблицы во вкладке Row Editor поставьте галочку напротив строки Rotate Static Mesh и в строке Static Mesh Rotation введите нужные значения поворота.

Поворот и масштабирование мешей на сплайне происходит в реальном времени, поэтому можно смотреть сразу во Viewport и наблюдать за поворотом мешей.

Масштабирование мешей на сплайне

После спауна сплайнов в сцену масштаб пикселей равен 1:1 как в вашем "Scene Item Actor Class".

  • Что бы масштабировать ваши пиксели на сплайне, найдите в Outliner или во Viewport нужный сплайн и запомните его имя. Перейдите в таблицу "Spline / Pixel", найдите нужный сплайн и внизу таблицы во вкладке Row Editor поставьте галочку напротив строки "Static Mesh Relative Scale" и в строке Static Mesh Relative Scale введите нужные значения масштабирования.


DataTable rows
DataTable rows

Настройка "Fixtures"

Материал для RGB - Pixels

Мы долго работали над материалом и его отображения для визуализации пикселей. И готовы предоставить вам наши результаты. Мы поставили наш материал вместе с LSPlugin и стандартным мешем в виде полусферы для отображения пикселей. Здесь мы отталкивались не от реализма самого вида пикселя, а от реализма его отображения в движке.

Отображение материала
Отображение материала


Данный материал работает в режимах Raster и Ray Tracing во вкладке Transluсency при добавленном в проект PostProcessVolume.

Для того чтобы материал отображался правильно в каждом из режимов в Material Instance есть галочка RayTracing_ON.

RayTracing_ON
RayTracing_ON


Если вы выбрали PostProcessVolume > Transluсency > Ray Tracing - поставьте галочку ✅

Если вы выбрали PostProcessVolume > Transluсency > Raster - снимите галочку ◻️


Так же вы вольны изменять материал по своему усмотрению. Только не забывайте сделать его резервную копию, чтобы вернуться на исходные значения в случае поломки материала.


В режиме отображения Raster материал имеет эффект увеличения размера меша в зависимости от удалённости камеры от объекта, что даёт больший запас отображения анимации пикселей на дальних расстояниях, когда в сцене очень крупные объекты. В режиме Ray Tracing такая функция отсутствует. Но опять же вы можете сами доработать данный материал.

⚠️ Для правильного отображения на материала в режиме PostProcessVolume > Transluсency > Ray Tracing рекомендуется применить данные комманды в консоли или прописать её в Config файле вашего проекта

r.RayTracing.Culling 0
r.Shadow.distanceScale 0

4vector
4vector


Вы можете создавать свой кастомный материал для RGB, главное чтобы в материале цвет задавался Constant3vector или Constant4vector конвертируемые в Parametr с именем Color