ogs-site/ru/news/2016-09-03_2016-august-recap.md

Title: Август 2016 кратко
Date: 2016-09-03 00:00
Category: News
Slug: 2016-august-recap
Lang: ru

![Редактор со сферическим узлом сцены][screenshot]


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

**Модуль UIQt** - это коллекция компонент UI на основе Qt. Сейчас используем лишь для интерфейса редактора.

Список компонент модуля UIQt с описанием и размером кода:<table>
<tr>
  <th>**№**</th>
  <th>**Компонента**</th>
  <th>**Описание**</th>
  <th>**Размер (Б)**</th>
  <th>**Размер (%)**</th>
</tr>
<tr>
  <td>1</td>
  <td>UIQtAction</td>
  <td>Действия (события) для меню</td>
  <td>11224</td>
  <td>9</td>
</tr>
<tr>
  <td>2</td>
  <td>UIQtAux</td>
  <td>Инициализирует Qt и главное окно. Предоставляет поиск виджета по имени для других компонент</td>
  <td>15518</td>
  <td>12</td>
</tr>
<tr>
  <td>3</td>
  <td>UIQtDock</td>
  <td>Виджет стыковки</td>
  <td>5273</td>
  <td>4</td>
</tr>
<tr>
  <td>4</td>
  <td>UIQtFileDialog</td>
  <td>Диалог выбора файла</td>
  <td>8960</td>
  <td>7</td>
</tr>
<tr>
  <td>5</td>
  <td>UIQtMenu</td>
  <td>Меню для главного окна и на ПКМ (вроде меню по добавлению/копированию/вставке/удалению узла)</td>
  <td>4566</td>
  <td>3</td>
</tr>
<tr>
  <td>6</td>
  <td>UIQtMenuBar</td>
  <td>Панель меню для главного окна</td>
  <td>4222</td>
  <td>3</td>
</tr>
<tr>
  <td>7</td>
  <td>UIQtRunner</td>
  <td>Позволяет запустить QApplication</td>
  <td>2450</td>
  <td>2</td>
</tr>
<tr>
  <td>8</td>
  <td>UIQtThumbnailDialog</td>
  <td>Диалог с изображениями</td>
  <td>18615</td>
  <td>14</td>
</tr>
<tr>
  <td>9</td>
  <td>UIQtToolBar</td>
  <td>Панель инструментов для главого окна</td>
  <td>4276</td>
  <td>3</td>
</tr>
<tr>
  <td>10</td>
  <td>UIQtTree</td>
  <td>Предоставляет сложные виджеты вроде Дерева сцены и Редактора свойств</td>
  <td>51216</td>
  <td>39</td>
</tr>
<tr>
  <td>11</td>
  <td>UIQtWidget</td>
  <td>Общие свойства виджетов вроде фокуса и видимости</td>
  <td>5465</td>
  <td>4</td>
</tr>
</table>

**Мы переработали модуль UIQt** для замены старого State API на новый Environment API, который позволяет делать то же самое лаконичнее, т.е. упрощает и ускоряет разработку.

Переработку начали в июле и должны были закончить в том же месяце. Тем не менеe, работы завершили лишь в августе. Начальный план предполагал, что 28 часов должно хватить, но мы потратили 65. Мы оценивали необходимое время на основе количества вызовов публичного API каждой компоненты. Это хорошо сработало для небольших компонент, т.к. число вызовов их публичного API было примерно равно количеству их функционала, а сам функционал был очень маленький. Однако такой подход полностью провалился для компонеты UIQtTree, составляющей 39% кода модуля UIQt, потому что не было прямой связи между публичным API и функционалом.

**Новый подход к разработке на основе функционала** родился после решения проблем с переработкой UIQtTree. Т.к. Qt использует MVC, компонента UIQtTree состоит из нескольких классов. К тому моменту, когда UIQtTree могла отображать и управлять иерархией элементов, компонента уже имела размер в 27К. Мы заметили, что UIQtTree стала потреблять непомерное количество времени разработки даже для мелкого функционала. Это было явным проявлением [количественной сложности](http://rsdn.org/article/philosophy/Complexity.xml).

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

Текущий функционал UIQtTree состоит из следующих возможностей:

<table>
<tr>
  <th>**№**</th>
  <th>**Функционал**</th>
  <th>**Описание**</th>
  <th>**Размер (Б)**</th>
  <th>**Размер (%)**</th>
</tr>
<tr>
  <td>1</td>
  <td>Base</td>
  <td>Создание, изменение, отображение иерархии элементов</td>
  <td>26966</td>
  <td>52</td>
</tr>
<tr>
  <td>2</td>
  <td>Item open state</td>
  <td>Хранит состояние свойства скрыто/отображено элемента</td>
  <td>3094</td>
  <td>6</td>
</tr>
<tr>
  <td>3</td>
  <td>Item renaming</td>
  <td>Переименование элемента</td>
  <td>3471</td>
  <td>7</td>
</tr>
<tr>
  <td>4</td>
  <td>Item selection</td>
  <td>Получение/установка выбранного элемента</td>
  <td>2338</td>
  <td>5</td>
</tr>
<tr>
  <td>5</td>
  <td>Item value</td>
  <td>Предоставляет второй и последующие столбцы для элементов, используется Редактором свойств</td>
  <td>1307</td>
  <td>3</td>
</tr>
<tr>
  <td>6</td>
  <td>Item value editing</td>
  <td>Редактирование значений элемента с помощью стандартного виджета</td>
  <td>1996</td>
  <td>4</td>
</tr>
<tr>
  <td>7</td>
  <td>Item value editing with combobox</td>
  <td>Редактирование значений элемента с помощью виджета combobox</td>
  <td>5819</td>
  <td>11</td>
</tr>
<tr>
  <td>8</td>
  <td>Item value editing with spinner</td>
  <td>Редактирование значений элемента с помощью виджета spinbox</td>
  <td>5290</td>
  <td>10</td>
</tr>
<tr>
  <td>9</td>
  <td>Menu</td>
  <td>Меню на ПКМ</td>
  <td>1248</td>
  <td>2</td>
</tr>
</table>

Пример файла функционала Menu для UIQtTree: [TREE_MENU](https://bitbucket.org/ogstudio-history/mjin-pre-pre/src/0c4cc3c3213f4687c0f3bd6a5426a6054cadd79b/f/TREE_MENU.cpp?at=Studio+0.10&fileviewer=file-view-default).

**Преимущества подхода:**

1. Более быстрое чтение/понимание благодаря небольшому размеру
1. Более простое и безболезненное изменение благодаря изолированному коду



Есть и недостаток: новый подход требует изучения.

На этом мы заканчиваем описание самых важных технических деталей разработки за август: модуль UIQt, его переработку, новый подход к разработке на основе функционала и его преимущества.

[screenshot]: ../../images/2016-09-03_august-recap.png