Docs Core

PaneSearchRegistry

Publish a control into the find bar of every network editor pane: it sits beside the bar's own Home toggle, one copy per pane, and appears in panes opened later too.

◈ Core

Pane Search Registry

Every network editor pane has a find bar, the one that opens with the search field, the arrows and the Home toggle. TouchDesigner builds it per pane the first time that pane opens it. This registry makes the bar extensible: a tool publishes a panel COMP and a copy of it appears in every pane's find bar, after Home.

Each pane gets its own copy, so a control can keep state per pane. A pane that opens its find bar later gets the copies too. /ui is never saved with a project, so the copies are rebuilt on every load.

It ships as its own core package, promoted to /sys (global shortcut op.FNS_PANESEARCHREGISTRY), alongside the other surface registries. It adds controls to the bar and nothing else: the search itself is left to the bar, or to a tool that replaces it, like SearchFix.

With nothing contributed, every find bar stays as TouchDesigner made it.

For tool authors

A tool that wants a control in the find bar ships a small host copy of this registry, the same shape as a toolbar or navbar entry. The host's Registration page names the contribution: the panel COMP, a canonical name, its order among the contributions, and whether it is displayed.

From Python, op.FNS_PANESEARCHREGISTRY.RegisterWidget(panel, 'mytool', order=10) does the same, with UnregisterWidget() to take it out and RefreshWidget() to replace every pane's copy after the panel changed. Instance(findbar, 'mytool') returns the copy in one pane's find bar.

The copy lives inside the find bar, so a script in it reaches the bar's own operators with me.parent(2) from a DAT inside the panel: the search field is search/text1, the network the pane shows is in path.

Parameters

Registration

ControlType / defaultWhat it does
Widget COMPComp operator.. Panel COMP published as every find bar widget. Defaults to the parent component.
Canonical NameCanonicalname textempty Unique name for this widget in the find bar registry.
Callback DATCallback operatorempty Optional DAT with find bar callbacks for this widget.
Auto-registerAutoregister on / offoff When on, keep this widget published into the find bar registry while this component exists.
RegisterRegister button Publish once into the find bar registry, even if Auto-register is off.
UnregisterUnregister button Take this tool's contribution back out of the registry and turn Autoregister off, so it stays out. Register puts it back.
Registration StatusRegstatusread-only textempty Read-only status of this host registration.
Toolbar OrderMenuorder number-1 Preferred order among registered widgets, managed by the global registry. -1 = no preference (append at the end).
DisplayedDisplayed on / offon Default visibility of the widget in every find bar (managed by the global registry).
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.

Edit this page on GitHub →