OpenSpace3D - черновик хэлпа

В этой теме буду записывать копию перевода с французского языка туториала по движку OpenSpace3D. Переводить буду медленно, так как качество дороже, да и долго придётся править выданное гугл-переводчиком. Сначала перевод записываю сюда http://n-vr.forumbook.ru/t30-topic#37

Документация по OpenSpace3D

I. Введение

1. Предисловие

Проект OpenSpace3D зародился в стенах компании I-maginer. Технология призвана упростить создание 3D-контента в режиме реального времени. OpenSpace3D имеет открытый исходный код, что способствует его распространению и использованию в различных 3D-студиях (дизайнерами, интеграторами) и школах дизайна.

Кроме того, OpenSpace3D будет полезен в области разработки игр и просто любителям, занимающимся созданием каких-либо 3D-проектов.

По вопросам обучения работе с платформой, а также по другим вопросам - обращайтесь в службу поддержки по адресу contact@openspace3d.com

Официальный форум проекта: http://www.scolring.org/forum

Приятного чтения и удачного творчества!

Команда разработчиков OpenSpace3D.

2. Внедрение технологии SCOL

-- Что такое SCOL?

SCOL - это язык программирования, специально предназначенный для сети. Его использование позволяет создавать интерактивные мультимедийные сайты с возможностью осуществлять пользователями навигацию в трёх измерениях.

-- За простотой - сила

SCOL - интерпретируемый язык программирования. Он позволяет дизайнеру сайта (основанному на SCOL) развивать его в соответствии со своими желаниями и потребностями. Тем не менее, изучение самого языка требуется только так называемым SCOL-мастерам, создающим достаточно специфические приложения. SCOL очень гибкий язык, но в то же время и относительно сложный.

-- SCOL - многопользовательский язык

В традиционной модели Интернета пользователи не находятся в прямом контакте между собой, и в этом случае серверы делятся на столько частей, сколько пользователей онлайн.
Но SCOL-сервер не требует разделения, для общения и взаимодействия между пользователями он просто ретранслирует сообщения. В этом случае навигация по сайтам может осуществляться не индивидуально, а коллективно, что идеально подходит для многопользовательских 3D-игр, а также для виртуальных сообществ, электронной коммерции и так далее.

-- Большие возможности

SCOL включает в себя большое количество библиотек, позволяющих работать с сетью, с движком, с дву- и трёхмерным интерфейсом, с аудио, видео, SQL и так далее.

-- Обзор движка

Компания I-maginer решила не изобретать велосипед, и с 2008 года активно работает над своим проектом, включив в его состав мощный графический движок Ogre 3D.

http://www.ogre3d.org/

Такой подход способствует развитию OpenSpace3D, обладающего богатой графикой в режиме реального времени, функциональность которого непосредственно зависит от возможностей и особенностей движка Ogre 3D.

II. Документация по OpenSpace3D


1. Общее о платформе OpenSpace3D

Благодаря платформе OpenSpace3D, имеющей в своей основе технологию SCOL, можно построить полностью интерактивные и насыщенные графикой 3D-сцены. Более того - такие задачи можно выполнить не вводя ни одной строчки кода. Достигается всё это благодаря гибкости и лёгкости использования различных инструментов движка OpenSpace3D, основанных на визуальном построении взаимодействия между различными встроенными функциями.


-- Быстрая и интуитивная разработка

Как было сказано выше, добиться желаемого результата можно без программирования.
Суть проста - каждая функция (PlugIts) отвечает за определённые возможности, например, за видеосвязь, или за анимацию, или за что-то другое. Выбирая нужные функции и визуально (наподобие блок-схем) сочетая их с помощью различных связей, можно создавать приложения с тем или иным функционалом.

-- Простая концепция - доступный для всех инструмент

OpenSpace3D - многоцелевая платформа с большими возможностями. Можно выделить три уровня сложности разработки тех или иных приложений, что в некоторых случаях подразумевает работу в команде. Вот эти уровни:

1. 3D-художник. Режим быстрого и лёгкого внедрения собственных 3D-объектов и обеспечение их взаимодействия между собой на сцене.

2. Интегратор. Более полный режим. Позволяет создать готовое приложение, используя основные элементы из библиотеки.

3. Разработчик. В данном режиме могут работать те, кто хочет пойти дальше, создавая новые функции благодаря языку программирования SCOL. Поэтому платформа является Open Source проектом.

2. Начало работы в OpenSpace3D

*** Организация файлов в SCOL-разделах ***

По умолчанию, путь до папки с примерами проектов, ассетами, логами, временными файлами и т. д. имеет общий вид:

Документы\OpenSpace3D

Для Windows 7 и Windows 8 путь будет выглядеть так:

C:\Users\имя_пользователя\Documents\OpenSpace3D

В этот же каталог следует складывать и файлы для разрабатываемого вами приложения. Экспорт осуществляется тоже в данный каталог.

*** Установка редактора OpenSpace3D ***

[В некоторых местах оригинальный туториал будет мною переработан и дополнен в соответствии с последней версией программы, установленной у меня на компьютере. На данный момент последняя версия 1.8.5 выпущена в марте 2015 года. Переработанные и дополненные части туториала буду выделять цитатой и иногда зелёным цветом]

Цитата:

---

Переходим по этой ссылке http://www.openspace3d.com/lang/en/support/download/ и выбираем последнюю версию OpenSpace3D. Скачиваем её.
Теперь запускаем на установку файл openspace3d_editor_setup.exe.

http://i18.servimg.com/u/f18/19/26/23/10/111.jpg

Жмём Next.
---------------------------------------------------------------------------------------

Нам предложат скачать дополнительные пакеты. Первый - это набор свободных 3D-моделей, а второй - плагин для подключения системы отслеживания движений Kinect. Кому необходимо - ставим нужные галочки.

http://i18.servimg.com/u/f18/19/26/23/10/210.jpg

Жмём Next.
---------------------------------------------------------------------------------------

http://i18.servimg.com/u/f18/19/26/23/10/310.jpg

Ещё раз Next.
---------------------------------------------------------------------------------------

http://i18.servimg.com/u/f18/19/26/23/10/410.jpg

Ставим нужные галочки (создать значок на рабочем столе и иконку на панели быстрого запуска) и снова жмём Next/
---------------------------------------------------------------------------------------

http://i18.servimg.com/u/f18/19/26/23/10/510.jpg

Теперь надо нажать кнопку Install. Но, внимание! После этого программа установки начнёт автоматически скачивать и устанавливать плагин весом около 70 мегабайт, являющийся виртуальной машиной SCOL. Если его не скачать и не установить, то движок просто не запустится. Можно поступить иначе - скачать плагин отдельно и установить его перед установкой OpenSpace3D. Плагин можно скачать указав в адресной строке браузера эту ссылку http://www.scolring.org/rsc/scol_plugin.exe
---------------------------------------------------------------------------------------

Далее просто ждём, когда установится движок. После установки виртуальной машины SCOL, насколько помню, установщик попросит перезагрузить компьютер.

---

*** Конфигурация 3D ***

Цитата:

---

После того, как OpenSpace3D установлен, немного разберёмся с настройками 3D-режима. Плагин, который был автоматически (или вручную), и являющийся виртуальной машиной SCOL, называется Scol Voy@ger, и на данный момент имеет версию 6.4.5. Версия была выпущена 9 марта этого (2015) года.

Запуская OpenSpace3D через ярлык на рабочем столе или на панели быстрого запуска, автоматически запускается SCOL-машина. В Windows-версии корневая папка, в которой располагаются как сама виртуальная машина, так и движок OpenSpace3D, имеет путь C:\Program Files (x86)\Scol Voyager
Это для 64-битных систем. Для 32-битных систем путь будет таким C:\Program Files\Scol Voyager
Если вы потеряли ярлык запуска движка с рабочего стола или панели быстрого запуска, то сам файл для запуска OpenSpace3D находится тут:

C:\Program Files (x86)\Scol Voyager\Partition_LockedApp\tools\os3deditor\os3de ditor.scol

Соответственно, если система 32-битная, то в пути будет отсутствовать (x86)

Но можно запустить и отдельно виртуальную машину SCOL, не запуская при этом самого OpenSpace3D. Файл запуска находится по пути C:\Program Files (x86)\Scol Voyager\Scol.exe для 64-битных и по пути C:\Program Files\Scol Voyager\Scol.exe для 32-битных систем.

В стандартной системной папке "Документы" (в Windows 8 располагающейся по пути C:\Users\имя_пользователя\Documents) находятся отдельные папки как для самой виртуальной машины (папка Scol Voyager), так и для движка OpenSpace3D (папка OpenSpace3D). В этих папках находятся различный файлы с логами, временные файлы, примеры, демонстрации, и так далее.

Любое приложение, использующее виртуальную машину SCOL (не только OpenSpace3D), при своём запуске автоматически запускает эту машину.
================================================

Теперь, после знакомства со структурой файлов и папок, перейдём непосредственно к настройкам 3D-режима.

Чтобы посмотреть или поменять эти настройки, сначала нужно запустить виртуальную машину либо непосредственно запустив находящийся в корневой папке файл Scol.exe (при этом движок не запустится), либо запустить сразу OpenSpace3D.

В любом случае в трее (справа на панели задач) появится круглый значок синего цвета
http://i18.servimg.com/u/f18/19/26/23/10/screen10.png

Если запустить виртуальную машину отдельно, то больше ничего кроме этого значка и не появится.

Чтобы добраться до главного окна с настройками, необходимо щёлкнуть правой кнопкой мыши по этому значку и выбрать пункт Setup. Появится такое окно:

http://i18.servimg.com/u/f18/19/26/23/10/610.jpg

В отличие от официальной документации я не буду подробно рассматривать каждую настройку, так как, на мой взгляд, там ничего сложного нет. Единственное, что пока могу сказать - при выборе русского языка у меня ничего не поменялось (по крайней мере не заметил), и чат по прежнему не понимает русскую кодировку. Что в принципе думаю излечимо.

---

*** Общий интерфейс программы ***

Цитата:

---

Запускаем OpenSpace3D. Во время старта появится такое окно:

http://i18.servimg.com/u/f18/19/26/23/10/710.jpg
-------------------------------------------------------------------------------

И после небольшого ожидания мы увидим главное окно:

http://i18.servimg.com/u/f18/19/26/23/10/810.jpg

---

*** Назначение кнопок главного меню ***

http://i18.servimg.com/u/f18/19/26/23/10/910.jpg


1. Ctrl+N Новая сцена. Закрывает предыдущую (с вопросом о сохранении) и создаёт новую сцену.
2. Ctrl+O Открыть сцену. Загружает файлы сцены (.xos) для редактирования в OpenSpace3D
3. Ctrl+S Сохранить. Сохраняет изменения в текущей сцене в файл с этой сценой
4. Ctrl+Shift+S Сохранить как... Позволяет записать текущую сцену в файл (.xos) с другим именем
5. Ctrl+I Импорт сцены. Импортирует сцену из разных форматов (Ogre scene, Ogre mesh, 3ds, fbx, dsf, blend, dae, obj, stl)
6. Ctrl+P Настройки проекта. Можно редактировать информацию о проекте, например название, версию, описание, и т. д
7. Ctrl+E Экспорт в плейер OpenSpace3D. Поддерживается несколько вариантов - отдельное приложение, веб-страница и т. д
8. F12 Запуск проекта в плейере. Осуществляется сразу, без компиляции

*** Открытие сцены ***

В главном меню нажмите кнопку "Открыть сцену".

Цитата:

---

Откроется папка, путь к которой для Windows 8 будет иметь вид C:\Users\имя_пользователя\Documents\OpenSpace3D
Проще говоря откроется папка OpenSpace3D, находящаяся в стандартной папке Документы.
Нас сейчас интересует каталог demos, где расположены демо-сцены. Выбираем папку car_showroom и запускаем файл car_showroom.xos

Откроется вот такая демонстрация:
http://i18.servimg.com/u/f18/19/26/23/10/1010.jpg

---

*** Импорт сцены ***

В главном меню нажмите на кнопку "Импорт сцены".

Цитата:

---

Откроется окно, в котором нужно будет выбрать один из поддерживаемых форматов. Формат файлов .xos поддерживаемый только средой OpenSpace3D, можно выбрать, установив

переключатель на вторую строку - "OpenSpace3D Scene (.xos)".
Чтобы выбрать остальные форматы - устанавливаем переключатель на первую строку - "Standard file formats". После того, как установили переключатель на нужную строку, жмём

Next.

http://i18.servimg.com/u/f18/19/26/23/10/1111.jpg
------------------------------------------------------------------

На данный момент (версия 1.8.5) движок поддерживает следующие форматы:
-- Ogre scene (.scene)
-- Ogre mesh (.mesh)
-- '3D Studio' (.3ds)
-- Autodesk FBX (.fbx)
-- Autocad3D (.dxf)
-- Blender (.blend)
-- Collada (.dae)
-- Wavefront (.obj)
-- STereo Lithography (.stl)

http://i18.servimg.com/u/f18/19/26/23/10/1210.jpg

---

Внимание! OpenSpace3D обновился до версии 1.9.0, а виртуальная машина Scol Voy@ger - до версии 6.5.0. Обновления вышли 4 августа этого (2015) года. Поэтому в дальнейшем переводы документации по OpenSpace3D и языку программирования SCOL будут основываться уже на этих версиях.

Наиболее заметные изменения в OpenSpace3D:
-- Теперь можно выбрать, чтобы интерфейс программы был на русском языке.
-- Внедрена поддержка экспорта проекта на Android (правда почему-то опция неактивна)
-- Поддержка Ogre 3D версии 1.10
-- Поддержка последней версии физического движка Newton

*** Импорт сцены - продолжение ***

Цитата:

---

Как я писал выше - OpenSpace3D обновился до версии 1.9, в которой теперь можно сделать русскоязычный интерфейс. Для в верхней правой части окна программы жмём на значок двух шестерёнок. Откроется дополнительное окно со списком языков Выбираем русский, и в ещё одном появившемся окне нажимаем Ок. Перезапускаем (закрываем и снова открываем) программу.

Сразу скажу, что удобнее всё же пользоваться английской версией, так как в некоторых местах перевод не совсем корректный, а также иногда встречаются команды (особенно в раскрывающихся списках), где перевод не помещается в отведённое пространство и часть текста просто скрыта без возможности прочитать всё полностью. Поэтому можно использовать русский интерфейс в основном в учебных целях, чтобы понять что к чему, а потом уже перейти обратно на английский.

http://i18.servimg.com/u/f18/19/26/23/10/1310.jpg

Да, и ещё. В предыдущем посте я писал, что при экспорте проекта, опция конвертации, позволяющая создать программу для Андроида, неактивна. Проблема эта решается ещё во время установки, в одном из окон там надо выставить галочку, чтобы дополнительно скачать и установить компонент, отвечающий за экспорт в Андроид-приложение.
------------------------------------------------------

Теперь собственно по теме импорта сцены.

После того, как нажмём кнопку "Импорт сцены" в главном меню, и выберем опцию Стандартные форматы файлов,
можно выбирать любой из поддерживаемых 3D-форматов файлов.

http://i18.servimg.com/u/f18/19/26/23/10/1410.jpg

Далее, выбираем, к примеру, файл в формате obj (у меня это фактически целая сцена с горами и строением на вершине). Как только открыли файл, открывается окно, предупреждающее, что файл будет сконвертирован во внутренний формат движка. И указывается часть пути, куда сконвертированный файл будет помещён. Полный путь для Windows 7 (теперь у меня эта система) такой: C:\Users\имя_пользователя\Documents\OpenSpace3D\as sets\models\converted

Можно выбрать и свой путь, но он должен быть в папке C:\Users\имя_пользователя\Documents\OpenSpace3D. Насчёт путей информация не полностью проверена, поэтому остановимся на упомянутых путях.

http://i18.servimg.com/u/f18/19/26/23/10/1510.jpg

Появится сообщение о конвертации. У меня файл большой, поэтому удалось уловить момент появления такого сообщения.

http://i18.servimg.com/u/f18/19/26/23/10/1610.jpg

По завершении конвертирования будет такое окно:

http://i18.servimg.com/u/f18/19/26/23/10/1710.jpg

В данном случае у нас появилась главная папка Vershina_Mira с несколькими подпапками для текстур, материалов и мешей. В данном объекте мешей достаточно много - 1339 штук. Это потому, что сцена - рип части территории виртуального мира Anywhere во вселенной Active Worlds. Название постройки там - Вершина мира.
Вот так выглядит структура самих папок:

http://i18.servimg.com/u/f18/19/26/23/10/1810.jpg

Материалы имеют расширение material, меши - mesh,текстуры - в формате dds. А главная сцена - это файл с расширением scene.
Итак, в программе в окне жмём Далее. Нас попросят добавить или удалить сценарий. Сейчас пока ничего не нужно делать - снова жмём Далее. Видим такое окно:

http://i18.servimg.com/u/f18/19/26/23/10/1910.jpg

Ничего не меняем, пусть пока остаётся всё по умолчанию. Нажимаем Импорт.

Объект теперь в 3D-окне программы.

http://i18.servimg.com/u/f18/19/26/23/10/2010.jpg

Слева, в окне Дерево сцены появился импортированный объект. Точнее его название, которое отображено в виде раскрывающегося списка. При раскрытии списка можно увидеть названия/номера всех содержащихся в объекте мешей.
Замечу, что справа от всех названий (в окне [b]Дерево сцены[b]) есть иконки. Иконки бывают разных видов, в зависимости от того, название чего отображено - меша, материала, текстуры, костей, или чего-то другого.

---

*** Сохранение сцены OpenSpace3D (.xos) ***

В главном меню нажмите кнопку "Сохранить".
Это же можно сделать комбинацией клавиш Ctrl+S

Вы также можете сохранить сцену под другим именем и/или в другую папку. Для этого в том же главном меню нажмите кнопку "Сохранить как...". Добиться того же результата можно и нажатием клавиш Ctrl+Shift+S.

Внимание! Свои сцены сохраняйте по такому пути:
C:\Users\имя_пользователя\Documents\Scol Voyager\Partition_LocalUsr\Project\
Это необходимо для защиты SCOL-раздела.

Цитата:

---

От себя добавлю, что пока не совсем разобрался с путями, в которые можно выкладывать свои проекты, модели, текстуры, и так далее. Единственное, что могу сказать - они все должны быть в папке Документы (или Мои документы - для Windows XP) Но не в корне этой папки, а в находящихся там папках OpenSpace3D или Scol Voyager. Как переместить без проблем эти автоматически создающиеся при установке программы папки - пока не знаю. Но переместить желательно, так как держать на системном диске свои проекты небезопасно.

---

*** Экспорт сцены из OpenSpace3D ***

Цитата:

---

Чтобы экспортировать проект в один из видов приложений (веб, отдельное приложение для ПК, Андроид-приложение, и т.д.) - в главном меню нажмите кнопку "Экспорт в OpenSpace3D Player". Появится мастер, в котором будет предложено задать будущему приложению размеры окна, имя, и тип.

http://i18.servimg.com/u/f18/19/26/23/10/2110.jpg

Переключатель типа приложения поставим напротив строки "Как самостоятельное приложение". Появится дополнительное окно с настройками, где можно выбрать 3D-API (DirectX9 или OpenGL), уровень антиалиасинга (сглаживания), а также путь к значку, который будет отображаться слева в заголовке окна создаваемого приложения. Значок должен быть в формате ico, и желательно находиться в папке с проектом. [информация о нахождении значка в папке с проектом требует перепроверки].

После всего жмём Ок и ждём конвертации. Приложение появляется в папке export, автоматически созданной в папке с проектом (там, куда мы сохраняли проект в формате .xos). В папке с приложением также находятся дополнительные файлы и папки с ресурсами - объектами, текстурами, и т.д. Теперь можно распространять получившееся приложение как отдельную программу - на флешке, через интернет, и через другие виды носителей. При этом приложение будет на любом компьютере автоматически запускать находящуюся в папке с программой виртуальную машину SCOL. Сама программа запускается посредством запуска исполняемого файла с расширением exe. Также приложение можно сделать инсталлируемым (устанавливаемым), например, используя для этого программу InnoSetup.

Остальные типы приложений, такие как Андроид-приложение, веб-приложение - я рассматривать не буду, каждый уже сможет сам поэкспериментировать - там ничего сложного.

---

3. Дерево сцены и ресурсы

В левом окне программы отображаются все ресурсы проекта и их иерархия. Окно имеет четыре вкладки:
1. Дерево сцены
2. Группа ресурсов
3. Группа мешей
4. Директории с ресурсами

http://i18.servimg.com/u/f18/19/26/23/10/2210.jpg

Каждый элемент дерева, загруженный в сцену OpenSpace3D, представлен значком, характеризующим назначение и свойства этого элемента. Вот основные значки:

http://i18.servimg.com/u/f18/19/26/23/10/23z10.jpg

1. Сцена.
2. Наборы.
3. Камера.
4. Свет.
5. Группа.
6. Меш.
7. Узел.
8. Анимация.
9. Небо.
10. Кости.
11. Система частиц.
12. Динамическая кубическая карта (кубическая текстура, Cube Map)
13. Динамическая карта отражений (Reflection Map).

Примечание: Если щёлкнуть правой кнопкой мыши по какому-либо элементу дерева сцены, можно получить доступ к различным параметрам этого элемента.

http://i18.servimg.com/u/f18/19/26/23/10/2410.jpg

http://i18.servimg.com/u/f18/19/26/23/10/2510.jpg

Внимание!

Все переводы документации по языку программирования SCOL и движку OpenSpace3D теперь буду записывать только на форуме Клуб Программистов в этих темах:
1. OpenSpace3D - перевод хэлпа на русский http://www.programmersforum.ru/showthread.php?t=282034
2. SCOL - перевод учебника на русский http://www.programmersforum.ru/showthread.php?t=282035
3. Обсуждение технологии и выкладывание новых версий перевода документации по API ("Неведомые" язык SCOL и движок OpenSpace3D) http://www.programmersforum.ru/showthread.php?t=282024