Docs Core

HubRegistry

The registry behind Hub's tab bar: tools contribute native panels, viewers or parameter pages as hub tabs. The raw master, promoted to /sys.

◈ Core

Hub Registry

The raw registry that decides what Hub shows: one entry per tab, with its label, order, visibility and what it renders. The hub itself draws whatever this registry says, and the registry injects one mirror or viewer per entry into the hub's tab area, prunes the ones whose tool is gone, and heals the rest.

It ships as its own core package, promoted to /sys (global shortcut op.FNS_HUBREGISTRY), alongside the six surface registries, Console and Updater. The hub is its UI.

For tool authors

A tool that wants a hub tab ships a small host copy of this registry and registers itself on load, the same shape as a toolbar or navbar entry. The host's Registration page names the tab:

Tool COMP: the contributing tool (defaults to the host's parent).
Tab Content: what to show: empty for the tool itself (it must be a panel), a panel COMP inside the tool (mirrored, so it can live anywhere), or a DAT/CHOP/TOP/SOP/POP (an OP Viewer).
Tab Parameters: a page scope instead: a Parameter COMP view of the tool (* for every page).
Show in Hub / Shown in Hub / Tab Label / Tab Order / Help URL: the usual publishing controls; Shown in Hub is what the hub's close button writes back to, so a hidden tab stays hidden across projects.

From Python, op.FNS_HUBREGISTRY.RegisterTab(comp, 'mytool', content=panel, label='My Tool', order=50) does the same; Tabs(), SetTabDisplayed(), Open(tab=) and OpenDocs() are the rest of the API. A component that must know when its tab is shown (a Web Render, say) implements OnHubExposure(exposed) on its extension; a palette Web Browser has its Active switched for it.

Get it

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

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

Parameters

Registration

Control	Type / default	What it does
Tool COMP`Comp`	operator..	The tool that contributes this tab. Defaults to the parent component (the host lives inside the tool it publishes).
Canonical Name`Canonicalname`	textempty	Unique name of the tab (letters, digits, _ -). It names the hub's mirror (hubtab_). Leave empty to use the tool COMP name.
Tab Content`Tabcontent`	operatorempty	What the tab shows. Empty = the tool COMP itself (it must be a panel). A panel COMP anywhere inside the tool is mirrored into the hub; a DAT/CHOP/TOP/SOP/POP is shown through an OP Viewer. Ignored when Tab Parameters is set.
Tab Parameters`Tabparams`	textempty	Show a parameter view of the tool COMP instead of a panel: the page scope to display (e.g. 'Settings', or * for every page). Empty = not a parameter tab.
Show in Hub`Autoregister`	on / offon	Publish this tab into FNS_Hub while the component exists. Off = the tool shows nothing in the hub and its panel stays wherever it lives.
Register`Register`	button	Publish once into the hub, even if Show in Hub is off.
Unregister`Unregister`	button	Take this tool's contribution back out of the registry and turn Autoregister off, so it stays out. Register puts it back.
Registration Status`Regstatus`read-only	textempty	Read-only status of this host registration.
Shown in Hub`Displayed`	on / offon	Show this tab on the hub's tab bar. Off keeps the tab registered but hidden. The hub's tab manager can show it again.
Tab Label`Tablabel`	textempty	What the hub's tab bar shows. Empty = the canonical name.
Tab Order`Taborder`	number50	Position in the hub's tab bar; the surface configurators sit at 10/20/30, the console viewer at 90; contributions default to 50 and sort by label within an order.
Help URL`Helpurl`	textempty	The tool's wiki/help page; the hub offers it on the tab. Leave empty to skip.
Promote Parameters`Promotepars`	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 Heal`Presaveheal`	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.

Hub

Control	Type / default	What it does
Open Hub`Open`	button	Open FNS_Hub (the toolkit's one-stop manager window) on this host's tab.

What it adds to a registered tool

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

Control	Type / default	What it does
Show in Hub`Autoregister`	on / offon	Publish this tab into FNS_Hub while the component exists. Off = the tool shows nothing in the hub and its panel stays wherever it lives.
Register`Register`	button	Publish once into the hub, even if Show in Hub is off.
Unregister`Unregister`	button	Take this tool's contribution back out of the registry and turn Autoregister off, so it stays out. Register puts it back.
Registration Status`Regstatus`read-only	textempty	Read-only status of this host registration.
Shown in Hub`Displayed`	on / offon	Show this tab on the hub's tab bar. Off keeps the tab registered but hidden. The hub's tab manager can show it again.
Tab Label`Tablabel`	textempty	What the hub's tab bar shows. Empty = the canonical name.
Tab Order`Taborder`	number50	Position in the hub's tab bar; the surface configurators sit at 10/20/30, the console viewer at 90; contributions default to 50 and sort by label within an order.

Edit this page on GitHub →