Docs Core
PaneTypeRegistry
Named, persistent pane-type entries for TD's panebar: any COMP can appear in the pane-type dropdown and be recalled with configurable owner, type, window actions and callbacks.
◈ Core
Pane Type Registry
TouchDesigner's pane bar has a dropdown for switching a pane between Network Editor, Geometry Viewer, Panel and the rest. This registry lets a COMP join that list as a named, persistent entry: pick it from the dropdown and the pane becomes that thing, with the owner, pane type, window behaviour and callbacks the entry declares.
The point is that it survives. An entry is recalled by name, so the pane setup you reach for every session, split, navigated and configured, is one dropdown pick away.
It ships as its own core package, always installed,
promoted to /sys with the global shortcut op.FNS_PANETYPEREGISTRY.
For tool authors
A tool that wants its UI available as a pane type ships a host copy of this registry and registers on load, declaring which COMP is shown, what pane type to use, and any window actions or callbacks that should fire on recall. Entries appear in the dropdown for every pane, and right-clicking the pane-type menu reaches the registered rows.
Get it
Tick it on the install page and it installs with the rest of your setup and stays up to date.
Download FNS_PaneTypeRegistry.tox Version 3.2.6, the tool on its own. It works in any project, and this copy never updates itself.
Parameters
Registration
| Control | Type / default | What it does |
|---|---|---|
COMPComp |
operator.. | COMP to register as the pane owner. Defaults to parent (..). PANEL requires a Panel COMP (isPanel); other pane types accept any COMP. |
Canonical NameCanonicalname |
textempty | Name shown in the panebar menu. Leave empty to use the host COMP name. |
CallbackCallback |
operatorempty | Optional Text DAT with onPaneRecall(ctx). Invoked after built-in recall actions. Use Create Callback for a skeleton. |
Create CallbackCreatecallbacks |
button | Create a callbacks Text DAT with a default onPaneRecall(ctx) skeleton and assign it to Callback. Will not overwrite non-empty existing callbacks text. |
Auto-registerAutoregister |
on / offoff | When on, register the host COMP immediately and keep recall flags / callback in sync when settings change. When off, use Register or Python RegisterPanel. |
RegisterRegister |
button | Register the host COMP now (even if Auto-register is off). Validates COMP type against Pane Type. |
UnregisterUnregister |
button | Take this tool's contribution back out of the registry and turn Autoregister off, so it stays out. Register puts it back. |
StatusRegstatusread-only |
textIdle | Read-only status of host auto-registration (Idle, Registered, Skipped under /sys or /ui, Error). |
Menu OrderMenuorder |
number-1 | Preferred order among registered panebar entries. -1 = no preference (append, default). 0 = first among custom entries, 1 = second, and so on. Built-in rows are not moved. |
Pane TypePanetype |
menuPanel | Pane type applied when this entry is selected in the panebar. PANEL is typical for containerCOMP UIs. |
| Default Actions | ||
Set OwnerSetowner |
on / offon | When on, set the pane owner to the registered COMP when this entry is selected. |
Change TypeChangetype |
on / offon | When on, change the pane to the selected Pane Type. changeType returns a new Pane object; Maximize/Float/Callback run after. |
MaximizeMaximize |
on / offoff | When on, maximize the pane after recall (pane.maximize = True). |
Tear AwayTearaway |
on / offoff | When on, tear the pane into a floating window after recall (pane.tearAway()). |
FloatFloat |
on / offoff | Open the registered COMP in a floating window. PANEL/Geometry/TOP/CHOP -> openViewer(); PARAMETERS -> openParameters(); Network Editor and other tool types -> showInPane Floating. |
Open ParametersOpenparameters |
on / offoff | When on, open a floating parameter dialog for the registered COMP (op.openParameters()). Available for any pane type. |
Promote ParametersPromotepars |
on / offon | When on, the host mirrors its key Registration parameters onto the parent tool as a bound 'Registry' page. Turn off before shipping a tool that should not expose registry controls. |
Pre-Save HealPresaveheal |
on / offon | Before each project save, re-check this registry: update entries whose component moved, drop entries whose component is gone, and republish a host that initialised before the global registry existed. Off skips the sweep for this registry only. |
About
| Control | Type / default | What it does |
|---|---|---|
View ReadmeViewreadme |
button | Open the PaneTypeRegistry developer README as a styled markdown annotate in this network (uses the bundled md viewer). |
What it adds to a registered tool
Every tool that registers gets these on its own Registry page.
| Control | Type / default | What it does |
|---|---|---|
Auto-registerAutoregister |
on / offoff | When on, register the host COMP immediately and keep recall flags / callback in sync when settings change. When off, use Register or Python RegisterPanel. |
RegisterRegister |
button | Register the host COMP now (even if Auto-register is off). Validates COMP type against Pane Type. |
UnregisterUnregister |
button | Take this tool's contribution back out of the registry and turn Autoregister off, so it stays out. Register puts it back. |
StatusRegstatusread-only |
textIdle | Read-only status of host auto-registration (Idle, Registered, Skipped under /sys or /ui, Error). |
Menu OrderMenuorder |
number-1 | Preferred order among registered panebar entries. -1 = no preference (append, default). 0 = first among custom entries, 1 = second, and so on. Built-in rows are not moved. |