Light Stream Plugin - Unreal Engine: различия между версиями

Материал из Light Stream (RU)
ВизуальныйВики-текст
мНет описания правки
 
(не показано 180 промежуточных версий этого же участника)
Строка 2: Строка 2:
[[en:Light Stream - Quick start]]
[[en:Light Stream - Quick start]]
[[zh:Light Stream - 快速开始]]
[[zh:Light Stream - 快速开始]]
= LSPlugin для Unreal Engine =
= LSPlugin для Unreal Engine =
[[Файл:Download_Light_Stream_RU.png|thumb|350px|альт=Страница загрузки ПО с официального сайта Light Stream|link=https://lightstream.pro/ru/support/]]
[[Файл:Cover_plugin.png|350px|альт=Страница загрузки ПО с официального сайта Light Stream|link=https://lightstream.pro/ru/support/|справа|безрамки]]
Добро пожаловать на страницу документации LSPlugin. [https://lightstream.pro/ru/support нашем сайте]
Добро пожаловать на страницу документации LSPlugin.


= Установка LSPlugin =
== ⚙️ Установка LSPlugin ==
Скачайте плагин с официального сайта [https://www.lightstream.pro/ru lightstream.pro].<blockquote>''Рекомендуем устанавливать'' ''LSPlugin'' ''в ваш проект, а не в сам движок. Таким образом вы не потеряете настройки для каждого проекта''</blockquote>


Скачайте плагин с официального сайта [https://www.lightstream.pro/ru lightstream.pro].<blockquote>''Рекомендуем устанавливать'' ''LSPlugin'' ''в ваш проект, а не в сам движок. Таким образом вы не потеряете настройки для каждого проекта. LSPlugin работает и протестирован под Unreal Engine 5.4 и выше с освещением Lumen.''</blockquote>
# Создайте проект в Unreal Engine с нужными для вас предустановками.
# Создайте проект в Unreal Engine с нужными для вас предустановками.
# Создайте папку Plugins в в корневом каталоге вашего проекта в Unreal Engine.
# Создайте папку Plugins в в корневом каталоге вашего проекта в Unreal Engine.
# Разархивируйте содержимое '''LSPlugin.zip''' в созданную папку Plugins.
# Разархивируйте содержимое '''LSPlugin.zip''' в созданную папку Plugins.
<br>
[[Файл:RootFolder.png|альт=Корневой каталог проекта Unreal Engine|безрамки|600x600пкс]]
<br>
[[Файл:PluginFolder.png|альт=Папка с LSPlugin в проекте Unreal Engine|безрамки|600x600пкс]]
<br>
Запустите ваш Unreal Engine проект:
# Зайдите в раздел '''Plugins''' в движке и найдите поиском '''Light Stream Plugin'''
# Активируйте плагин, нажав галочку
# Перезагрузить движок, если внизу появится надпись '''Restart'''
[[Файл:Lspluginactivate.png|альт=Активируйте LSPlugin|безрамки|600x600пкс]]
<br>
После установки плагина в верхней панели действий появится значок '''LSPlugin''' [[Файл:LS.png|альт=Активируйте LSPlugin|22x22пкс]]. Данная кнопка открывает '''User Widget''' в отдельном окне. '''Widget''' является основной панелью управления плагина.
[[Файл:Frame24.png|альт=Внешний вид LSPlugin|безрамки|734x734пкс]]
Также для работы '''LSPlugin''' вам нужно включить или проверить включены ли у вас плагины '''DMX Engine''' и '''DMX Protocol'''. Это встроенные в движок плагины.
<br>
[[Файл:DMXE.png|альт=Активируйте LSPlugin|безрамки|600x600пкс]]
<br>
[[Файл:DMXP.png|альт=Активируйте LSPlugin|безрамки|600x600пкс]]
==Начальная настройка==
Запустите Unreal Engine и зайдите в настройки плагина '''DMX''' (<code>Edit > Project Settings > Plugins > DMX</code>)
<br>
[[Файл:Startsettings.png|альт=Активируйте LSPlugin|безрамки|600x600пкс]]
<br>
Добавьте '''Input Ports''' и в разделе '''Network Interface Card IP Address''' выберите адрес '''0.0.0.0'''
<br>
[[Файл:Startsettings01.png|альт=Активируйте LSPlugin|безрамки|600x600пкс]]<blockquote>⚠️ '''LSPlugin''' работает в режиме '''Broadcast'''</blockquote>
==Экспорт анимаций из Light Stream==
<blockquote>''Вся работа с плагином в Unreal Engine, подразумевает, что у вас уже есть 3D модель архитектурного объекта, а также уже готовы анимации в Light Stream.''</blockquote>Чтобы вывести анимации в формате '''<code>*.CUE</code>''' из программы Light Stream:
# Запустите ваш проект с подсветкой в программе Light Stream
# Зайдите в раздел '''Export'''.
# Выберите нужные анимации галочками.
# Выберите путь сохранения анимаций.
# Нажмите кнопку '''Start''' и дождитесь окончания экспорта анимаций. По окончании экспорта снова загорится кнопка Start.
<br>
[[Файл:LightStreamExport.png|альт=Активируйте LSPlugin|безрамки|600x600пкс]]
==Экспорт 3D модели из 3Ds Max==
<blockquote>⚠️ Установите плагин [https://www.unrealengine.com/en-US/datasmith Datasmith] на ваш 3D пакет для дальнейшего экспорта и импорта модели в Unreal Engine</blockquote>
Рассмотрим работу [https://www.unrealengine.com/en-US/datasmith Datasmith] на примере 3Ds Max.
# Откройте ваш проект в '''3Ds Max'''.
# Включите вкладку '''Datasmith''' для отображения панели управления плагином
# Выберите конкретные объекты в "'''Scene Explorer'''", для экспорта в <code>'''*.uedatasmith'''</code> и нажмите кнопку "'''Export Selected'''". Выберите путь куда вы сохраните файл. Можно нажать копку "'''Exprot'''" и тогда будет экспортирована вся сцена целиком.
<br>
[[Файл:3dMax2.png|альт=Активируйте LSPlugin|безрамки|600x600пкс]]
= Работа с плагином =
Сейчас мы разберём пошаговую инструкцию работы с плагином.
== Запуск ==
# Откройте ваш проект в Unreal Engine.
# Создайте папку в корневом каталоге Content, где вы будете хранить файлы вашего проекта.
Запустите Light Stream Plugin нажав на значок [[Файл:LS.png|альт=Активируйте LSPlugin|22x22пкс]] в верхней панели движка.
<br>
[[Файл:Zapusk.png|альт=Панель запуска|безрамки|600x600пкс]]
== ✴️ Вкладка "Import" ==
=== Импорт проекта из Light Stream ===
[[Файл:Import.png|альт=Активируйте LSPlugin|безрамки|600x600пкс]]
* В первом пункте плагина в разделе "Import" вам нужно выбрать файл проекта Light Stream. Нажмите Browse и откройте файл проекта ('''<code>*.ls</code>'''). Имя загруженного вами проекта, появится в шапке виджета '''LSPlugin'''. Вы всегда сможете посмотреть с каким файлом проекта вы работаете.
<br>
[[Файл:Shapa.png|альт=Шапка LSPlugin|безрамки|600x600пкс]]
<br>
<blockquote>'''Дополнительные иконки рядом с пунктами:'''<br>
[[Файл:Warn.png|альт=Шапка LSPlugin|безрамки|600x600пкс]]
- Предупреждающая иконка, говорит о том, что "'''Необходимо выполнить этот шаг'''" для дальнейшей работы с плагином<br>
[[Файл:Quest.png|альт=Шапка LSPlugin|безрамки|600x600пкс]] - Указывающая иконка, говорит о том, что вы "'''Не выполняли'''" данное действие. Иконка пропадёт сразу как вы выполните данное действие. Это не обязывающее действие, которое можно пропустить.</blockquote><br>Эти значки помогают провести весь рабочий путь по '''LSPlugin'''.
<br>
[[Файл:ViewPlug.png|альт=Папка  LSPlugin|безрамки|600x600пкс]]
<br>
<blockquote>''LS Plugin автоматически создаст папку в директории плагина, где будет хранить все необходимые и загруженные вами файлы через виджет плагина.'' '''''LightStreamPlugin / Data'''''</blockquote>
<br>
[[Файл:Browserfolder.png|альт=Папка  LSPlugin|безрамки|600x600пкс]]
=== Импорт IES ===
<blockquote>Во втором шаге виджета вам предлагается выбрать IES файлы вашего проекта, которые автоматически будут подставлены в нужные светильники при соблюдении некоторых действий описанных ниже. Также он их автоматически сложит в проект по адресу ''<code>'''LightStreamPlugin / Data / IES'''</code>''</blockquote>
'''Данный плагин имеет три возможности работы с <code>'''*.IES'''</code> файлами и их импортом.'''
* <u>Первый способ</u> применения IES заключается в том, что изначально в 3D приложении вы расставляете свои '''IES''' к нужным светильникам. Далее при работе с '''Light Stream''' вы создаёте '''кастомные''' (''пользовательские'') '''Fixtures''' для светильников, которые используют одинаковую '''IES'''. После чего вам нужно назвать '''IES''' файлы точно также как называются созданные в '''Light Stream''' кастомные Fixtures. Далее в '''Unreal Engine''' в '''LSPlugin''' вы нажимаете "'''Browse'''" в пункте выбора '''IES''' и добавляете IES файлы в проект UE. Теперь при нажатии кнопки "'''Spawn'''" IES автоматически подтянуться к одноименным светильником проекта Light Stream.
<br>
[[Файл:Info ies4.png|альт=IES settings|безрамки|600x600пкс]]
<br>
* <u>Вторая возможность работы с IES</u>  не мешает использовать первый. Добавьте '''IES''' файлы в ваш проект Unreal Engine использовав LSPlugin. Далее мы применяем '''IES''' до спауна светильников в '''Unreal Engine'''. Зайдите в настройки '''LSPlugin,''' во вкладке "'''Scene Item Type IESs'''" вы можете выбрать для какого типа будет добавлена одинаковая '''IES'''.
<br>
[[Файл:IESsettingsplug2.png|альт=IES settings|безрамки|600x600пкс]]
<br>
* <u>Третий подход к работе с '''IES'''</u>. После спауна светильников вы переходите во вкладку '''Spawn''' в '''LSPlugin''' и открываете таблицу "'''Setup spawn Data Table'''". Во вьюпорте найдите нужные светильники, в которых вам нужно заменить '''IES'''. Посмотрите имя светильника в '''Outliner''' и найдите его в таблице. Выделите в таблице нужный светильник и в нижнем поле настроек задайте светильнику нужную '''IES'''. Выполните "'''Despawn'''" - "'''Spawn'''". ''К этой таблице вы можете обращаться в любое время для изменения '''IES.'''''
<br>[[Файл:Rowsettings.png|альт=DataTable rows|безрамки|600x600пкс]]
=== Импорт 3D модели ===
<blockquote>Третий шаг - это загрузка вашей модели в движок. Нажмите значок '''"Quickly add to the project'''" в верхнем меню. Выберите "<code>D'''atasmith > File Improt'''</code>". Выберите файл <code>'''*.udatasmith'''</code>. Далее выберите папку, в которую будет добавлена ваша модель. 3D модель будет добавлена в сцену автоматически.</blockquote><br>
[[Файл:Datasmithimport.png|альт=Папка  LSPlugin|безрамки|600x600пкс]]
== ✴️ Вкладка "Spawn" ==
<br>
[[Файл:Spawn.png|альт=DataTable rows|безрамки|600x600пкс]]
<table class="wikitable"><caption>Описание вкладки "Spawn" LS Plugin</caption><tr><td colspan="3"><p><strong><span align="center">Spawn</span></strong></p></td></tr><tr><td colspan="3"><p>Общее название вкладки</p></td></tr><tr><td colspan="3"><p><strong><span align="center">Setup spawn Data Table</span></strong></p></td></tr><tr><td colspan="3"><p>Таблица настроек спауна светильников, которая дублируется также во вкладку <strong>Import</strong></p></td></tr><tr><td><p><strong><span align="center">Spawn</span></strong></p></td><td><p><strong><span align="center">Despawn</span></strong></p></td><td><p><strong><span align="center">Reset</span></strong></p></td></tr><tr><td><p>Спаун всех светильников, которые есть в таблице "<strong>Setup Spawn Data Table</strong>"</p></td><td><p>Убирает со сцены все светильники, которые были заспаунены</p></td><td><p>Полная отчистка проекта. Удаление всех загруженных файлов, которые были загружены через LSPlugin</p></td></tr></table>
=== Настройки | Spawn DT settings ===
Здесь вам предлагается '''Открыть''' основную таблицу настроек спауна светильников в сцену.<blockquote>''Все основные настройки в'' '''''LS Plugin''''' ''проходят в интерфейсе'' '''''[https://dev.epicgames.com/documentation/en-us/unreal-engine/BlueprintAPI/DataTable?application_version=5.0 Data Tabl]'''''</blockquote>В таблице '''"Spawn DT settings'''" отображаются все '''Fixtures''', которые вы импортировали вместе с проектом Light Stream (<code>'''*.ls'''</code>)
<br>
[[Файл:Datatablerows.png|альт=DataTable rows|безрамки|600пкс]]<table class="wikitable mw-collapsible mw-collapsed"><caption>Описание колонок таблицы "Spawn DT settings"</caption><tr><td><p><strong>Raw Name</strong></p></td><td><p><strong>Fixture Name</strong></p></td><td><p><strong>Scene Item Actor Class</strong></p></td><td><p><strong>IES Texture</strong></p></td><td><p><strong>Spawn with IES</strong></p></td><td><p><strong>Override IES</strong></p></td></tr><tr><td><p>Уникальный индификатор</p></td><td><p>Типа светильника. Тип светильника соотносится с типом светильников в программе Light Stream.</p><table class="wikitable"><tr><td><p><strong>Fixture Library</strong> (LS)</p></td><td><p><strong>Fixture type</strong> (LS)</p></td><td><p><strong>Fixture Name</strong> (UE)</p></td></tr><tr><td><p>LED Pixel</p></td><td><p>RGB</p></td><td><p><strong>RGB</strong></p></td></tr><tr><td><p>LED Wallwasher</p></td><td><p>Wallwasher</p></td><td><p><strong>Wallwasher</strong></p></td></tr><tr><td><p>LED Spotlight</p></td><td><p>Spotlight</p></td><td><p><strong>Spotlight</strong></p></td></tr></table></td><td><p>Выбранный вами класс светильника. Если говорить о RGB, то у вас есть 2 варианта выбора класса. Оставить дефолтным или создать Blueprint самому.</p></td><td><p>Подгруженная вами '''IES''' текстура.</p></td><td><p>Выбор спауна светильника с '''IES''' или без</p></td><td><p>Заменит IES вместо подгруженного вам IES из LSPlugin на тот, что будет в блюпринте <strong>Scene Item Actor Class</strong></p></td></tr></table>
<br>
'''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'''
<br><br>
[[Файл:Rowsettings.png|альт=DataTable rows|безрамки|600x600пкс]]
<br>
== ✴️ Вкладка "Detailed" ==
<br>
[[Файл:Detailed.png|альт=DataTable rows|безрамки|600x600px]]
<br><table class="wikitable"><caption>Описание вкладки "Detailed" LS Plugin</caption><tr><td colspan="3"><p><strong><span align="center">Detailed</span></strong></p></td></tr><tr><td colspan="3"><p>Название подраздела детальных настроек</p></td></tr><tr><td><p><strong><span align="center">Spline / Pixel</span></strong></p></td><td><p><strong><span align="center">Fixtures</span></strong></p></td><td><p><strong><span align="center">Allow / Deny</span></strong></p></td></tr><tr><td><p>Дополнительные настройки, которые действуют только на '''Spline''' / '''RGB''' '''Fixture Name'''</p></td><td><p>Настройки, которые действуют только на '''Wallwasher''' и '''Spotlight'''</p></td><td><p>Разрешенные и не разрешённые имена для спауна.</p></td></tr></table>
=== Настройка "Spline / Pixel" ===
В таблице "'''Spline / Pixel'''" отображаются все добавленные светильники типа '''RGB'''
<br>
[[Файл:SplinePixtable.png|альт=DataTable rows|безрамки|600x600px]]
{| class="wikitable mw-collapsible mw-collapsed"
|+Описание таблицы "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 введите нужные значения поворота.
<blockquote>Поворот и масштабирование мешей на сплайне происходит в реальном времени, поэтому можно смотреть сразу во '''Viewport''' и наблюдать за поворотом мешей.</blockquote>
=== Масштабирование мешей на сплайне ===
После спауна сплайнов в сцену масштаб пикселей равен 1:1 как в вашем "<strong>Scene Item Actor Class</strong>".
* Что бы масштабировать ваши пиксели на сплайне, найдите в '''Outliner''' или во '''Viewport''' нужный сплайн и запомните его имя. Перейдите в таблицу "'''Spline / Pixel'''", найдите нужный сплайн и внизу таблицы во вкладке '''Row Editor''' поставьте галочку напротив строки "'''Static Mesh Relative Scale'''" и в строке '''Static Mesh Relative Scale''' введите нужные значения масштабирования.
<br>
[[Файл:SplinePixRowEdit.png|альт=DataTable rows|безрамки|600x600px]]
=== Настройка "Fixtures" ===
ИЗМЕНИТЬ ПО НАПОЛНЕНИЮ
== ✴️ Вкладка "Sequence" ==
Во влкадке '''Sequence''' представлен небольшой помошник для работы с Сиквенцией для дальнейшго создания синематика.
В первом этапе вам предлагается добавить к проекту файлы анимаций из '''Light Stream''' в формате '''<code>*.CUE</code>'''<blockquote>⚠️ Работа с анимация '''<code>*.CUE</code>''' доступна только пользователям Премиум версии '''Light Stream'''</blockquote>После добавление анимаций они автоматически попадут в папку с плагином '''<code>LightStreamPlugin / Data / CUE.</code>'''
Следующим шагов вам предлагается создать сиквенцию нажав на кнопку '''Create'''.
Далее '''в пункте 3''' в поле вы можете выбрать свою созданную сиквенцию. И быстро переходить к её редактированию нажав кнопку '''Edit'''
=== Работа в Sequencer ===
Откройте свою сиквенцию. Для добавление анимаций в формате *.CUE мы создали специальный очень удобный трек специально для анимаций. Нажмите кнопку '''ADD''' [[Файл:Add.png|альт=add|безрамки|600x600px]] и добавьте '''Light Stream CUE Track''' [[Файл:Lscuetrack.png|альт=Lscuetrack|безрамки|600x600px]]. Далее нажмите ПКМ на добавленной дорожке на тмайлинии и в разделе '''Properties''' в пункте "'''LightStream CUEMovie Scene Section"'''. Выберите нужную вам анимацю для воспроизведения.
<br>
[[Файл:Addcueprop.png|альт=Addcueprop|безрамки|600x600px]]
<br><br><blockquote>⚠️ ''Частота кадров анимации соответствует частоте кадров анимации в Light Stream и автоматически подстраивается под частоту вашей сиквенции. Т.е. вне зависимости от частоты кадров сиквенции анимации будут воспроизводится с той же скоростью, что и в LS.''</blockquote>
= 🔧 Light Stream - Settings =
<br>
[[Файл:LSPsettingsdeffault.png|альт=Отображение материала|безрамки|600x600px]]
<br>
{| class="wikitable mw-collapsible mw-collapsed"
|+Описание настроек LSPlugin
! colspan="3" |Light Stream Plugin Settings
!'''Настройки плагина LSPlugin'''
|-
| colspan="3" |'''Scene Item Classes'''
|Библиотека классов светильников
|-
|Spotlight
|Точечный светильник (''Spotlight'')
|Класс светильника, который соответствует классу светильника в '''Light Stream'''. По умолчанию это стандартный '''Point Light''' или '''Spotlight''' в Unreal Engine
|
|-
|Wallwasher
|Линейный светильник (''Wallwasher'')
|Класс светильника, который соответсвует типу светильника в '''Light Stream'''. По умолчанию это стандартный '''Rectangle Light''' в Unreal Engine
|
|-
|Pixel
|Пиксель (''RGB'')
|Класс светильника, который соответствует типу светильника в '''Light Stream'''. По умолчанию. Это кастомный меш и материал подготовленный специально для '''LSPlugin'''.
|
|-
| colspan="3" |'''Scene Item Type IESs'''
|Настройки стандартного пикселя для спауна
|-
|Spotlight
|
|'''IES''' для всех светильников типа '''Spotlight'''. Эта опция заменит '''все''' IES на выбранную при спауне проекта. Если оставить поле пустым, то приоритет будет отдан тем '''IES''', которые названы как '''Fixtures''' в LS (''читай Import IES'')
|
|-
|Wallwasher
|
|'''IES''' для всех светильников типа '''Wallwasher'''. Эта опция заменит '''все''' IES на выбранную при спауне проекта. Если оставить поле пустым, то приоритет будет отдан тем '''IES''', которые названы как '''Fixtures''' в LS (''читай Import IES'')
|
|}
== Static Mesh для RGB - Default LSPlugin Pixel ==
Для визуализации пикселя используются примитивные меши. '''Cube''' или '''Sphere'''. Также можно использовать любую форму меша учитывая, что материл будет применён на всю поверхность меша. Слоты материалов не учитываются в базовой настройке меша.
<br><br>
[[Файл:Meshdef lit.png|альт=Меш с материалом|безрамки|600x600пкс]]
<br><br>
В дефолтном меше '''LSPlugin''' для визуализации пикселя мы используем '''полусферу'''.<br>
<br>
[[Файл:Meshdef unlit.png|альт=Меш без материала|безрамки|600x600пкс]]
== Материал для RGB - Default LSPlugin Pixel ==
Мы долго работали над материалом ('''<code>MM_Default_Pixel</code>''') и его отображения для визуализации пикселей. И готовы предоставить вам наши результаты. Мы поставили наш материал вместе с '''LSPlugin''' и стандартным мешем в виде полусферы для отображения пикселей. Здесь мы отталкивались не от реализма самого вида пикселя, а от реализма его отображения в движке.
<br>
[[Файл:Mаterialview.png|альт=Отображение материала|безрамки|600x600px]]
<br>
Данный материал работает в режимах '''Raster''' и '''Ray Tracing''' во вкладке '''Transluсency''' при добавленном в проект '''PostProcessVolume.'''
Для того чтобы материал отображался правильно в каждом из режимов в '''Material Instance''' ('''<code>MI_Default_Pixel</code>''') есть галочка '''RayTracing_ON'''.
<br>
[[Файл:Raytracingon.png|альт=RayTracing_ON|безрамки|400x400пкс]]
<br>
Если вы выбрали '''<code>PostProcessVolume > Transluсency > Ray Tracing</code>''' - поставьте галочку ✅
Если вы выбрали '''<code>PostProcessVolume > Transluсency > Raster</code>''' - снимите галочку ◻️
Так же вы вольны изменять материал по своему усмотрению. Только не забывайте сделать его резервную копию, чтобы вернуться на исходные значения в случае поломки материала.


<gallery mode="slideshow" caption="Мастер установки Light Stream">
Файл:Install_Light_Stream_0_ru.png|Шаг 0. Перед началом установки необходимо выбрать язык установки, выбираем Русский и нажимаем '''ОК'''
Файл:Install_Light_Stream_1_ru.png|Шаг 1. На первой странице читаем соглашение лицензионное соглашение и нажимаем '''Принимаю'''
Файл:Install_Light_Stream_2_ru.png|Шаг 2. Выбираем нужные компоненты для установки. Можно оставить всё как есть и нажать '''Далее'''
Файл:Install_Light_Stream_3_ru.png|Шаг 3. Задаем путь для установки программы и нажимаем '''Далее'''
Файл:Install_Light_Stream_4_ru.png|Шаг 4. Задаем имя папки в меню «Пуск» или щелкаем галочку снизу «Не создавать ярлыки» (в меню «Пуск» и нажимаем '''Установить'''
Файл:Install_Light_Stream_5_ru.png|Шаг 5. По завершению установки, программа предложит установить библиотеку Microsoft .NET 6, необходимую для правильной работы Light Stream, нажимаем '''Да''' чтобы установить, или «Нет» если у вас уже установлен .NET 6, если вы не знаете установлен ли он у вас или нет, нажимайте '''Да'''
Файл:Install_NET6_1_ru.png|Шаг 6. Мастер установки Microsoft NET6. Если у вас уже установлен .NET 6, то специальный установочник сообщит вам об этом и предложит либо «Исправить» либо «Удалить» эту библиотеку, в таком случае можно просто нажать '''Закрыть'''
Файл:Install_NET6_2_ru.png|Шаг 7. Мастер установки Microsoft NET6. Если у вас не был установлен .NET и вы нажали «Да» то откроется окно для установки .NET 6, нажимаем '''Установить'''
Файл:Install_NET6_4_ru.png|Шаг 8. Мастер установки Microsoft NET6. В конце нажимаем '''Закрыть'''
Файл:Install_Light_Stream_6_ru.png|Шаг 9. На этом установка Light Stream завершена, еще раз нажимаем '''Закрыть''' но уже в установочном файле Light Stream, и теперь можно приступить к запуску программы.
</gallery>


==Лицензия==
В режиме отображения '''Raster''' материал имеет эффект увеличения размера меша в зависимости от удалённости камеры от объекта, что даёт больший запас отображения анимации пикселей на дальних расстояниях, когда в сцене очень крупные объекты. В режиме '''Ray Tracing''' такая функция отсутствует. Но опять же вы можете сами доработать данный материал.
Чтобы активировать лицензию необходимо запустить Light Stream и нас встретит приветственное окно «Добро пожаловать в Light Stream», справа в верхнем углу данного окна нужно нажать на '''Лицензия''', откроется окно ввода лицензии<br>
<table class="wikitable"><tr><td>
[[Файл:Welcome to Light Stream mini ru.png|безрамки|альт=Окно Добро пожаловать в Light Stream]]<br>
⚠️ Для правильного отображения на материала в режиме <code>'''PostProcessVolume > Transluсency > Ray Tracing'''</code> рекомендуется применить данные '''команды''' в консоли или прописать их в Config файле вашего проекта <code>(В'''аш проект / Config / DefaultEngine.ini''')</code>
Откроется окно «Активация» с полем для ввода лицензии, или если лицензия уже была введена, здесь её можно посмотреть, а также деактивировать чтобы перенести ключ на другой компьютер, всего один ключ можно перенести 5 раз<br>
<p>
[[Файл:Activation window ru.png|безрамки|альт=Окно Активация и поле для ввода ключа]]<br>
'''<code>r.RayTracing.Culling 0'''
Вводим ключ в поле Лицензионный ключ и сразу производится активация программы.
<br>
Если не активировать программу, то ее все равно можно использовать, создавать проекты, редактировать их, но будет несколько ограничений: нельзя отправлять Art-Net сигнал напрямую из программы, экспортированные анимации будут с пустыми данными и раз в несколько секунд рабочее пространство будет гаснуть в черный цвет
'''<code>r.Shadow.distanceScale 0'''<br></code>
</td></tr></table>


==Настройка производительности ПК==
= Кастомный материал и меш. =
Для видеокарт NVIDIA можно установить более мощные настройки графики. Для этого необходимо открыть Панель управления NVIDIA и настроить необходимые параметры.
Делаем ПКМ на рабочем столе в любом месте, во всплывающем меню выбираем Панель управления NVIDIA<br>
[[Файл:Производительность 1.png|безрамки|альт=Открытие Панели управления NVIDIA через свойства на рабочем столе]]<br>
В открывшимся окне в разделе слева выбираем: Параметры 3D – Управление параметрами 3D, далее в разделе справа, переходим на вкладку «Программные настройки» и выбираем в списке программу Light Stream. Если Light Stream в списке отсутствует, нажимаем кнопку '''Добавить''', откроется окно с выбором программы<br>
[[Файл:Производительность 2.png|безрамки|альт=Панель управления NVIDIA 2]]<br>
Переходим в папку, куда была установлена программа, по умолчанию это C:\Program Files\Light Stream, затем выбираем LightStream.exe и нажимаем '''Открыть'''<br>
[[Файл:Производительность 3.png|безрамки|альт=Поиск запускаемого файла Light Stream через панель управления NVIDIA]]<br>
Далее в списке находим строку режим управления электропитанием и выбираем значение «Предпочтителен режим максимальной производительности»<br>
[[Файл:Производительность 4.png|безрамки|альт=Выбор режима электропитания для программы Light Stream в панели управления NVIDIA]]<br>
Затем нажимаем '''Применить''' снизу справа и закрываем данное окно настроек<br>
Следующим пунктом для ноутбуков повысить производительность можно изменим параметры электропитания, идем в настройки<br>
Параметры системы (сочетание клавиш: Win+I) – Система<br>
[[Файл:Производительность, электропитание 1.png|безрамки|альт=Параметры системы Windows]]<br>
Питание и спящий режим – (снизу) Дополнительные параметры питания<br>
[[Файл:Производительность, электропитание 2.png|безрамки|альт=Параметры системы Windows - Питание и спящий режим]]<br>
Перед нами открываются настройки электропитания. По умолчанию обычно выбранная схема «Сбалансированная», но мы можем переключить её на другую. Если у вас отображается схема «Высокая производительность», то просто выберите её, если такой схемы у вас нет, то можно её создать, для этого нажимаем на '''Создание схемы управления питанием'''<br>
[[Файл:Производительность, электропитание 3.png|безрамки|альт=Электропитание Windows]]<br>
Далее выбираем «Высокая производительность» и указываем название схемы как «Высокая производительность», нажимаем '''Далее'''<br>
[[Файл:Производительность, электропитание 4.png|безрамки|альт=Создание схемы электропитания высокая производительность 1]]<br>
И нажимаем '''Создать'''<br>
[[Файл:Производительность, электропитание 6.png|безрамки|альт=Создание схемы электропитания высокая производительность 6]]<br>
Затем выбираем данную схему, на этом всё, настройка закончена<br>
[[Файл:Производительность, электропитание 7.png|безрамки|альт=Создание схемы электропитания высокая производительность 7]]<br>
Если вам захочется удалить эту схему и вернуть настройки как было, то вам нужно выбрать сперва другую схему, например «Сбалансированная», а затем напротив «Высокая производительность» нажать на '''Настройка схемы электропитания''', откроются настройки данной схемы, и слева в нижнем углу можно нажать на '''Удалить схему'''<br>
[[Файл:Производительность, электропитание 5.png|безрамки|альт=Создание схемы электропитания высокая производительность 2]]<br>
Так же, если у вас в системном трее есть иконка батареи (если у вас ноутбук), можно кликнуть по ней и сдвинуть ползунок в правое значение «Производительность»<br>
[[Файл:Производительность, электропитание 8.png|безрамки|альт=Настройки производительности через системный трей]]<br>
На этом настройка производительности завершена
<div class="page-break"></div>
==Рабочее пространство==
[[Файл:Welcome to Light Stream ru.png|650px|безрамки|альт=Окно программы с окном добро пожаловать в Light Stream]]<br>
При открытии программы вы увидите приветственное окно Добро пожаловать в Light Stream. В данном окне по умолчанию показаны демо проекты. Их можно открывать, смотреть, редактировать и изменять.
Создадим новый проект, нажмем «Создать», открывается окно «Создать проект», можно оставить все поля по умолчанию и нажать '''Создать'''<br>
[[Файл:Create project ru.png|безрамки|альт=Окно создания нового проекта]]<br>
Перед нами открывается новый проект<br>
[[Файл:Рабочее пространство ru.png|650px|безрамки|альт=Рабочее пространство Light Stream]]<br>
Интерфейс Light Stream разделен на разные окна и панели, местоположение и размер всех окон можно изменять в любой момент под себя
По центру самое большое окно Маппинг, в нём отображаются эффекты, а также располагаются все добавленные в проекте приборы.
Слева располагается окно Композиции, в котором размещены все созданные в проекте композиции
Снизу окно Таймлайн, в нём так же размещены эффекты, используемые внутри этой композиции. При создании проекта в первую композицию добавляется эффект Атом 3D, его мы здесь и видим. Эффекты можно укорачивать по длительности и выстраивать в любом порядке друг над другом
Так же можно увидеть и другие вкладки окон, но в данный момент они нам не интересны


==Размещение приборов==
== Простой. ==
Приборы создаются на панели Маппинг, и так же отображаются на панели Приборы. Все созданные приборы будут работать в рамках одного проекта и сразу во всех композициях.
[[Файл:4vector.png|альт=4vector|безрамки|600x600px]]<blockquote>⚠️ Вы можете создавать свой кастомный материал для '''RGB''', главное чтобы в материале цвет задавался '''Constant3vector''' или '''Constant4vector''' конвертируемые в '''Parametr''' с именем '''Color''' </blockquote>
Перемещение по окну Маппинг происходит с помощью зажатого колесика мышки, либо с помощью инструмента «Рука»<br>
[[Файл:Инструмент рука ru.png|безрамки|альт=Инструмент рука на панели инструментов окна Маппинг]]<br>
Чтобы создать новый прибор нужно выбрать один из инструментов. Добавить прибор (одиночный) или Создать сплайн (несколько приборов на линии).
По умолчанию будут создаваться RGB приборы, об этом говорит кнопка с надписью RGB.На данный момент изменять это мы не будем и оставить всё как есть
Выбираем «Создать сплайн»<br>
[[Файл:Create spline ru.png|безрамки|альт=Инструмент создать сплайн на панели инструментов окна Маппинг]]<br>
И рисуем сплайн, для этого на поле Маппинг в любом месте делаем левый клик, отодвигаем мышь в сторону и делаем второй клик и нажимаем клавишу Enter чтобы завершить рисование. Если не нажать '''Enter''', то можно продолжить рисовать более сложную ломанную линию и завершить её после создания нескольких колен сразу. Если совершили ошибку, можно завершить рисование сплайна клавишей Enter и удалить неправильный сплайн клавишей Delete<br>
<gallery>
Файл:Рисование сплайна 1.png|Делаем первый клик в одном месте
Файл:Рисование сплайна 2.png|Отводим мышь, делаем второй клик
Файл:Рисование сплайна 3.png|Отводим мышь в сторону
Файл:Рисование сплайна 4.png|Нажимаем клавишу '''Enter'''
Файл:Рисование сплайна 5.png|Сплайн нарисован!
</gallery>
После создания сплайна и его выделения его можно редактировать, можно тянуть за любой из углов квадрата выделения сплайна и тем самым изменять его размер<br>
[[Файл:Scale spline.png|безрамки|альт=Масштабирование сплайна]]<br>
По двойному клику на выделенном сплайне можно войти в режим редактирования граней. То же самое можно сделать если нажать на инструмент. Редактировать сплайн
[[Файл:Edit spline.png|безрамки|альт=Инструмент редактировать сплайн на панели Маппинг]] на панели инструментов на панели Маппинг. Так можно двигать грани в любую сторону по отдельности. Чтобы завершить редактирование необходимо нажать клавишу '''Enter''' либо выбрать какой-то другой инструмент на панели инструментов
<gallery>
Файл:Editable spline 1.png|Вид редактирования сплайна
Файл:Editable spline 2.png|Изменение одной из его точки
</gallery>
Все приборы можно свободно перемещать в любое время по всему полю Маппинг. Для этого нужно потянуть в сторону и отпустить квадрат, расположенный в самом центре квадрата выделения или за любое место в данной области.<br>
[[Файл:Перемещение сплайнов.png|безрамки|альт=Перемещение сплайна в окне Маппинг]]<br>
Также все приборы можно свободно вращать, справа от квадрата выделения будет отображаться дополнительная информация, по умолчанию 0.00 градусов, если захватить данный квадрат и потянуть вверх или вниз и отпустить, то таким образом можно поворачивать сплайн, по умолчанию поворот привязан к 15 градусам, эта привязка к градусам настраивается на панели инструментов на окне Маппинг кнопкой Привязка поворота [[Файл:Snap rotation.png|безрамки|альт=Инструмент привязка поворота на панели окна маппинг]] которая включает/отключает привязку вращения. А в соседнем поле [[Файл:15 Degrees.png|безрамки|альт=Настройки привязки поворота 15 градусов]] в котором указано значение в градусах, кратно которому будет осуществляться поворот<br>
[[Файл:Поворот сплайнов.png|безрамки|альт=Поворот сплайна]]<br>
Создадим таким образом 6 прямых линий. Чтобы нарисовать прямую линию нужно во время рисования держать зажатым клавишу Shift и стараться придерживаться необходимой прямой линии<br>
[[Файл:Быстрый старт. Прямые линии ru.png|безрамки|альт=Быстрый старт. Нарисованные прямые линии]]


==Добавление устройств системы управления==
=== Применение простого кастомного материала и меша. ===
===Добавление Converter в проект===
<br>
Перейдём на вкладку Приборы, которая располагается рядом с вкладкой Композиции
[[Файл:SimplePixelBP.png|альт=simpleBP|безрамки|600x600px]]
Данное окно разделено на 2 области. В верхней области располагаются все добавленные устройства, а в нижней также все приборы, созданные на панели Маппинг. Размер областей, как и размер всех окон можно изменять и настраивать под себя<br>
<br><br>
[[Файл:Вкладка Fixtures ru.png|безрамки|альт=Окно Приборы]]<br>
Созданный вами '''BP''' с материалом или мешем Вы можете заменить в настройках самого '''LSplugin''' в его настройках. Зайдите в меню '''Unreal Engine''' <code>Edit > Project Settings</code> в правом списке в разделе <big>'''Engine'''</big> найдите '''Light Stream'''. Далее в окне настройки плагина в разделе '''Pixel''' в '''Scene Item Classes''' выбрать созданный вами '''BP'''. После чего вам надо сделать "'''Despawn'''" и "'''Spawn'''" в окне плагина.
По умолчанию при создании нового проекта, в нём всегда также создается и одно устройство Light Stream Player, при необходимости в проект можно добавить сразу несколько Light Stream Player, делается это через меню Добавить устройство – Light Stream – Player
Чтобы создать новое устройство необходимо нажать кнопку Добавить устройство (плюсик в левом нижнем углу) – Light Stream – Converter 6, в данном случае 6 это количество портов у физического устройства<br>
[[Файл:Создать конвертер ru.png|безрамки|альт=Окно Приборы. Кнопка Создать Converter]]<br>
После чего в проекте создается новый Light Stream Converter<br>
[[Файл:Созданный конвертер ru.png|безрамки|альт=Окно Приборы. Созданный Converter]]<br>
===Патчинг===
Произведем патчинг приборов, для этого нужно перенести по очереди приборы из списка снизу, внутрь портов устройства из области сверху.
Для этого выделяем первый Spline001 – это сплайн, который мы нарисовали первым на поле Маппинг и просто переносим его внутрь Порт 1, таким образом производится патчинг. Сделаем так с каждым из 6 сплайнов, расставив их каждый в нужном месте. Нам нужно чтобы в Порт 1 оказались Spline001 и Spline002, в Порт 2 Spline003 и Spline004, в Порт 3 Spline005 и Spline006<br>
[[Файл:Патчинг 1 ru.png|безрамки|альт=Патчинг приборов в Converter на панели Приборы 1]]
[[Файл:Патчинг 2 ru.png|безрамки|альт=Патчинг приборов в Converter на панели Приборы 2]]<br>
Выделенный сплайн на панели Приборы так же выделяется и на панели Маппинг, таким образом становится проще ориентироваться в проекте<br>
[[Файл:Патчинг 3 ru.png|безрамки|альт=Патчинг приборов в Converter на панели Приборы 3]]<br>
Теперь перейдём к настройкам самого Light Stream Converter, для этого выберем его в списке на панели Приборы (на скриншоте я уменьшил панель Приборы и увеличил окно Свойства, потянув за рамку между этими двумя окнами) чтобы все нужные мне настройки поместились на экран
В поле IP адрес зададим нужный адрес для Light Stream Converter, в моем случае 192.168.0.100 поскольку мой Light Stream Converter настроен именно под этот адрес<br>
[[Файл:Параметры конвертера ru.png|безрамки|альт=Параметры Converter выбранного в окне Приборы]]


==Лейауты и эффекты==
== 🟠 Advanced ==
===Лейауты===
Лейауты это задаваемые области (макеты) для размещения в них эффектов, они имеют произвольные размеры (Кроме основного лейаута, он является главным и задает всю рабочую область поля Маппинг), и нужны для того чтобы на разные приборы и разные части проекта можно было устанавливать разные эффекты в рамках одной композиции. В проекте может быть любое количество лейаутов. Внутри одного лейаута может быть размещено любое количество эффектов. Лейауты создаются сразу для всего проекта и перекликаются между всеми старыми и новыми композициями в рамках одного проекта.
Дальше создадим новый Лейаут, для этого нужно выбрать инструмент Создание лейаута
Создадим его таким образом, чтобы он охватил собой только 2 нижние линии, представим, что эти приборы будут располагаться в другом месте нашего проекта, и на них будет играть другая анимация<br>
[[Файл:Create layout ru.png|безрамки|альт=Кнопка Создание лейаута на панели инструментов окна Маппинг]]<br>
Создание Лейаута происходит путем рисования прямоугольника. Выбираем инструмент, делаем первый клик по полю Маппинг в одном месте, отводим мышь и делаем второй клик в другом месте. Лейаут создается после второго клика<br>
<gallery>
Файл:Рисование лейаута 1.png|Делаем первый клик в окне Маппинг
Файл:Рисование лейаута 2.png|Отводим мышь в сторону и делаем второй клик
Файл:Рисование лейаута 3.png|Созданный лейаут
</gallery>
Создаем первый новый лейаут так, чтобы он охватил собой только 2 нижние линии (как на картинке ниже), представим, что эти приборы будут располагаться в другом месте проекта, и на них будет играть другая анимация
Если вы ошиблись при создании лейаута, то вы можете переместить его, потянув за оранжевый треугольник либо же изменить его размеры потянув за один из углов. Если вы кликнули мимо и выделение лейаута слетело, то вам нужно выделить его на панели Таймлайн, и вы снова сможете редактировать лейаут
И мы видим, что лейаут создается не только на панели Маппинг, но и сразу же он попадает на панель Таймлайн, там внутрь его мы сможем размещать эффекты<br>
[[Файл:Новый Layout 1 ru.png|безрамки]]<br>
И так же создадим второй Лейаут, чтобы он уже охватил 4 верхние линии, новый лейаут так же автоматически попадает на панель Таймлайн<br>
[[Файл:Новый Layout 2.png|безрамки|альт=Второй нарисованный лейаут в окне Маппинг]]<br>
===Эффекты===
Теперь добавим наш первый эффект в проект.
Эффект сразу добавляется на панель маппинг, а также на панель таймлайн, в текущий выбранный лейаут. Выбранный лейаут, тот, который выделен в данный момент на таймлайн
Выбранный лейаут выделен более светлой заливкой как на примере ниже. Выделим Main layout<br>
[[Файл:Выбранный лейаут ru.png|безрамки|альт=Выбранный лейаут в окне Таймлайн]]<br>
Чтобы добавить эффект нужно открыть окно с эффектами, открывается оно по кнопке на панели Таймлайн [[Файл:Effects.png|безрамки|альт=Кнопка открытия окна Эффекты на панели инструментов окна Таймлайн]] Эффекты<br>
[[Файл:Панель эффектов ru.png|безрамки|альт=Окно эффектов]]<br>
Выбираем любой понравившийся эффект и кликаем по нему дважды, либо по самому центру на плюсик<br>
[[Файл:Добавление эффекта.png|безрамки|альт=Добавление эффекта]]<br>
Эффект добавляется в Main layout, поскольку мы его выделили, затем перенесем эффект из Main layout в Layout002, для этого просто берем и перетаскиваем его в новое место<br>
[[Файл:Эффект на Timeline 1 ru.png|600px|безрамки|альт=Добавленный эффект на таймлайне в основном лейауте]]<br>
И сразу удаляем стандартный эффект Атом 3D из Main layout, поскольку он нам не нужен, и с ним не будет видно эффекты в других лейаутах, так как он их перекрывает
Чтобы удалить какой-либо эффект, нужно выделить его и нажать клавишу Delete<br>
[[Файл:Эффект на Timeline 2 ru.png|600px|безрамки|альт=Удаление стандартного эффекта Атом 3D и перенос эффекта Rainbow в другой леуйаут]]<br>
Добавим эффект на другой лейаут – Layout001. Теперь выделим этот лейаут заранее на панели Таймлайн, чтобы добавляемый эффект, автоматически добавился именно в него. Выберем какой-нибудь другой эффект и добавим его. Эффект сразу должен попасть внутрь Layout001. Если эффект добавился в какой-то другой лейаут, то можно его вручную перенести в нужный нам лейаут Layout001, таким же способом как мы сделали это выше.<br>
[[Файл:Эффект на Timeline 3 ru.png|600px|безрамки|альт=Добавление эффекта Neon Bars в Layout001]]<br>
Таким образом мы создали эффекты внутри Composition001. Дальше попробуем по аналогии добавить эффекты в другие композиции
Закроем окно Эффекты, перейдём на панель Композиции и выберем Composition002<br>
[[Файл:Панель Compositions ru.png|безрамки|альт=Окно композиции]]<br>
Снова откроем панель Эффекты, и добавим в композицию любой эффект. Если вы не выбирали никакой лейаут на панели Таймлайн, то по умолчанию эффект добавляется в Main layout. Если был выделен какой-то конкретный лейаут, эффект добавится в него.
Оставим добавленный эффект в этот раз внутри Main layout<br>
[[Файл:Composition002 добавленный эффект ru.png|безрамки|альт=Добавленный эффект в Compositon002]]<br>
По аналогии с двумя предыдущими пунктами добавим эффекты и в другие композиции. Эффекты можно размещать в любых лейаутах.
У меня получились следующие композиции с различными эффектами внутри них.<br>
[[Файл:Собранные композиции ru.png|безрамки|альт=Собранные композиции в окне Композиции]]


==Экспорт композиций в cue файлы==
После окончания создания всех композиций произведем экспорт композиций в *.cue файлы.
Перейдём на вкладку Экспорт. Здесь отображаются все те же композиции, но представленные в виде списка, галочки слева означают что данные композиции будут экспортироваться в *.cue файлы.<br>
[[Файл:Export 1 ru.png|450px|безрамки|альт=Окно Экспорт]]<br>
Нажмем кнопку Открыть и выберем папку, куда будут экспортироваться наши композиции в поле Путь.
GIF превью оставим как есть, и нажмем кнопку Старт. Начнется просчет анимаций, слева в окошке начнет отображаться их превью, превью так же будет использоваться и на Light Stream Player<br>
[[Файл:Export 2 ru.png|450px|безрамки|альт=Окно Экспорт в момент конвертации анимаций]]<br>
Экспорт занимает какое-то время, чем сложнее проект – тем дольше, но в целом обычно ждать нужно не долго. В конце экспорта просто перестанет проигрываться предпросмотр анимации. На этом экспорт композиции из Light Stream в *.cue файлы завершен


==Экспорт настроек из Light Stream в Light Stream Player==
Создайте папку в каталоге своего проекта, в которой будет хранится кастомный BP. Создайте с обычным Actor Class '''Blueprint >''' '''Actor class'''.
Произведем экспорт настроек Light Stream Converter, который ранее был добавлен в проект, в Light Stream Player
Для этого нужно открыть панель Приборы и выбрать на ней Light Stream Player<br>
[[Файл:Light Stream Player ru.png|безрамки|альт=Окно Приборы и выбранный Player]]<br>
Снизу у выбранного устройства Player будут отображаться параметры, зададим настройки следующим образом
IP адрес 192.168.0.200, такой адрес я указываю поскольку мой Light Stream Player настроен именно на него
В поля Имя пользователя и Пароль впишем administrator / administrator это данные доступа к Light Stream Player по умолчанию, их я не изменял
Затем нажимаем кнопку Отправить, открывается окно с предупреждением что дальше вселенные и устройства будут отправлены на Light Stream Player. Снова нажимаем Отправить. Если все указано правильно и устройство Light Stream Player было подключен к компьютеру, то высветится окно с успешной отправкой данных.<br>
<gallery>
Файл:Player settings export 1 ru.png|Нажимаем отправить
Файл:Player settings export 2 ru.png|Нажимаем '''Ок'''
</gallery>
Если выскочила ошибка, то нужно перепроверить заданные параметры или подключение Light Stream Player к компьютеру, а также его настройки.


==Импорт анимаций в Light Stream Player==
В этом блюпринте вы можете добавлять всё что угодно. Любой меш с любыми материалом, а после чего задать какой меш будет дублироваться в сцене. Так же указать материал в каком меше и в каком слоте будет использоваться как динамический для приёма '''DMX''' сигнала. Всё это осуществляется при помощи '''Light Stream Interfaces'''.
Далее, чтобы импортировать файлы *.cue на Light Stream Player, открываем браузер и вводим в адресной строке адрес нашего Player. В моем случае 192.168.0.200
Загружается страница входа в интерфейс Player. Если окажется что у вас выбран какой-либо другой язык, можно нажать на глобус и изменить его на Русский.
Затем, вводим данные доступа по умолчанию administrator / administrator
''Предполагается, что Light Stream Player на данном этапе уже настроен и на него загружена лицензия. Подробнее об этом можно узнать в Руководстве пользователя Light Stream Player''<br>
[[Файл:Player 1 ru.png|600px|безрамки|альт=Интерфейс Player 1]]<br>
При открытии Player, мы можем попасть как в меню Анимаций, так и в меню Расписание, в зависимости от того, в каком режиме сейчас работает Player.<br>
[[Файл:Player 2 ru.png|600px|безрамки|альт=Интерфейс Player 2]]<br>
Если в меню будет выбрано «Расписание», то в меню кликаем на '''Анимации'''
И попадаем в раздел с анимациями, сверху слева нажимаем кнопку Загрузить анимации<br>
[[Файл:Player 3 ru.png|600px|безрамки|альт=Интерфейс Player 3 Раздел Анимации]]<br>
Открывается окно, предлагающее выбрать анимации, нажимаем на скрепку<br>
[[Файл:Player 4 ru.png|600px|безрамки|альт=Интерфейс Player 4 Раздел Анимации. Окно Загрузить анимации]]<br>
И выбираем нужные файлы, которые мы экспортировали ранее<br>
[[Файл:Player Выбор анимаций.png|600px|безрамки]]<br>
Выбранные файлы станут отображаться в окне Загрузить анимации, нажимаем кнопку Загрузить  и происходит загрузка анимаций<br>
[[Файл:Player 5 ru.png|600px|безрамки|альт=Интерфейс Player 5 Выбор анимаций]]<br>
В конце загрузки анимаций, окно Загрузить анимации автоматически закроется, и все загруженные анимации (cue файлы) станут отображаться в виде анимаций в меню Анимации на Player. На этом экспорт анимаций завершен<br>
[[Файл:Player 6.png|600px|безрамки|альт=Интерфейс Player 6 Загруженные анимации]]<br>
Также, можно перейти в Настройки – Вселенные и конвертеры и здесь будут отображаться вселенные и устройства, в нашем случае один Light Stream Converter, который мы экспортировали из Light Stream<br>
[[Файл:Player 7 ru.png|600px|безрамки|альт=Интерфейс Player 7 Раздел Вселенные и конвертеры]]

Текущая версия от 12:25, 2 ноября 2024

LSPlugin для Unreal Engine

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

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

⚙️ Установка LSPlugin

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

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

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


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


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


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

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

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


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

Внешний вид LSPlugin


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


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

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

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


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

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

⚠️ LSPlugin работает в режиме Broadcast

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

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

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

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


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

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

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


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

  1. Откройте ваш проект в 3Ds Max.
  2. Включите вкладку Datasmith для отображения панели управления плагином
  3. Выберите конкретные объекты в "Scene Explorer", для экспорта в *.uedatasmith и нажмите кнопку "Export Selected". Выберите путь куда вы сохраните файл. Можно нажать копку "Exprot" и тогда будет экспортирована вся сцена целиком.


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

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

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

Запуск

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

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

✴️ Вкладка "Import"

Импорт проекта из Light Stream

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

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


Шапка LSPlugin

Дополнительные иконки рядом с пунктами:

Шапка LSPlugin - Предупреждающая иконка, говорит о том, что "Необходимо выполнить этот шаг" для дальнейшей работы с плагином

Шапка LSPlugin - Указывающая иконка, говорит о том, что вы "Не выполняли" данное действие. Иконка пропадёт сразу как вы выполните данное действие. Это не обязывающее действие, которое можно пропустить.


Эти значки помогают провести весь рабочий путь по LSPlugin.


Папка LSPlugin

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


Папка LSPlugin

Импорт IES

Во втором шаге виджета вам предлагается выбрать IES файлы вашего проекта, которые автоматически будут подставлены в нужные светильники при соблюдении некоторых действий описанных ниже. Также он их автоматически сложит в проект по адресу LightStreamPlugin / Data / IES

Данный плагин имеет три возможности работы с *.IES файлами и их импортом.

  • Первый способ применения IES заключается в том, что изначально в 3D приложении вы расставляете свои IES к нужным светильникам. Далее при работе с Light Stream вы создаёте кастомные (пользовательские) Fixtures для светильников, которые используют одинаковую IES. После чего вам нужно назвать IES файлы точно также как называются созданные в Light Stream кастомные Fixtures. Далее в Unreal Engine в LSPlugin вы нажимаете "Browse" в пункте выбора IES и добавляете IES файлы в проект UE. Теперь при нажатии кнопки "Spawn" IES автоматически подтянуться к одноименным светильником проекта Light Stream.


IES settings

  • Вторая возможность работы с IES не мешает использовать первый. Добавьте IES файлы в ваш проект Unreal Engine использовав LSPlugin. Далее мы применяем IES до спауна светильников в Unreal Engine. Зайдите в настройки LSPlugin, во вкладке "Scene Item Type IESs" вы можете выбрать для какого типа будет добавлена одинаковая IES.


IES settings

  • Третий подход к работе с IES. После спауна светильников вы переходите во вкладку Spawn в LSPlugin и открываете таблицу "Setup spawn Data Table". Во вьюпорте найдите нужные светильники, в которых вам нужно заменить IES. Посмотрите имя светильника в Outliner и найдите его в таблице. Выделите в таблице нужный светильник и в нижнем поле настроек задайте светильнику нужную IES. Выполните "Despawn" - "Spawn". К этой таблице вы можете обращаться в любое время для изменения IES.


DataTable rows

Импорт 3D модели

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


Папка LSPlugin

✴️ Вкладка "Spawn"


DataTable rows

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

Spawn

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

Setup spawn Data Table

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

Spawn

Despawn

Reset

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

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

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

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

Здесь вам предлагается Открыть основную таблицу настроек спауна светильников в сцену.

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

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


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


✴️ Вкладка "Detailed"


DataTable rows


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

Detailed

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

Spline / Pixel

Fixtures

Allow / Deny

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

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

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

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

В таблице "Spline / Pixel" отображаются все добавленные светильники типа RGB
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

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

ИЗМЕНИТЬ ПО НАПОЛНЕНИЮ

✴️ Вкладка "Sequence"

Во влкадке Sequence представлен небольшой помошник для работы с Сиквенцией для дальнейшго создания синематика.

В первом этапе вам предлагается добавить к проекту файлы анимаций из Light Stream в формате *.CUE

⚠️ Работа с анимация *.CUE доступна только пользователям Премиум версии Light Stream

После добавление анимаций они автоматически попадут в папку с плагином LightStreamPlugin / Data / CUE.

Следующим шагов вам предлагается создать сиквенцию нажав на кнопку Create.

Далее в пункте 3 в поле вы можете выбрать свою созданную сиквенцию. И быстро переходить к её редактированию нажав кнопку Edit

Работа в Sequencer

Откройте свою сиквенцию. Для добавление анимаций в формате *.CUE мы создали специальный очень удобный трек специально для анимаций. Нажмите кнопку ADD add и добавьте Light Stream CUE Track Lscuetrack. Далее нажмите ПКМ на добавленной дорожке на тмайлинии и в разделе Properties в пункте "LightStream CUEMovie Scene Section". Выберите нужную вам анимацю для воспроизведения.


Addcueprop



⚠️ Частота кадров анимации соответствует частоте кадров анимации в Light Stream и автоматически подстраивается под частоту вашей сиквенции. Т.е. вне зависимости от частоты кадров сиквенции анимации будут воспроизводится с той же скоростью, что и в LS.

🔧 Light Stream - Settings


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

Описание настроек LSPlugin
Light Stream Plugin Settings Настройки плагина LSPlugin
Scene Item Classes Библиотека классов светильников
Spotlight Точечный светильник (Spotlight) Класс светильника, который соответствует классу светильника в Light Stream. По умолчанию это стандартный Point Light или Spotlight в Unreal Engine
Wallwasher Линейный светильник (Wallwasher) Класс светильника, который соответсвует типу светильника в Light Stream. По умолчанию это стандартный Rectangle Light в Unreal Engine
Pixel Пиксель (RGB) Класс светильника, который соответствует типу светильника в Light Stream. По умолчанию. Это кастомный меш и материал подготовленный специально для LSPlugin.
Scene Item Type IESs Настройки стандартного пикселя для спауна
Spotlight IES для всех светильников типа Spotlight. Эта опция заменит все IES на выбранную при спауне проекта. Если оставить поле пустым, то приоритет будет отдан тем IES, которые названы как Fixtures в LS (читай Import IES)
Wallwasher IES для всех светильников типа Wallwasher. Эта опция заменит все IES на выбранную при спауне проекта. Если оставить поле пустым, то приоритет будет отдан тем IES, которые названы как Fixtures в LS (читай Import IES)

Static Mesh для RGB - Default LSPlugin Pixel

Для визуализации пикселя используются примитивные меши. Cube или Sphere. Также можно использовать любую форму меша учитывая, что материл будет применён на всю поверхность меша. Слоты материалов не учитываются в базовой настройке меша.

Меш с материалом

В дефолтном меше LSPlugin для визуализации пикселя мы используем полусферу.

Меш без материала

Материал для RGB - Default LSPlugin Pixel

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


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

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


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

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


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


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

⚠️ Для правильного отображения на материала в режиме PostProcessVolume > Transluсency > Ray Tracing рекомендуется применить данные команды в консоли или прописать их в Config файле вашего проекта (Ваш проект / Config / DefaultEngine.ini)

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

Кастомный материал и меш.

Простой.

4vector

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

Применение простого кастомного материала и меша.


simpleBP

Созданный вами BP с материалом или мешем Вы можете заменить в настройках самого LSplugin в его настройках. Зайдите в меню Unreal Engine Edit > Project Settings в правом списке в разделе Engine найдите Light Stream. Далее в окне настройки плагина в разделе Pixel в Scene Item Classes выбрать созданный вами BP. После чего вам надо сделать "Despawn" и "Spawn" в окне плагина.

🟠 Advanced

Создайте папку в каталоге своего проекта, в которой будет хранится кастомный BP. Создайте с обычным Actor Class Blueprint > Actor class.

В этом блюпринте вы можете добавлять всё что угодно. Любой меш с любыми материалом, а после чего задать какой меш будет дублироваться в сцене. Так же указать материал в каком меше и в каком слоте будет использоваться как динамический для приёма DMX сигнала. Всё это осуществляется при помощи Light Stream Interfaces.

Источник — https://ru.lightstream.pro/index.php?title=Light_Stream_Plugin_-_Unreal_Engine&oldid=504