Docs Core

ToolbarRegistry

The toolbar surface registry and mirror rail. The raw master, promoted to /sys; clone it to put your own tools on the bar.

◈ Core

Toolbar Registry

The raw registry behind the FNS toolbar: which widgets sit on the bar, in what order, and which of them are shown. That state lives here and in no per-widget parameter, which is why installing or removing a tool never leaves a hole or a dead button behind.

It also owns the mirror rail: the registry keeps TouchDesigner's own bookmark bar (/ui/dialogs/bookmark_bar) in step with the registered set, so the bar you see is a reflection of the registry; no button COMPs are copied in.

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

Open the Toolbar tab of Hub (the FNS button in the main-menu bar) to reorder, group, hide/show and add dividers between widgets; the layout is saved and follows you across projects through ConfigRegistry.

For tool authors

A tool that wants a place on the bar ships a small host copy of this registry alongside its widget and registers itself on load, which is all the installing it needs. Dropping any panel COMP on the FNS button stamps that host into it for you, which is the quickest way to put your own tool on the bar.

Get it

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

Download FNS_ToolbarRegistry.tox Version 3.2.6, 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.
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 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.
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 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.

Edit this page on GitHub →