Overview
MeshInspector’s user interface is fully represented in the Python API as a hierarchical tree.
Through this structure, you can programmatically navigate the Ribbon, find specific tabs, groups, and tools, and execute actions just as if you clicked them manually.
This article explains:
-
How the UI tree is structured
-
How to list available tabs, groups, and tools
-
How to programmatically open a tab and launch a tool
By the end, you’ll know how to reproduce any sequence of clicks through Python commands.
Understanding the UI Tree
The Ribbon interface is modeled as a tree of elements, each accessible by a path — a list of strings describing its position.
Each node of the tree corresponds to a specific UI element (a tab, button, tool, or group).
Hierarchy Structure
| Level | Element Type | Description | How to Access via API | Example Path |
|---|---|---|---|---|
| 1 | Tab | The top-level sections of the Ribbon — for example, Home, View, Mesh Edit, Mesh Repair. Each tab organizes a collection of tools. | Tabs are listed as buttons inside the RibbonTabs group. |
['RibbonTabs', 'Mesh Repair'] |
| 2 | Tool | The functional unit inside a tab. Tools are buttons that open dialogs or panels (e.g., Mesh Healer, Fill Holes, Remesh). Each tool performs a specific operation. | Access tools of the currently active tab with uiListEntries(['Ribbon']). Activate one using uiPressButton(['Ribbon', '<Tool Name>']). |
['Ribbon', 'Mesh Healer'] |
| 3 | Parameter | The controls within a tool’s dialog — sliders, checkboxes, numeric fields, or sub-buttons that adjust tool behavior. | List them using uiListEntries(['<Tool Name>']). Read or modify with uiReadValue…() / uiWriteValue…(). |
['Mesh Healer', 'Repair Resolution'] |
Listing Available Tabs
You can start by listing all available Ribbon tabs in MeshInspector:
Example Output:
This command gives you all the top-level tabs visible in the UI.
Opening a Tab
To activate a specific tab programmatically, use uiPressButton() with the tab name:
The skipFrames() call ensures the viewer updates before you continue to the next command.
Once a tab is active, you can query its contents — the tools inside it — using the path ['Ribbon'].
Listing Tools in the Active Tab
After opening a tab, use uiListEntries(['Ribbon']) to discover all tools under it:
Example Output:
This gives you a complete inventory of the tools you can interact with.
Finding Where a Tool Lives
Sometimes you may not know which tab a tool belongs to. You can search all tabs programmatically:
Example Output:
Opening a Tool Programmatically
Once you know the correct tab and tool name, you can activate the tool panel directly:
The tool window now appears on the right side of the UI, just as if you clicked it manually.
Understanding Path Naming
Sometimes internal tool names differ slightly from what appears in the interface.
For example:
-
The tool labeled “Section” in the UI may have the internal name “Object Section.”
-
A grouped dropdown might expose tools with prefixes like “##DropDown…”
Best Practice:
Always call uiListEntries() before trying to access or press a button. This ensures you use the correct internal name.
Practical Tip: Refreshing the Viewer
Whenever a script changes the active tab, tool, or parameter, call:
This guarantees that MeshInspector updates its internal state and visuals before continuing to the next command.
Summary
In this article, you learned how to:
-
Explore MeshInspector’s Ribbon tree structure.
-
List all tabs and tools programmatically.
-
Open specific tabs and tools through the Python API.
-
Identify internal tool names to ensure reliable scripting.
These operations form the foundation of UI automation.
In the next guide — Controlling Tools & Parameters — you’ll learn how to inspect, read, and modify the parameters inside a tool once it’s open.