Skip to content

Help dcc_clients ru

Alex Miarsky edited this page Nov 10, 2026 · 1 revision

DCC-клиенты

DCC-плагины

В Настройки → DCC-плагины можно независимо включать и отключать интеграции. Выбор сохраняется для этой сборки ТХ и применяется после её перезапуска, сохраняя текущие операции. Отключённый плагин не добавляет действия, настройки, параметры операций и триггеры; локальный сервер отклоняет его DCC-клиентов. Существующие правила автоматизации и кастомные скрипты сохраняются. Ошибка загрузки одного плагина отображается в списке и не мешает загрузке остальных.

Плагин Maya добавляет раздел Сцена Maya → Интеграция Maya: поиск установленных и запущенных Maya, просмотр подключений, установка шелфа запуска ТХ и автозапуска коннектора, удаление принадлежащих интеграции файлов. Ненужные подключения Maya удалите до отключения плагина. Переключатели плагинов и кнопки установки сохраняют изменения самостоятельно; применение и отмена черновика настроек их не отменяют.

Следующие интеграции используют тот же контракт манифеста и каталога плагинов. Общий экран настроек не содержит специальных условий для Maya. Управление локальной установкой доступно в настольном ТХ; аналога в браузере нет.

DCC-клиент соединяет Maya или другое контент-приложение с самостоятельным TACTIC Handler. Handler отвечает за TACTIC, репозитории и чекин, а выбранный DCC-клиент — только за нативные действия со сценой.

Главное разделение ответственности

Работают два самостоятельных процесса:

Владелец За что отвечает
TACTIC Handler Запросы к серверу, Search Types, репозитории, локальная синхронизация, выбор версии, Очередь отправки, чекин и показ ошибок пользователю.
DCC-клиент Информация о текущей сцене, проверка, сохранение, подготовка плейбласта, открытие, импорт, референс, запуск нативных скриптов и возврат фокуса в контент-приложение.

Результат сохранения в DCC — данные для подготовки, а не готовый чекин. Handler получает файлы, помещает их в Очередь отправки и остаётся единственным процессом, который создаёт и загружает снапшоты.

Коннектор принимает только фиксированный список зарегистрированных действий. Handler никогда не отправляет в DCC сгенерированный Python-код, eval или exec.

Подключение Maya

Используйте установленную запускалку или вызовите ту же публичную точку входа из Maya:

import importlib
import sys

HANDLER_PATH = "D:/TACTIC-Handler"
if HANDLER_PATH not in sys.path:
    sys.path.insert(0, HANDLER_PATH)

from tactic_handler_dcc import maya
maya = importlib.reload(maya)
maya.startup(HANDLER_PATH)

startup() сразу возвращает управление и выполняет следующую последовательность:

  1. Переиспользует живое подключение Maya, если оно уже существует.
  2. Перезагружает актуальный код коннектора и публичного API без намеренной остановки живого клиента.
  3. Находит запущенный Handler или запускает самостоятельное приложение.
  4. Регистрирует этот процесс Maya и публикует его нативные возможности.
  5. Просит существующее окно Handler выйти на передний план.

Управление жизненным циклом:

maya.status()        # состояние, сообщение и признак подключения
maya.show_handler()  # показать окно подключённого Handler
maya.stop()          # явно закрыть этот коннектор Maya

При закрытии Maya клиент снимается с регистрации. Повторный startup() — штатный способ обновить код коннектора во время разработки. Не вызывайте перед ним stop(), если не хотите специально разорвать соединение.

Выбор нужного клиента

Каждый запущенный DCC-процесс является отдельным клиентом. Селектор в верхней панели Handler показывает приложение, версию, текущую сцену и PID. Выбор принципиален: файловые действия, DCC-скрипты и DCC-триггеры отправляются именно этому client ID.

Перед действием проверьте:

  • показаны ожидаемые приложение и сцена;
  • при нескольких Maya выбран PID нужного процесса;
  • нужная команда доступна у выбранного клиента;
  • Maya не ждёт ответа в окне, спрятавшемся за другим окном Maya.

При открытии селектора Handler обновляет версию приложения и текущую сцену. Пока селектор закрыт, Handler не опрашивает непрерывно каждый DCC-процесс.

Возможности Maya-клиента

Текущий коннектор Maya публикует только те операции, которые действительно умеет выполнять:

Возможность Что делает или возвращает
get_application_info Название Maya, версию и данные процесса.
get_current_scene Текущий путь, тип сцены и расширение.
focus_application Выводит выбранный процесс Maya на передний план.
prepare_scene Читает идентичность сцены и подготовительные метаданные без загрузки файлов.
validate_scene Возвращает условия сцены, необходимые для запрошенного действия.
save_current_scene Сохраняет средствами Maya и возвращает подготовленный результат.
prepare_checkin Сохраняет по финальному пути и возвращает файлы, необязательные превью и данные приложения.
get_temp_playblast Создаёт необязательное временное превью для Очереди отправки.
open_scene Открывает локальную сцену в выбранном процессе Maya.
import_file Импортирует локальный файл средствами Maya.
reference_file Создаёт в Maya референс локального файла.
execute_script_file Запускает явно подготовленный локальный файл скрипта.
execute_custom_script Запускает проверенный синхронизированный скрипт проекта.
create_script_shelf Создаёт или обновляет Maya Shelf из скриптового шелфа Handler.

Недоступного действия нет в меню, а связанная кнопка выключена. Новый DCC не обязан имитировать Maya-команды, которых у него нет.

Открытие, импорт и референс

Все три действия проходят одну и ту же границу ответственности:

  1. Handler определяет выбранный снапшот и файловый объект.
  2. Handler проверяет настроенный репозиторий и получает правильный локальный путь.
  3. Отсутствующий или устаревший файл синхронизируется средствами Handler, вне DCC.
  4. Handler выводит выбранную Maya вперёд, если включено Возвращать фокус после действия открытия.
  5. Handler отправляет open_scene, import_file или reference_file с подготовленным локальным путём.
  6. Maya выполняет нативное действие и возвращает структурированный результат или traceback.

Если Maya спрашивает, сохранять ли изменённую сцену, это нативное окно Maya. Ответьте в самой Maya. Такой вопрос не означает, что Handler потерял запрос, но завершиться запрос сможет только после ответа.

Сохранение и чекин

Обычный чекин сцены остаётся отложенным процессом через Очередь отправки:

  1. Handler запрашивает у выбранного клиента get_current_scene.
  2. Handler готовит контекст, путь репозитория, версию и versionless-файл.
  3. Операция появляется в Очереди отправки, где ещё можно проверить описание, контекст и файлы.
  4. При запуске элемента очереди Handler вызывает prepare_checkin с финальным локальным путём.
  5. Maya сохраняет сцену, создаёт необязательный плейбласт и возвращает подготовительные метаданные.
  6. Handler проверяет полученные файлы, переносит их и создаёт снапшот TACTIC.

Не закрывайте Maya, пока ожидается результат DCC-подготовки. Если Maya сообщила об успехе, а очередь затем завершилась ошибкой, смотрите ошибку очереди: перенос и создание снапшота происходят после нативного сохранения Maya.

Настройки фокуса и сцены находятся в Конфигурация → Сцена Maya.

Общие Maya-хелперы

Сохранённые Maya-скрипты могут напрямую использовать небольшой набор нативных хелперов:

from tactic_handler_dcc import maya

window = maya.get_maya_window()
scene_format = maya.get_current_scene_format()
search_key = maya.get_skey_from_scene()
maya.set_info_to_scene(search_key, "publish")

Эти вызовы читают или меняют состояние Maya. Объекты TACTIC всё равно нужно получать через Handler API.

Запуск сохранённого DCC-скрипта

job = maya.execute_custom_script(
    "tools/runners/save_current_scene",
    project="demo",
    kwargs={"search_key": search_key},
)

Путь задаётся относительно custom_scripts/<project> и не может выйти из этой папки. Если локального скрипта нет или передан refresh_scripts=True, runtime сначала скачивает опубликованные скрипты проекта. Поэтому для обновления обязательно явно указать код проекта.

Скрипт получает:

TACTIC_PROJECT_CODE   # проект именно этого запуска
TACTIC_SCRIPT_KWARGS  # словарь переданных значений

Сам скрипт исполняется в нативном потоке Maya. Его print() и traceback остаются видны в консоли DCC и дублируются в вывод Редактора скриптов. Значение RESULT становится результатом script job.

Работа с TACTIC без зависания Maya

Серверные и репозиторные операции нельзя блокирующе выполнять в UI-потоке Maya. Передайте их Handler:

from tactic_handler_api import get_api

th = get_api()

def load_object():
    obj = th.sobject(search_key)
    return obj.get_info()

operation = th.submit(load_object)

Если результат меняет UI Maya, верните callback в поток Maya явно:

import maya.utils

subscription = operation.on_done(
    print,
    dispatch=maya.utils.executeDeferred,
)

Не вызывайте блокирующие методы объектов и operation.wait() в UI-потоке Maya. Handler выбрасывает BlockingCallError, не позволяя молча заморозить приложение. Долгоживущую подписку на callback нужно закрыть вместе с инструментом-владельцем.

Триггеры DCC-скриптов

DCC-действия в Редакторе триггеров явно помечены приложением: например, открытие Maya, сохранение Maya и референс Maya. Такой триггер:

  • срабатывает только для совпавших приложения и действия;
  • отправляется выбранному подключённому клиенту;
  • выполняет назначенные скрипты в сохранённом порядке;
  • передаёт контекст действия через TACTIC_SCRIPT_KWARGS;
  • показывает вывод и traceback каждого скрипта через вывод Редактора скриптов.

События снапшота в самостоятельном Handler — другие действия. Сохранение снапшота TACTIC не означает, что сработал триггер сохранения Maya, а нативное сохранение Maya само по себе не создаёт снапшот TACTIC.

Скриптовый шелф в Maya

Команда Создать в Maya копирует активный шелф Handler в отдельную вкладку Maya Shelf. Handler предлагает имя и проверяет, существует ли такая вкладка. Обновление заменяет сгенерированные кнопки, а не создаёт дубликат.

Первая кнопка запускает или показывает TACTIC Handler. Остальные сохраняют порядок, подписи, хинты, пути скриптов проекта и отрисованные иконки. Вкладка остаётся после перезапуска Maya.

Диагностика

Симптом Что проверить
Нет подключённых DCC-клиентов Выполните maya.startup(HANDLER_PATH), проверьте maya.status() и Script Editor Maya. Убедитесь, что в sys.path находится эта установка Handler.
Команду получает не та Maya В селекторе верхней панели выберите правильные приложение, сцену и PID.
Действие выключено или отсутствует Клиент не опубликовал нужную возможность. После обновления коннектора переподключите его.
Handler стартовал, но окно не появилось Вызовите maya.show_handler() и проверьте, не заблокирован ли самостоятельный процесс модальным окном.
Открытие бесконечно ждёт Найдите окно Maya с вопросом о сохранении, замене или референсе, в том числе за главным окном. Проверьте request ID в Журнале отладки.
Maya не видит файл Синхронизируйте снапшот в Handler и проверьте репозиторий. DCC-клиенты не скачивают файлы.
Сцена сохранилась, но чекин упал Проверьте в Очереди отправки ошибку переноса или TACTIC после DCC-подготовки.
BlockingCallError Перенесите работу с TACTIC в th.submit(...); не ждите результат в UI-потоке Maya.
Кастомный скрипт не найден Проверьте код проекта, опубликованную серверную копию и относительный путь.
Соединение потеряно Активный runtime переподключается. При состоянии failed повторите startup() и проверьте Handler Server и Журнал отладки.

Что приложить к сообщению об ошибке

  1. Результат maya.status().
  2. Подпись выбранного клиента и PID.
  3. Имя действия и наличие его в списке возможностей.
  4. Событие Журнала отладки и request ID.
  5. Полный вывод и traceback из Script Editor Maya.
  6. Исходный и целевой локальные пути без учётных данных.
  7. Информацию о нативном модальном окне Maya.

Окно TACTIC Handler Server предназначено для низкоуровневой проверки клиентов, возможностей и запросов. Для обычного открытия, сохранения, запуска скриптов и чекина используйте штатный UI.

Добавление нового DCC

Не начинайте с пустого файла — скопируйте готовую заготовку:

tactic_handler_dcc/connectors/_template.py -> tactic_handler_dcc/connectors/nuke.py
tactic_handler_dcc/_template.py            -> tactic_handler_dcc/nuke.py

Подчёркивание скрывает исходные шаблоны от discovery. Дайте обеим копиям одинаковое имя файла. Корневую копию править не надо: она сама найдёт коннектор по имени своего модуля. В коннекторе замените application id template, видимые подписи и тела нативных методов. Пакет самого DCC импортируйте только внутри конструктора или нативных методов — самостоятельный Handler должен безопасно прочитать манифест вне Nuke, Houdini или Blender.

После добавления файлов перезапустите Handler. DCC_MANIFEST сразу создаст страницу DCC в Конфигурации. После подключения клиента тот же манифест добавит контекстные действия, быстрые кнопки на объектах, команды в меню Инструменты, формы параметров действий, возврат фокуса и события Триггеров скриптов. Править QML, общие меню, Handler Server и контроллер чекина не нужно.

В заготовке перечислены все поддержанные декларации и безопасные заглушки нативных методов. Оставьте только реально поддерживаемые стандартные действия, зарегистрируйте их фиксированные capabilities и заменяйте тела заглушек вызовами API приложения. Действие file получает локальный синхронизированный путь, item — контекст объекта, а scene_checkin входит в общий процесс Очереди отправки Handler. Поля конфигурации и параметров действия могут иметь тип boolean, choice, integer или text.

Полный контракт манифеста и пример для Nuke находятся в docs/dcc_api.md внутри установки.

Подтверждение действий и инструменты

Параметры действия DCC привязаны к клиенту, выбранному при открытии формы. После выбора другого клиента подтверждение отключается; откройте действие заново для него. Handler Server сохраняет нативные запуск и остановку, выбор клиента, зарегистрированные команды, проверку данных, результаты и traceback. Некорректный JSON можно исправить и отправить повторно. Frame меняет представление, права и исполнитель остаются прежними. Инструменты выбранных объектов также сохраняют владельца записи: обычное изменение относится к активному объекту, массовое — к точным выбранным идентификаторам. Во время записи повторная отправка отключена.

Clone this wiki locally