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.Pane
→ tuple of hou.PaneTab
Return the pane tabs in this pane.
→ hou.PaneTab or
Find and return a pane tab with the desired type, or
None if no such tab
exists in the pane.
If there are multiple tabs in the pane with the desired type, then the
first found tab is returned. Use
index to return the other tabs. For
index=0 to return the first found tab, use
return the second found tab, etc.
See also hou.ui.paneTabOfType().
Return the currently focused pane tab.
See also hou.PaneTab.setIsCurrentTab().
Create a new pane tab with the desired type and return it. The new pane tab will be current (i.e. it will be the pane tab that’s open).
Split the pane, adding a new pane to the right, and return the new pane. The new pane will have a single tab whose type is the same as the type of this pane’s current tab.
See also hou.Pane.splitVertically().
Split the pane, adding a new pane to the bottom, and return the new pane. The new pane will have a single tab whose type is the same as the type of this pane’s current tab.
See also hou.Pane.splitHorizontally().
→ hou.Desktop or
Return the desktop in which this pane exists, or
None if it is in
a floating panel that’s not attached to the desktop.
True if this pane is maximized.
Set the maximized state of this pane.
→ hou.Pane or
Return the parent split pane if the Pane is nested under a split.
→ hou.Pane or
Return the split child Pane at index if the Pane is a split.
Swap the left and right panes of an horizontal split Pane. Swap the top and bottom panes of a vertical split Pane.
Turn an horizontal split Pane into a vertical split Pane.
Return the true if the Pane is minimized on the split. A split can’t be minimized and maximized at the same time. In its default state, a split is not minimized and not maximized.
Return the true if the Pane is maximized on the split. A split can’t be minimized and maximized at the same time. In its default state, a split is not minimized and not maximized.
Set the maximized state of a split.
Return True if the pane is a split.
Set the split fraction of the parent split.
Return the split fraction of the parent split.
Set the split direction of the parent split.
Return the split direction of the parent split.
Methods from hou.PathBasedPaneTab
setCurrentNode(node, pick_node = True)