| Inheritance |
|
Methods ¶
Scene Graph Primitives ¶
showClassPrimitives()
→ bool
Return the state of the toggle on the Scene Graph Tree toolbar that controls whether class specifier USD primitives appear in the tree.
setShowClassPrimitives(show)
Set the state of the toggle on the Scene Graph Tree toolbar that controls whether class specifier USD primitives appear in the tree.
showInactivePrimitives()
→ bool
Return the state of the toggle on the Scene Graph Tree toolbar that controls whether inactive USD primitives appear in the tree.
setShowInactivePrimitives(show)
Set the state of the toggle on the Scene Graph Tree toolbar that controls whether inactive USD primitives appear in the tree.
showInvisiblePrimitives()
→ bool
Return the state of the toggle on the Scene Graph Tree toolbar that controls whether invisible USD primitives appear in the tree.
setShowInvisiblePrimitives(show)
Set the state of the toggle on the Scene Graph Tree toolbar that controls whether invisible USD primitives appear in the tree.
showOverPrimitives()
→ bool
Return the state of the toggle on the Scene Graph Tree toolbar that controls whether pure override USD primitives appear in the tree.
setShowOverPrimitives(show)
Set the state of the toggle on the Scene Graph Tree toolbar that controls whether pure override USD primitives appear in the tree.
showPrototypePrimitives()
→ bool
Return the state of the toggle on the Scene Graph Tree toolbar that controls whether implicit prototype primitives appear in the tree.
setShowPrototypePrimitives(show)
Set the state of the toggle on the Scene Graph Tree toolbar that controls whether implicit prototype primitives appear in the tree.
showLayerInfoPrimitives()
→ bool
Return the state of the toggle on the Scene Graph Tree toolbar that controls whether Houdini Layer Info primitives appear in the tree.
setShowLayerInfoPrimitives(show)
Set the state of the toggle on the Scene Graph Tree toolbar that controls whether Houdini Layer Info primitives appear in the tree.
showHiddenInUiPrimitives()
→ bool
Return the state of the toggle on the Scene Graph Tree toolbar that controls whether primitives configured to be hidden in the UI should appear in the tree.
setShowHiddenInUiPrimitives(show)
Set the state of the toggle on the Scene Graph Tree toolbar that controls whether primitives configured to be hidden in the UI appear in the tree.
Scene Graph Tree Columns ¶
allColumns()
→ tuple
of str
Return a tuple of strings with the symbolic names of all the columns that can be enabled in the scene graph tree. This corresponds to the set of all columns listed under the scene graph tree settings menu.
visibleColumns()
→ tuple
of str
Return a tuple of strings with the symbolic names of all the columns that are currently enabled in the scene graph tree. This corresponds to the set of columns listed under the scene graph tree settings menu that are checked.
setVisibleColumns(columns)
Return a tuple of strings with the symbolic names of all the columns that are currently enabled in the scene graph tree. This corresponds to the set of columns listed under the scene graph tree settings menu that are checked.
Scene Graph Tree Filtering ¶
filterPattern()
→ str
Return the current value set in the scene graph tree filter field. Only primitives that match this pattern (and their ancestor primitives) appear in the scene graph tree. This pattern supports all the standard primitive pattern matching capabilities described in Primitive matching patterns.
setFilterPattern(pattern)
Set the pattern string in the scene graph tree filter field.
Scene Graph Tree Expansion ¶
expandedPrimitives(include_leaf_primitives=False)
→ list
of pxr.Sdf.Path
Return a list of scene graph locations that are expanded in the scene graph tree. If include_leaf_primitives is True, all children of expanded primitives will also be returned in the list, effectively returning a list of all visible primitives in the tree. Otherwise only primitives that are actually expanded are returned, meaning that no leaf primitives (which have no children) will ever be returned in this mode.
collapsePrimitives(paths)
Collapse the scene graph tree locations indicated by the strings or pxr.Sdf.Path objects in the iterable paths parameter. Descendants of these primitives will no longer be visible in the tree. If a primitive in paths is not currently visible or is already collapsed, the tree will not change.
expandPrimitives(paths, collapse_others=False, expand_leaf_primitives=False)
Expand the scene graph tree such that the locations indicated by the strings or pxr.Sdf.Path objects in the iterable paths parameter are visible. If collapse_others is True, all scene graph tree locations will be collapsed before expanding any primitives, leaving the tree in a state where exactly the provided list of scene graph locations will be visible. If expand_leaf_primitives is True, then the tree will be expanded such that all the primitives in the paths object will not just be made visible, but will be expanded, making all of their children visible as well.
Collections Tree ¶
splitPosition()
→ float
Return a number indicating the position of the splitter bar that separates the scene graph tree from the collection tree. The value will between -1.0 and 2.0. Any value between 0.0 and 1.0 indicates that both panes are visible, and the value indicates the proportion of the space taken up by the collection tree (i.e. the value reflects the distance of the splitter bar from the bottom of the pane).
A value greater than 1.0 indicates that the splitter bar is at the top of the pane, hiding the scene graph tree. Subtracting 1.0 from the value indicates the position of the splitter bar before the scene graph tree was collapsed.
A value less than 0.0 indicates that the splitter bar is at the bottom of the pane, hiding the collection tree. Adding 1.0 to the value indicates the position of the splitter bar before the collection tree was collapsed.
setSplitPosition(position)
Set the position of the splitter bar that separates the scene graph tree from the collection tree. This value must be between -1.0 and 2.0. See splitPosition for a description of the meaning of the position value.
collectionPrimitives()
→ str
Return the string pattern that controls which USD primitives are searched to populate the collection panel at the bottom of the scene graph tree.
setCollectionPrimitives(pattern)
Set the string pattern that controls which USD primitive are searched to populate the collection panel at the bottom of the scene graph tree.
Collection Tree Filtering ¶
collectionFilterPattern()
→ str
Return the current value set in the collection tree filter field. Only collections and selection rules that match this pattern (and their ancestors) appear in the collection tree. This pattern uses standard Houdini string matching techniques to test each entry in the tree.
setCollectionFilterPattern(pattern)
Set the pattern string in the collection tree filter field.
Methods from hou.PaneTab ¶
name()
→ str
Return the name of this tab.
setName(name)
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.
type()
→ hou.paneTabType enum value
Return the type of this tab (i.e. whether it is a scene viewer, parameter editor, network editor, etc.).
setType(type)
→ hou.PaneTab
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()
Close the pane tab.
pane()
→ hou.Pane or None
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.
floatingPanel()
→ hou.FloatingPanel or None
Return the floating panel that contains this pane tab or None if the pane tab is not in a floating panel.
isCurrentTab()
→ bool
Return whether this tab is the selected tab in the containing pane.
setIsCurrentTab()
Set this tab as the selected tab in the containing pane.
isFloating()
→ bool
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
clone()
→ hou.PaneTab
Create a floating copy of the pane tab and return the cloned pane tab. The new pane tab is in a new floating panel.
linkGroup()
→ hou.paneLinkType enum value
Return the link group that this pane tab belongs to.
See also hou.PaneTab.isPin.
setLinkGroup(group)
Set the link group membership of this pane tab.
isPin()
→ bool
Return whether this pane tab is pinned. This method is equivalent to
(self.linkGroup() == hou.paneLinkType.Pinned)
See also hou.PaneTab.linkGroup.
setPin(pin)
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.
size()
→ tuple
of int
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.
contentSize()
→ tuple
of int
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.
hasNetworkControls()
→ bool
Return True if this pane tab type supports network controls.
isShowingNetworkControls()
→ bool
Return whether this pane tab is showing its network control bar. Return False if the pane tab doesn’t have network controls. See also hou.PaneTab.hasNetworkControls.
setShowNetworkControls(pin)
Show or Hide the network control bar. Has no effect if the pane tab doesn’t have network controls. See also hou.PaneTab.hasNetworkControls.
This method is deprecated in favor of showNetworkControls.
showNetworkControls(pin)
Show or Hide the network control bar. Has no effect if the pane tab doesn’t have network controls. See also hou.PaneTab.hasNetworkControls.
displayRadialMenu(menu)
Launch the specified radial menu in the pane tab.
qtParentWindow()
→ QWidget
Return a PySide6.QtWidgets.QWidget instance that represents the window
containing the pane tab.
qtScreenGeometry()
→ QRect
Return the geometry of the pane as a PySide6.QtCore.QRect
object. The x and y properties of the returned QRect object
point to the top-left corner of the pane in screen coordinates.
Methods from hou.PathBasedPaneTab ¶
cd(path)
currentNode()
→ Node
pwd()
→ Node
setCurrentNode(node, pick_node = True)
setPwd(node)