Docs Core

NavbarRegistry

The pane-bar surface registry. The raw master, promoted to /sys; clone it to add your own pane-bar widgets.

◈ Core

The raw registry behind the pane-bar tools (ParentHierarchy, iopBrowser and CustomParTools): which widgets appear in TouchDesigner's pane bars, their order, which side they sit on, and whether they are shown.

There are several pane bars: TD gives every pane its own, plus a default used for new ones. The registry handles that for you: registered entries are stamped into the default pane bar and into each live pane bar, so a widget you add shows up in every pane and in panes you open later.

It ships as its own core package, always installed, promoted to /sys with the global shortcut op.FNS_NAVBARREGISTRY.

As a user you interact with the Navbar tab of Hub (the FNS button in the main-menu bar), where you reorder items, flip one between the left and right side, and show or hide it. The layout roams with your config through ConfigRegistry.

For tool authors

A tool that wants a pane-bar widget ships a host copy of this registry and registers on load. Dropping any panel COMP on the FNS button registers it as its own self-installing navbar package.

Get it

Tick it on the install page and it installs with the rest of your setup and stays up to date.

Download FNS_NavbarRegistry.tox Version 3.2.5, the tool on its own. It works in any project, and this copy never updates itself.

Parameters

Registration

ControlType / defaultWhat it does
Widget COMPComp operator.. Panel COMP published as the toolbar widget. Defaults to the parent component.
Canonical NameCanonicalname textempty Unique name for this widget in the global toolbar registry.
Callback DATCallback operatorempty Optional DAT with toolbar callbacks for this widget.
Auto-registerAutoregister on / offoff When on, keep this widget published into the global toolbar registry while this component exists.
RegisterRegister button Publish once into the global toolbar 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.
Navbar OrderMenuorder number-1 Preferred order among registered widgets, managed by the global registry. -1 = no preference (append at the end).
Navbar SideAlign menuRight Which side of the pane bar's path area this item docks to. Left sits after TD's own left-hand icons; right sits between the path area and TD's right-hand icons.
Options: Left, Right
Item KindKind menuWidget What the registered COMP is. Widget: a panel placed in the bar's left/right flow. Overlay: an out-of-flow panel (e.g. a click-through layer over the path cells), shown but never re-ordered. Logic: a non-panel COMP that just needs a running copy inside every pane bar.
Options: Widget, Overlay, Logic
DisplayedDisplayed on / offon Default visibility of the widget in the toolbar (managed by the global registry).
Bar WidthBarwidth number0 Width of this widget in the toolbar. 0 = auto (follow the widget). Persisted here; the registry writes manager edits back.
Help URLHelpurl textempty The tool's wiki/help page opened from the Configurator (right-click the Name cell). Leave empty to auto-discover from a docsHelper COMP (its Url par) inside the registered panel or its parent.
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.

What it adds to a registered tool

Every tool that registers gets these on its own Registry page.

ControlType / defaultWhat it does
Auto-registerAutoregister on / offoff When on, keep this widget published into the global toolbar registry while this component exists.
RegisterRegister button Publish once into the global toolbar 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.
Navbar OrderMenuorder number-1 Preferred order among registered widgets, managed by the global registry. -1 = no preference (append at the end).
Navbar SideAlign menuRight Which side of the pane bar's path area this item docks to. Left sits after TD's own left-hand icons; right sits between the path area and TD's right-hand icons.
Options: Left, Right
DisplayedDisplayed on / offon Default visibility of the widget in the toolbar (managed by the global registry).

Edit this page on GitHub →