¶ 1. Що це за скрипт і навіщо він
Це візуальний конструктор інтерфейсів для Maya, який дозволяє:
- збирати UI з готових віджетів (Layouts / Controls / Menus / Customs),
- бачити ієрархію (TreeView),
- редагувати властивості вибраного контролу (Property панель),
- автоматично генерувати код (Python або MEL), який відтворює цей UI,
- управляти “output” кодом + окремим блоком “function” коду,
- мати undo/redo на рівні внутрішніх даних проекту.
Формат збереження — .uid (по суті str(self.uidGLData) і потім eval назад).
¶ 2. Архітектура: які основні “шари”
¶ 2.1 Дані (модель)
Головний стан — self.uidGLData:
ctrlSort: порядок контролів (і одночасно їх список)- кожен
ctrlId— ключ уuidGLData, що міститьbaseNode:moduleName,className,procName,ctrlTypeparentList(куди можна підпорядковувати)attrList— список атрибутів (flags), де кожен атрибут має:longName,shortNametype(string, int, color, form, script…)mode:c/s— на створення (create/static)e— edit-параметри (після створення)a— “action” (наприклад dock)
active(включено чи ні)value(значення)
¶ 2.2 UI (вікна/панелі)
Основне вікно UIDesigner.setupUI() створює:
- MenuBar (File: New/Open/Save/Save As, Help)
- Toolbar: new/open/save, undo/redo, режим Python/MEL, debug, window cache, generate options, настройки SFE, refresh preview
- Left pane:
- WidgetBox (пошук + список віджетів з модулів)
- Hierarchy TreeView (ієрархія + тулбар: rename suffix, replace layout, move up/down, cut/copy/paste/delete)
- Middle/Right pane:
- CodeView: вкладки (Output / Function + додаткові кастомні)
- Property: панель властивостей (динамічна під клас контролу)
¶ 2.3 Генерація коду (output)
UIDesigner.sdd_generateCode():
- перевіряє валідність (наприклад formLayout attach* та індекси),
- видаляє старий preview UI,
- генерує або Python (
generatePyCode()), або MEL (generateMelCode()), - підставляє generate options (формат флагів, булевих, відступів, параметри функції/виклику),
- пише код у cmdScrollFieldExecuter (Output) і за потреби “debugStr”,
- для MEL ще й
mm.eval(debugStr).
¶ 3. “Мікро-редактори” (допоміжні вікна)
Це окрема сила цього скрипта: властивості складних типів не редагуються просто полем, а відкривають спеціальний editor.
¶ 3.1 GenerateOptionEditor
Призначення: налаштування правил генерації коду.
Опції:
- Flag: Short Name vs Long Name (тобто
-lчи-label,qvsquery, і т.д.) - Boolean:
True/Falseабо0/1 - Indent: Tab або 4 spaces (увага: у коді є підозрілий баг —
getIndentStr()чомусь дивиться наbooleanType, а неindentType) - Control ID: Need vs Force All (чи завжди друкувати
ctrlId) - UI Function Parameter: параметри функції генерації UI (enable/disable поле)
- Call Function Parameter: параметри при виклику функції наприкінці
Працює як modal dialog через cmds.layoutDialog.
¶ 3.2 AlphaEditor
Призначення: обрати Alpha (0..1) для colorA.
Один slider + OK/Cancel. Повертає float.
¶ 3.3 DockEditor
Призначення: налаштування докінгу (dockControl/toolBar/window).
Поля:
- Dock Type (window/dockControl/toolBar)
- Label
- Area (top/bottom/left/right)
- AllowedArea (checkbox 4 сторони)
Повертає список[type, label, area, allowedAreaList]абоNone.
¶ 3.4 PaletteEditor
Призначення: палітра кольорів (5x5), редагування RGB для кожної клітинки.
Повертає список кольорів формату [idx, r, g, b].
¶ 3.5 IconChooser
Призначення: вибір іконки (з XBMLANGPATH + “Internal Icons”).
Функції:
- рекурсивно сканує папки та фільтрує по форматам
- grid view з
iconTextButton - пошук по назві
- зміна розміру іконок (16/32/64/128/256)
Повертає шлях/ім’я іконки.
¶ 3.6 ToolImageEditor
Призначення: вибір tool context (cmds.lsUI(ctx=1)) і (опційно) іконки для нього.
Режими:
toolImage: повертає[context, icon]tool: повертає тількиcontext
¶ 3.7 ListEditor
Призначення: редагування спискових параметрів типу:
list_int2,list_int,list_string,list_align
Відображає 6–N рядків, кожен з Enable/Disable.
Повертає списки формату:[[index, value], ...]або[[index, v1, v2], ...]
¶ 3.8 FormEditor
Призначення: редагування formLayout прив’язок:
attachFormattachPositionattachControl
UI — “хрест” з Top/Left/Right/Bottom кнопками, де кожна сторона має popup:- None / attachForm / attachPosition / attachControl
і відповідні поля offset/position/control.
Дані зберігаються уchildData[ctrlId][edge]і на кожну зміну викликаєтьсяupDataFunction(...)для live-оновлення property та preview.
¶ 3.9 ScriptEditor
Призначення: редагувати “script” атрибути.
Перемикач:
- Function Address (тобто посилання на функцію)
- String Script (рядок)
Пише уcmdScrollFieldExecuterзst = sourceType.
¶ 4. PropertyDelegate: як будується панель властивостей
PropertyDelegate — це “рендерер” property-панелі для конкретного className.
Він:
¶ 1. бере attrList у baseNode,
¶ 2. створює rowColumnLayout з 3 колонок:
- чекбокс активності,
- label longName,
- контрол редагування значення (типозалежний)
¶ 3. для складних типів відкриває редактори:
colorA→ + AlphaEditorimage→ IconChooser (і можливість enable ручне поле)script→ ScriptEditorform→ FormEditorlist_*→ ListEditortoolImage/tool→ ToolImageEditordock→ DockEditor
Ключове: UIData[longName] = [attrType, activeCtrl, labelCtrl, valueCtrl]
¶ Як зміна в property переходить у модель
valueChangeWrap(longName, attrType, value):- ставить
activeв чекбокс - пише
active/valueу всі вибрані baseNode (якщо multi-select і клас однаковий) - викликає
refreshWindow(), який:sdd_generateCode()sdd_showItemProperty()addUndoAndClearRedo(...)
- ставить
Це робить property панель “живою”: змінив значення → одразу перегенерився UI preview і output code.
¶ 5. Основне вікно UIDesigner: що в ньому важливе для UX
¶ 5.1 Toolbar
- Швидкі дії: New/Open/Save
- Undo/Redo на внутрішніх даних
- Toggle Python/MEL
- Debug mode (показує debugStr)
- Window cache (видаляти windowPref)
- Generate Option (викликає GenerateOptionEditor)
- Settings для cmdScrollFieldExecuter (completion, tooltip, object path completion)
- Refresh preview
¶ 5.2 WidgetBox
- Категорії модулів (
modulesList=['Layouts','Controls','Menus','Customs']) - Пошук по назві
- Клік по віджету → додає його в дерево як baseNode
¶ 5.3 Hierarchy Tree
- Перетягування (dad), expand/collapse, rename label
- Cut/Copy/Paste/Delete
- Move up/down серед siblings
- Replace layout (контекстне меню, якщо модуль має
replace) - Rename suffix (додає суфікс до реальних ctrlId у Maya)
¶ 5.4 CodeView
- Output: згенерований UI код
- Function: окремий блок коду, який додається в кінець output
- Custom tabs: можна створювати додаткові cmd executer вкладки
¶ 6. Генерація Python/MEL: що цікаво в реалізації
- Генерація йде по
ctrlSortу порядку. - Для кожного ctrl:
- формується “parent flag” якщо треба (
checkNeedParentFlag) - додаються create/static флаги (
mode c/s) - edit флаги збираються окремо і генеруються після створення (
mode e) - dock обробляється як окрема “show” логіка
- формується “parent flag” якщо треба (
- Враховуються generateOptions:
- формат назви флагів (short/long),
- bool як int,
- примусова вставка ctrlId,
- параметри функції та виклику.
- Є мапа
CmdTextPosдля швидкого скролу в output код на виділений ctrl у дереві.
¶ 7. Сильні сторони (як продукт)
- Модульність: Widgets підтягуються з модулів (
__all__), легко розширювати. - Typed property editing: складні параметри мають спеціальні редактори (form/script/icon/list).
- Live preview + live output: правка властивості одразу відображається у preview і в коді.
- Multi-select: властивості застосовуються на групу, якщо клас однаковий.
- Підтримка MEL/Python з конвертацією генератора.
- Undo/Redo на рівні проектних даних.
¶ 8. Технічні “червоні прапорці” (корисно знати)
Це не “хейт”, а речі, які як UI Designer 2.0 можна було б полірувати:
¶ 1. Збереження через str(dict) + eval
Це ризиковано і крихко. Краще JSON (або ast.literal_eval мінімум).
¶ 2. Підозрілий баг у відступах
getIndentStr() використовує booleanType замість indentType. Через це Tab/4-space може працювати не як задумано.
¶ 3. Потенційні баги в deleteControl
Там є if(self.child in self.uidGLData) — виглядає як помилка (self.child ніде не видно в класі).
¶ 4. Великий моноліт UIDesigner
Один клас тримає все: UI, дані, генерацію, файлові операції, undo/redo. Для підтримки краще розділити.
¶ 9. Коротке резюме
Цей скрипт — повноцінний UI Builder для Maya, який зберігає проект у власному форматі, дозволяє збирати інтерфейс з компонентів, редагувати атрибути через розумну property-панель і спеціальні редактори, і генерувати готовий Python/MEL код з налаштовуваними правилами форматування.
Як “UI Designer 2.0” він вже має ключові фічі продуктового рівня: дерево, інспектор властивостей, пошук віджетів, прев’ю, генерацію коду, undo/redo, і набір editor-діалогів під складні властивості.