hou.Desktop class

Class representing a Houdini desktop (a pane layout).

All

Methods

Replaces

Methods

createFloatingPane(self, pane_tab_type, position=(), size=()) → hou.PaneTab

Create and return a new floating window of the given type.

Position	A tuple of two floats specifying the X and Y position of the new window, respectively. The window will open near this position, not necessarily exactly at this position.
Size	A tuple of two floats specifying the width and height of the new window, respectively.

displaySideHelp(self, show=True) → hou.PaneTab

Shows or hides the side help pane.

If show is set to True (default) the help pane is displayed and a HelpBrowser object representing the pane is returned. If set to False it is hidden and None is returned.

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

Returns the pane tab matching the given name. If no such tab exists in the desktop, then None is returned.

floatingPaneTabs(self) → tuple of hou.PaneTab

Returns a tuple of the floating pane tabs in the desktop.

homePage(self)

Not implemented yet

name(self) → str

Returns the Desktop’s name.

Each desktop has a unique name. The desktop’s name cannot be changed through either the scripting interface or through Houdini.

paneLinkNumbers(self) → tuple of numbers / None

Not implemented yet

panes(self) → tuple of hou.Pane

Returns a tuple of the panes contained in the desktop.

panesInLinkNumber(self, number) → tuple of hou.Pane

Not implemented yet

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

Finds and returns the pane tab with the desired type. If no such tab exists in the desktop, returns None.

If there are multiple tabs in the desktop with the desired type, then the first found tab is returned. Use 'index' to return the other tabs. For example, use index=0 to return the first found tab, index=1 to return the second found tab, etc.

paneTabs(self) → tuple of hou.PaneTab

Returns a tuple of pane tabs that are contained in the desktop. This method does not return floating pane tabs.

pathBasedPaneLinkNumbers(self) → tuple of numbers / None

Not implemented yet

pathBasedPanesInLinkNumber(self, number) → tuple of hou.Pane

Not implemented yet

sceneViewers(self) → tuple of hou.SceneViewer

Not implemented yet

setAsCurrent(self)

Not implemented yet

setHomePage(self, home_page)

Not implemented yet

setPathForAllPanes(self, path)

Not implemented yet

shelfDock(self) → hou.ShelfDock

Returns the shelf dock for the current desktop.

Replaces

desk command , helpbrowser command , pane command , panepath command , viewls command