This class is currently very simple, implementing a minimal number of methods necessary to support compositing shelf tools. It does not currently allow programmatic control of most functions available in the UI.
You should probably avoid using this object. If you are writing custom tools for the compositing view, the higher-level functions in the
cop2toolutils module are more useful.
Returns the name of the tool currently in use in the view. This is an internal, undocumented designation but usually corresponds to the name of a node. You can change to a different tool using setCurrentState.
Switch to the view tool.
Sets the currently active tool in the view.
state is a string containing an internal, undocumented designation. See currentState().
Methods from hou.PaneTab
Return the name of this tab.
Set the name of this pane tab. A pane tab name may contain spaces.
Note that this name is the internal name of the tab, and is different from the label displayed in the interface.
→ hou.paneTabType enum value
Return the type of this tab (i.e. whether it is a scene viewer, parameter editor, network editor, etc.).
Create a new pane tab of the given type, replace this tab with it, and return the new pane tab. Use the returned pane tab afterward; references to this tab become invalid.
Close the pane tab.
→ hou.Pane or
Return the pane in the desktop that contains this pane tab. Note that pane tabs in regular floating panels are always in a pane, since regular floating panels contain one or more panes.
However, some floating panels have their content stripped down to only contain one particular pane tab type, and do not display the user interface to add more pane tabs, split the pane, etc. This method returns None for these stripped down floating panels.
→ hou.FloatingPanel or
Return the floating panel that contains this pane tab or None if the pane tab is not in a floating panel.
Return whether this tab is the selected tab in the containing pane.
Set this tab as the selected tab in the containing pane.
Return whether this pane tab is in a floating panel.
This method can be approximately implemented as follows:
def isFloating(self): return self.pane() is None or self.pane().floatingPanel() is not None
Create a floating copy of the pane tab and return the cloned pane tab. The new pane tab is in a new floating panel.
Set the link group membership of this pane tab.
Return whether this pane tab is pinned. This method is equivalent to
(self.linkGroup() == hou.paneLinkType.Pinned)
See also hou.PaneTab.linkGroup().
If pin is
True, set the link group membership to hou.paneLinkType.Pinned.
Otherwise, set it to hou.paneLinkType.FollowSelection. This method can be
implemented using hou.PaneTab.setLinkGroup() as follows:
def setPin(self, pin): if pin: self.setLinkGroup(hou.paneLinkType.Pinned) else: self.setLinkGroup(hou.paneLinkType.FollowSelection)
See also hou.PaneTab.setLinkGroup().
Return a 2-tuple containing the pane tab’s width and height.
The width and height include the content area, network navigation control area (if any) and borders.
The width and height do not include the pane tab’s tab area.
Return a 2-tuple containing the pane tab’s content area width and height.
The width and height do not include the network navigation control area (if any), pane tab borders or tab area.
Methods from hou.PathBasedPaneTab
setCurrentNode(node, pick_node = True)