Opensource Game Studio

OpenSceneGraph cross-platform guide

2017-07-01T00:00:00+07:00

This article summarizes the work we did to produce OpenSceneGraph cross-platform guide.

June marked the finish of OpenSceneGraph cross-platform guide with the publishing of the last (initially planned) tutorial. The tutorial describes how to build and run sample OpenSceneGraph application in Web using Emscripten. In case you missed it, here's a link to the final application. Open it in your web browser.

We started to compose the guide in February when we successfully managed to render a simple model on mobile and web. We spent 120 hours in five months to produce ten tutorials of the guide.

We have been doing OpenSceneGraph cross-platform guide for two main reasons:

Keep OpenSceneGraph cross-platform knowledge in easily accessible and reproducible form
Share the knowledge with OpenSceneGraph community to make it stronger

We believe we succeeded in both. Here's why:

The guide repository has more stars (aka "likes") than any other repository of ours
OpenSceneGraph project leader Robert Osfield said "Great work", which means a lot
The guide already has two issues

Reaching our goal of researching OpenSceneGraph cross-platform development and providing the knowledge back to the community just made us happier.

However, our journey does not stop here. Using the knowledge of the guide, we now continue to work on bringing our tools to support mobile and web, just as we promised in January.

That's it for summarizing the work we did to produce OpenSceneGraph cross-platform guide.

OpenSceneGraph cross-platform guide

2017-07-01T00:00:00+07:00

Эта статья резюмирует создание кросс-платформенного руководства OpenSceneGraph.

Июнь ознаменовал собой окончание работы над кросс-платформенным руководством OpenSceneGraph. Мы опубликовали последний самоучитель (из изначально запланированных). Этот самоучитель описывает сборку и запуск примера приложения OpenSceneGraph в вебе с помощью Emscripten. Если вы упустили этот самоучитель, то вот ссылка на приложение из него. Откройте ссылку в веб-браузере.

Мы начали составление руководства в феврале, как только нам удалось отобразить простую модель на мобилках и вебе. Мы потратили 120 часов за пять месяцев на составление десяти самоучителей этого руководства.

Создание кросс-платформенного руководства OpenSceneGraph преследовало две основные цели:

Сохранить знания о кросс-платформенной работе с OpenSceneGraph в легкодоступной и воспроизводимой форме
Поделиться этим знанием с сообществом OpenSceneGraph и тем самым усилить сообщество

Мы уверены в том, что нам удалось достичь обе цели. И вот почему:

Хранилище руководства получило больше звёзд (лайков), чем любое другое наше хранилище
Robert Osfield, лидер проекта OpenSceneGraph, оценил руководство как "отличную работу"; это значит для нас многое
У руководства уже есть два тикета

В конце концов, мы просто рады тому факту, что изучили кросс-платформенную разработку с OpenSceneGraph и поделились этим знанием с сообществом.

Тем не менее, наше путешествие на этом не окончено. Используя знания руководства, мы продолжаем работу над тем, чтобы добавить в свои инструменты поддержку мобилок и веба, как мы обещали в январе.

На этом мы заканчиваем резюме о создании кросс-платформенного руководства OpenSceneGraph.

iOS tutorial

2017-06-08T10:00:00+07:00

This article describes problems we faced during the creation of iOS tutorial in May 2017.

This February we managed to get simple model rendered under iOS in just a few days. We expected to finish iOS tutorial in no time. However, the reality reminded us: it's easy to come up with a hackish demo that works for one person, but it's hard to create a concise example that works for everyone.

Native library

The first question we had to answer was: should the sample application be part of Xcode project or be a separately built library?

We had to consider the following facts:

Xcode project can use C++ directly (thanks to Objective-C++) without stuff like JNI
- There's no need for a separate library (+ application)
- Creating a separate library is an additional work (- library)
OpenSceneGraph builds libraries
- It's easier to use standard build process (+ library)
- It's harder to create custom build process just for a single platform (- application)
OpenSceneGraph uses CMake build system, which is not supported by Xcode
- Xcode project can't include CMake files (- application)
- It's easy to create custom CMake file that includes OpenSceneGraph CMake file to build a single library (+ library)
CMake can generate Xcode project
- It's possible to create a CMake file that builds both OpenSceneGraph and the sample application (+ application)
- Xcode is the de-facto tool to create Xcode projects; it's easier to use standard build process (+ library)

After evaluating the pros and cons of each approach, we decided to turn the sample application into a library and include it in Xcode project. The downside of this approach is that simulator and real device builds need separate library builds.

Refactoring

The second question we had to answer was: should there be a single source code base for all platforms or several ones, one for each platform?

While doing Android tutorial we used single source code base because it worked fine for desktop and Android. As we started to work through iOS tutorial, it became apparent that particular features may or may not work on some platforms. For example, one feature may work on desktop and iOS, but not Android. Another feature may work on iOS and Android, but not desktop. Since we didn't want to pollute the code with #ifdefs, we started to put each platform combination into a separate file. The number of files grew rapidly. The files were reusable, but it became extremely hard to see the whole picture.

At this point, we realized there's the second question. We reminded ourselves that the main purpose of the sample source code is to teach how to do basic OpenSceneGraph things, not create a reusable library with API that is stable across several years.

That's when our home grown feature tool came into play. With its help, we separated the code into several parts, which in the end produce just two files for each platform:

functions.h - contains reusable classless functions
main.h - contains the rest of the sample application code

Their contents differ slightly for each platform, but it's easy to see the whole picture now.

That's it for describing problems we faced during the creation of iOS tutorial in May 2017.

Самоучитель iOS

2017-06-08T10:00:00+07:00

Эта статья описывает проблемы, с которыми мы столкнулись во время создания самоучителя для iOS в мае 2017.

В феврале мы сумели отобразить простую модель под iOS за считанные дни. Это дало нам уверенность, что самоучитель для iOS мы сделаем столь же быстро. Тем не менее, реальность напомнила нам о простой вещи: быстро сделать можно лишь поделку на коленке, работающую только у самого разработчика; над логически связанным примером, работающим у всех, придётся попотеть.

Нативная библиотека

Прежде всего нам необходимо было ответить на следующий вопрос: "должен ли пример приложения быть частью проекта Xcode или отдельной библиотекой?"

Для принятия решения мы использовали следующие факты:

Проект Xcode может напрямую использовать C++ (благодаря Objective-C++) без прослоек вроде JNI
- Отдельная библиотека не нужна (+ приложение)
- Создание отдельной библиотеки - это дополнительная работа (- библиотека)
OpenSceneGraph собирается в библиотеки
- Легче использовать стандартный процесс сборки (+ библиотека)
- Создавать свой процесс сборки лишь для одной платформы сложно (- приложение)
OpenSceneGraph использует систему сборки CMake, которая не поддерживается Xcode
- Проект Xcode не может включать файлы CMake (- приложение)
- Свой файл CMake может с лёгкостью включить файл OpenSceneGraph CMake для сборки единой библиотеки (+ библиотека)
CMake может генерировать проект Xcode
- Можно создать файл CMake, который будет собирать как OpenSceneGraph, так и пример приложения (+ приложение)
- Xcode - это де-факто инструмент для создания проектов Xcode; легче использовать стандартный процесс сборки (+ библиотека)

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

Рефакторинг

Также нам пришлось ответить на ещё один вопрос: "использовать ли единую кодовую базу для всех платформ или несколько под каждую платформу?"

При создании самоучителя для Android мы использовали единую кодовую базу, т.к. она отлично работала для десктопа и Android. Когда мы начали работу над самоучителем iOS, стало ясно, что часть функционала либо работает, либо не работает на некоторых платформах. Например, один функционал может работать на десктопе и iOS, но не работать на Android. Другой функционал может работать на iOS и Android, но не работать на десктопе. Т.к. мы не хотели загрязнять код кучей #ifdef, мы решили помещать функционал, специфичный для конкретной платформы или нескольких платформ, в разные файлы. Это привело к резкому увеличению количества файлов. Такой подход хорошо подходил для повторного использования, но совершенно не годился для понимания общей картины.

В этот момент мы осознали необходимость ответа на второй вопрос. Мы напомнили себе, что главная цель примера приложения состоит в том, чтобы обучить базовым вещам OpenSceneGraph, а не создать повторно используемую библиотеку с API, который будет жить без изменений десятилетиями.

Для ответа на этот вопрос нам помог наш внутренний инструмент feature tool. С его помощью мы разделили код на несколько частей, который в итоге собирается ровно в два файла для каждой платформы:

functions.h - содержит повторно используемые бесклассовые функции
main.h - содержит остальной код приложения

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

На этом мы заканчиваем описание проблем, с которыми мы столкнулись во время создания самоучителя для iOS в мае 2017.

Pelican review

2017-06-03T22:00:00+07:00

So far so nice. Pelican is really cool, and provides a quick starting guided to get up and running real fast.

Much more smooth than Jekyll.

I <3 Python and its ecosystem. Something is just EASIER in Python.

Обзор Pelican

2017-06-03T22:00:00+07:00

Пока что полёт нормальный. Pelican действительно крут, позволяет быстро всё настроить и запуститься.

Намного легче, чем Jekyll.

<3 Python и его экосистему. Что-то просто ЛЕГЧЕ в Python.

My first review

2017-06-01T10:20:00+07:00

Here is a full review, guys.

2017-01-01T01:04:00+07:00

kr1

LANG: ru