hou.FloatingPanel class

A floating window that contains one or more panes.

Much like a desktop, a floating panel contains panes. A floating panel may be attached to a desktop, in which case it is saved with the desktop, hidden when the desktop is closed, and shown when the desktop is opened. You can use floating panels to create desktops that span multiple monitors.

When you create a new floating panel, for example, it contains a single pane, which in turn contains a single pane tab showing the network editor.

Note that a floating panel may be locked to one particular pane tab. These stripped down panels do not display the interface for adding new pane tabs or splitting panes. In fact, these stripped down floating panels do not contain any panes at all, and hou.FloatingPanel.panes will return an empty tuple. You can create such a stripped down floating panel with hou.Desktop.createFloatingPaneTab.

See hou.Desktop for more information about panes and pane tabs.

Methods

name(self) → str

Return the name of the floating panel. The panel’s name is displayed in its window’s title.

setName(self, name)

Set this panel’s name. Any characters in the name that are not letters, numbers, or underscores are replaced with underscores.

Raises hou.OperationFailed if the name is an empty string.

panes(self) → tuple of hou.Pane

Return all the panes inside the panel. As mentioned in the documentation for this class, a floating panel may be stripped down and locked to one particular pane tab, and these stripped down floating panels do not contain any panes.

paneTabs(self) → tuple of hou.PaneTab

Return all the pane tabs that are in this floating panel, regardless of which pane they are in.

paneTabOfType(self, type, index=0) → hou.PaneTab or None

Find and return the pane tab with the desired type or None if no such pane tab exists.

type	A hou.paneTabType enumerated variable.
index	If there are multiple tabs with the desired type, this parameter determines which one is returned. Use `index=0` to return the first found tab, `index=1` to return the second found tab, etc. By default, index is 0.

findPaneTab(self, name) → hou.PaneTab or None

Return the pane tab with the given name, or None if no such tab exists.

close(self)

Close the floating panel’s window, closing all the pane tabs inside it.

isAttachedToDesktop(self) → bool

Return whether or not this panel is attached to the desktop. Panels attached to the desktop are saved with the desktop and are opened when the desktop is opened and closed when the desktop is closed.

attachToDesktop(self, on)

Attach this panel to the desktop. See hou.FloatingPanel.isAttachedToDesktop for more information.

containsPlaybar(self) → bool

Return whether or not this panel contains Houdini’s playbar.

setContainsPlaybar(self, on)

If on is True, move Houdini’s playbar to this panel. Otherwise, move it back to the main desktop window.

containsShelf(self) → bool

Return whether or not this panel contains Houdini’s shelf.

setContainsShelf(self, on)

If on is True, move Houdini’s shelf to this panel. Otherwise, move it back to the main desktop window.

containsStatusBar(self) → bool

Return whether or not this panel contains Houdini’s status bar (the bar at the bottom of the desktop for status messages).

setContainsStatusBar(self, on)

If on is True, move Houdini’s status bar to this panel. Otherwise, move it back to the main desktop window.

containsMenuBar(self) → bool

Return whether or not this panel contains Houdini’s main menu bar.

setContainsMenuBar(self, on)

If on is True, move Houdini’s main menu bar to this panel. Otherwise, move it back to the main desktop window.

isFullscreen(self) → bool

Return whether or not this panel is in fullscreen mode.

setIsFullscreen(self, on)

Set whether or not this panel is in fullscreen mode.