WaveFront OBJ-файл: Прочитать 3D-модель

Возникла необходимость читать 3D-модель из Wavefront OBJ-файла. Нормального ридера не нашёл, поэтому решил сделать сам. Есть дельфовый, FMX, со своими ограничениями и причудами. Есть всякие рекомендации в инете, обрывочные и несистематизированные. А хотелось бы иметь законченный модуль, включил и погнали.

Цели

Хочется сделать простой по структуре и быстрый класс загрузчика 3D-модели из OBJ-файла. Без дополнительных связей и модулей. Без нарушения чьих-либо авторских прав. Всё только на базе Delphi. Пусть он будет называться TWFModel.

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

Ни DirectX, ни OpenGL пока трогать не будем, так как в процессе отладки надо что-то рисовать поверх, нормали, например, номера вершин, а при использовании указанных технологий это делать не то, чтобы невозможно, но неоправданно для таких целей. Поэтому делаем всё в старом добром Canvas, но с привлечением Direct2D. Потому что рисовать в GDI — ну, некрасиво, а GDIP — тормоза, умрём уже на сотне вершин.

На данном этапе хочется увидеть структуру файла и геометрически правильное изображение в 3D. Понятно, что нормального Z-буфера организовать не получится, поэтому отображение может простительно лажать, когда поверхность, которая должна быть под, вдруг оказывается поверх. Мы это прощаем, потому что знаем из-за чего, и не ждём идеального отображения. Для этих целей есть монстры, перечисленные выше. И которыми конечно займёмся, попозже.

Особенности реализации

Во главу угла поставлена простота реализации и ясность в понимании кода. Формат файла Wavefront не исчерпывается опубликованным ранее описанием, и возможно, в будущем, захочется расширить ридер. Не хочется потом, когда всё забудешь, заново всё изучать. В связи с чем выбран описанный далее подход. Если вкратце, он заключается в том, чтобы вся логика загрузчика заключалась в минимуме строк. Записи и массивы хороши тем, что не требуют ручного освобождения памяти под себя. Хэлперы повышают читаемость кода.

Записи (record)

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

Динамические массивы

Для хранения подобных записей тут же объявляется соответствующий тип массива TArray<тип записи>.

Единственная операция с таким массивом, которая нам понадобится, это добавление. Для этой цели пишем запакованный класс в секции implementation, который работает сразу для всех типов таких массивов.

Таким образом, в коде, при добавлении очередного параметра в массив, нам понадобится всего одна запись (FTripples: TWFTrippleDynArray):

Helpers

У нас используется два типа динамических массивов, объявленных как array of.

К сожалению, класс, описанный выше, для них не действует. Поэтому, специально для этих типов пишем пару хэлперов:

Массивы приобрели метод Add. Что позволит удобно и понятно вызвать его в основном коде.

В секции implementation хелперы находится для того, чтобы не пересекаться с возможными хелперами снаружи. Другие хелперы, если они есть, нас не интересуют, потому что нам нужен только Add.

Конвертирование строки

В листинге выше задействована некая функция StrToSingle. Это на самом деле метод класса TWFModel, который даже не классовый. Хотя парой движений может им стать, но не стал. Почему именно метод, а не какая-то локальная функция.

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

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

В самом начале чтения файла инициализируем локальное поле класса FFS: TFormatSettings:

Как только обнаружили символ разделитель, мы перестаём что-либо анализировать и просто вызываем StrToFloatDef(S, Default, FFS). И это работает быстро.

Мы используем внутреннее поле класса, поэтому оформлено не функцией, а методом класса. Конечно, можно передавать FFS в качестве var параметра. Но зачем, собственно. Мы не собираемся использовать этот метод где-то ещё. Как правило, в тех местах, где требуется подобное, есть свои нюансы. Торчать наружу всеми своими методами вредно.

Читаем OBJ-файл

Вновь обращаемся к предоставленному ранее описанию структуры OBJ-файла. В нём содержится достаточный объём информации, чтобы построить 3D-модель. Очевидно, что центральным методом класса, будет метод чтения. Все остальные будет просто его обслуживать.

Почему такой способ, через TextFile. Потому что он быстрее, чем Stream. А мы хотим читать быстро. На всякий случай, в исходнике есть способ и через TStreamReader с подключением System.IOUtils.

Мы просто пробегаем по строкам файла, берём первый символ и, в зависимости от того, что он содержит, выполняем те или иные действия. Если будем далее наращивать возможности класса, например, чтением объектов свободной формы, просто расширим оператор case большим количеством селекторов.

Читаем данные вершин

У нас есть три типа вершины — геометрическая, нормаль и текстурная. Первый символ v однозначно утверждает, что в строке содержаться некие вещественные координаты. Второй символ нам расскажет, чьи конкретно координаты:

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

Для добавления значения в массив у нас есть метод:

В нём мы используем метод строки Split, которому указываем, что хотим получить разбивку по разделителю «пробел». Практика показала, что он работает быстрее, чем пробег по строке с накоплением символов до очередного пробела (или разделителя).

Читаем объект и группу

Для операторов объекта и группы заведём соответствующий тип записи. А также типы массивов на них.

Для хранения массивов заведём в классе TWFModel следующие поля:

Тоже массивы, тоже действуют на всём протяжении файла.

При формировании массивов мы не будем искать уже существующие данные по названию. Считаем, что каждое появление оператора o или g — это новый объект или группа. На построение модели это не влияет, а группировать удобней будет именно так.

Считывая данные по этим операторам, мы должны указать, что в данный момент действует объект и группа с такими-то индексами в массиве. Это понадобится при формировании структуры face, о чём ниже. Конкретно для этих операторов можно было бы просто брать длину массива минус один, но для единообразия, да и на всякий случай, будем хранить индексы текущих объектов в соответствующих приватных полях класса.

Для сглаживающей группы массив не нужен. Это просто номер, который означает, что в данный момент у нас подразумевается сглаживание под таким-то номером.

Методы, добавляющие объект или группу, возвращают индекс добавленного:

Нюансы смотрим в комментариях. При добавлении объекта сбрасываем индекс текущей группы. Если её не будет существовать на момент добавления данных face, будет создана группа по умолчанию. При добавлении группы смотрим, есть ли объект, и если ещё объектов не было — добавляем объект.

Текущий индекс объекта и группы формируется при вызове методов из оператора case метода загрузки OBJ-файла:

Немного про сглаживающую группу. Это просто номер или off после буковки s. Поэтому, для чтения этого номера, существует простой классовый метод:

И вызывается он при встрече с оператором s:

Читаем материал

Материал, это запись особая. Её особенность в том, что из OBJ мы берём только имя. А заполнять данные по имени материала будем уже потом, когда станем читать файл MTL. Поэтому, в массиве материалов не должно быть одинаковых имён. Имя материала — это идентификатор.

Описание такое:

Для добавления материала в массив, с учётом того, что имя уникально, существует метод:

Чтением материала из строки по оператору usemtl занимается метод:

Параметр ADefault тут нужен для того, чтобы при ошибочном чтении не сбился индекс текущего материала:

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

Читаем поверхности face

Обратимся к описанию ссылочного оператора face. Помимо того, что он связывает вершины, он ещё находится под влиянием ранее установленных групповых операторов. Поэтому, в дополнение к вершинам, в структуре для face должны хранится индексы группы, материала и номер сглаживающей группы. Вершиной для face является тройка индексов — геометрия, текстура, нормаль. Если индекс равен 0, значит данных по нему нет.

Как мы знаем из описания, в операторе face может находиться более трёх вершин. Это означает, что в строке содержится описание треугольников, имеющих одну общую точку и одну общую грань.

Например, на рисунке выделен один face, состоящий из двух треугольников (4-3-7) и (4-7-8). В файле эта запись присутствует в таком виде:

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

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

Читаем MTL-файл

В этом файле хранится информация по материалам, которые «засветились» в процессе чтения OBJ-файла. Читая этот файл, мы можем к имени материала присовокупить ряд других атрибутов, включая текстуру, которые сильно помогут при построении 3D-модели в OpenGL. Нам пока ничего из этого не надо, кроме цвета материала.

TWFModel.LoadMaterials

[свернуть]

Отображаем 3D-модель

Итак, OBJ-файл прочитан, данные для построения модели есть, что дальше?

Подготовка

После прочтения файла у нас есть набор вершин трёх видов. Но для отображения нам понадобиться указать, какая с какой связаны, какие вершины образуют треугольник. Это информация у нас есть, но её надо предварительно обработать. Предположим, что за отрисовку модели у нас отвечает класс TScene3D. Опишем в нём такие поля массивов:

После того, как загрузили модель, необходимо пройтись по всем face’ам и составить карты индексов. Например, FIndicesArray — это массив, в котором содержатся тройки индексов, указывающих на массив геометрических вершин, образующих треугольник. То же самое касается и FTexturesArray, и FNormalsArray. FMaterialsArray — это массив, в котором содержатся индексы материалов, которые применимы к поверхности. Длина массива FMaterialsArray — это количество всех треугольников в модели. То есть, втрое меньше, чем в предыдущих массивах.

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

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

По сути, в массиве FIndicesArray теперь содержится программа отрисовки модели. Для отрисовки нам надо пройтись по массиву, каждый раз считывая три элемента, по этим индексам найти координаты в массиве геометрических вершин и нарисовать треугольник. И так далее, тройками, до конца массива.

Рисуем 3D-модель

Предположим, что у нас уже есть посчитанная матрица аффинного преобразования. Тогда мы просто идём по массиву FIndicesArray, каждый раз беря три вершины и рассчитываем их. В листинге ниже обрабатывается расстояние от точки до камеры, чтобы потом отсортировать и рисовать от самых дальних к самым ближним. Такое себе подобие Z-буфера. Но между тем, работает. Не блестяще, конечно, но представление о модели даёт.

Рисуем 3D-модель

[свернуть]

Ужасный TDirect2DCanvas

TDirect2DCanvas в Delphi сделан отвратительно. Там нет ни альфы в цвете, ни вещественных координат. Тот небольшой набор методов, который призван закрыть этот недостаток, ничего не закрывает. Поэтому, под спойлером, «небольшой» блок для рисования полупрозрачных плоскостей, линий и текста в вещественных координатах, используя TDirect2DCanvas.

Direct2D функции рисования примитивов

[свернуть]

Небольшой гайд

Краткое описание

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

Кликаем на слове Model в верхнем левом углу и выбираем OBJ-файл. В архиве с исполняемым файлом есть каталог objFiles. В нём примеры вполне симпатичных моделей.

После открытия модели в дереве слева появится структура файла. Если дважды кликать на соответствующем элементе, он подсветится в модели.

Внизу слева есть две галки, Soft Edges отвечает за отображение поверхностей, Use Model Color позволяет использовать цвет материала, если он есть.

Если установить Use Model Color, то можно изменить цвет материала. Для этого нужно развернуть группу Materials, найти нужный материал, дважды кликнуть на Diffuse и в появившемся диалоге выбрать цвет.

Так можно пройтись по всем материалам и назначить свой цвет. Сохранения модели нет, пока рано. Не для этого мы её делали.

Если дважды кликнуть по материалу, подсветится часть, которая ему соответствует.

Если развернём группу, то внутри обнаружим список face’ов, ей принадлежащих. Двойной клик на face приведёт к подсветке именно его одного

На рисунке видим фейс особого случая («те уста которыми не говорю по фламандски»), который описан выше. Тут много треугольников, имеющих одну вершину и общие соседние грани. Если перейти на вкладку Content, и снова дважды кликнуть по фейсу в дереве, то спозиционируемся в файле на эту строку. Поэтому в структуре TWFFace храним номер линии — он нужен только для этого.

Управление

Левая кнопка мыши — вращаем модель

Правая кнопка мыши — отдаляем/приближаем

Колесо — скролл верх-вниз

Нажатое Колесо — перемещаем модель

Ctrl + Колесо — уменьшаем/увеличиваем масштаб модели.

Листинг

Под спойлером полный листинг загрузчика OBJ-файла. Как никак, 700 строк. Не так много для модуля, но много для страницы.

IP76.WFModel

[свернуть]

Скачать

Друзья, спасибо за внимание! Надеюсь, было интересно ))) Пишите, интересна ли тема, присылайте OBJ-файлы с моделями. Сделаем коллекцию полезных 3D-моделей.

Исходник (zip) 92 Кб. Delphi XE 7, 12

Исполняемый файл (zip) 2.18 Мб (Скомпилирован в XE 7)

Коллекция OBJ-файлов (zip) 2.18 Мб (не очепатка, реально совпало)


5 6 голоса
Рейтинг статьи
Подписаться
Уведомить о
guest

0 комментариев
Старые
Новые Популярные
Межтекстовые Отзывы
Посмотреть все комментарии
0
Не нашли ответ на свой вопрос? Задайте его здесь!...x