doc/docs/ru/manuals/gui-layouts.md

---

title: GUI-компоновки

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

GUI-компоновки

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

Создание профилей отображения

По умолчанию в настройках game.project указано, что используется встроенный файл настроек профилей отображения ("builtins/render/default.display_profiles"). По умолчанию используются профили "Landscape" (ширина 1280 пикселей и высота 720 пикселей) и "Portrait" (ширина 720 пикселей и высота 1280 пикселей). Для профилей не задаются модели устройств, поэтому они будут соответствовать любому устройству.

Чтобы создать новый файл настроек профилей, либо скопируйте его из папки "builtins", либо кликните ПКМ подходящее место в представлении Assets и выберите New... ▸ Display Profiles. Дайте новому файлу подходящее имя и кликните Ok.

Редактор откроет новый файл для редактирования. Добавьте новые профили, кликнув + в списке Profiles. Для каждого профиля добавьте набор квалификаторов:

Width : Ширина пикселя классификатора.

Height : Высота пикселя классификатора.

Device Models : Список моделей устройств, разделенных запятой. Модель устройства соответствует началу названия модели устройства, например, iPhone10 будет соответствовать моделям "iPhone10,*". Имена моделей с запятыми должны быть заключены в кавычки, то есть "iPhone10,3", "iPhone10,6" соответствует моделям iPhone X (см. https://www.theiphonewiki.com/wiki/Models). Следует отметить, что единственными платформами, сообщающими модель устройства при вызове sys.get_sys_info(), являются Android и iOS. Другие платформы возвращают пустую строку и, следовательно, никогда не выберут профиль дисплея, содержащий квалификатор модели устройства.

Кроме того, необходимо указать, что движок должен использовать новые профили. Откройте game.project и выберите файл профилей отображения в настройках Display Profiles в разделе Display:

Если вы хотите, чтобы движок автоматически переключался между книжной и альбомной раскладками при повороте устройства, установите флажок Dynamic Orientation. Движок будет динамически выбирать подходящую компоновку, а также менять ее при смене ориентации устройства.

Автоматический выбор компоновки (Display Profiles)

У ресурса Display Profiles есть опция «Автоматический выбор компоновки» (по умолчанию ВКЛ). При включении движок автоматически выбирает наиболее подходящую компоновку как при создании сцены, так и при изменении размеров окна/экрана. При отключении движок не меняет компоновку автоматически — используйте gui.set_layout() из GUI‑скрипта для ручного переключения. Эта настройка сохраняется в файле Display Profiles и влияет на все GUI‑сцены.

GUI-компоновки

Текущий набор профилей отображения может быть использован для создания вариантов компоновки конфигурации GUI-нод. Чтобы добавить новую компоновку в GUI-сцену, кликните ПКМ по иконке Layouts в представлении Outline и выберите Add ▸ Layout ▸ ...:

При редактировании GUI-сцены все ноды редактируются в определенной компоновке. Текущая выбранная компоновка указывается в выпадающем списке компоновок GUI-сцены на тулбаре. Если компоновка не выбрана, ноды редактируются в компоновке Default.

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

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

Динамический выбор профиля

Динамический компоновщик оценивает каждый квалификатор профиля отображения в соответствии со следующими правилами:

1. Если набор моделей устройств отсутствует, или модель устройства совпадает, для квалификатора вычисляется оценка (S).

2. Оценка (S) рассчитывается с учетом площади дисплея (A), площади из квалификатора (A_Q), соотношения сторон дисплея (R) и соотношения сторон квалификатора (R_Q):

1. Выбирается профиль с квалификатором с наименьшей оценкой, если ориентация (альбомная или книжная) квалификатора соответствует дисплею.

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

3. Если ни один профиль не может быть выбран, используется запасной профиль Default.

Поскольку компоновка Default используется в качестве запасного варианта в runtime, если нет более подходящей компоновки, это означает, что если добавить компоновку "Landscape", она будет лучшей для всех ориентаций, пока также не будет добавлена компоновка "Portrait".

Сообщения о смене компоновки

Когда компановка меняется, сообщение layout_changed отправляется в скрипты компонентов GUI, на которые влияет изменение. Это происходит, когда движок автоматически меняет компановку (Auto Layout Selection включён) или когда ваш скрипт вызывает gui.set_layout(), и раскладка действительно изменяется. Сообщение содержит хэшированный идентификатор компоновки, чтобы скрипт мог выполнять логику в зависимости от того, какая компоновка выбрана:

function on_message(self, message_id, message, sender)
  if message_id == hash("layout_changed") and message.id == hash("My Landscape") then
    -- переключить компоновку на альбомную
  elseif message_id == hash("layout_changed") and message.id == hash("My Portrait") then
    -- переключить компоновку на портретную
  end
end

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

function on_message(self, message_id, message)
  if message_id == hash("window_resized") then
    -- Размер окна был изменен. message.width и
    -- message.height содержат новые размеры окна.
  end
end

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

Ручной выбор компоновки (Lua)

Когда для используемого Display Profiles отключён Автоматический выбор компоновки, движок не будет переключать компоновки автоматически. Используйте следующие функции в GUI‑скрипте для ручного управления компоновками:

gui.set_layout(layout)

• Принимает строку или хэш (идентификатор компоновки).
• Возвращает boolean: true, если компоновка существует в сцене и была применена; false в противном случае.
• Если компоновка присутствует в Display Profiles, обновляет разрешение сцены до ширины/высоты профиля.
• Посылает layout_changed, если компоновка действительно изменилась.

Пример:

function init(self)
    -- Ручное применение компоновки "Portrait"
    local ok = gui.set_layout("Portrait")
    if not ok then
        print("Компоновка 'Portrait' не найдена в этой сцене")
    end
end

gui.get_layouts()

• Возвращает таблицу, отображающую хэш идентификатора компоновки в vmath.vector3(width, height, 0).
• Для компоновки по умолчанию возвращается текущее разрешение сцены.

Пример:

local layouts = gui.get_layouts()
for id, size in pairs(layouts) do
    print(id, size.x, size.y)
end

Примечание: Если компоновка существует в сцене, но отсутствует в Display Profiles, gui.set_layout() всё равно применит переопределения свойств нод для этой компоновки, но не изменит разрешение сцены.