| 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.Pane ¶
tabOfType(type, index=0)
→ hou.PaneTab or None
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
example, use index=0 to return the first found tab, use index=1 to
return the second found tab, etc.
See also hou.ui.paneTabOfType.
currentTab()
→ hou.PaneTab
Return the currently focused pane tab.
See also hou.PaneTab.setIsCurrentTab.
createTab(type)
→ hou.PaneTab
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).
splitHorizontally()
→ hou.Pane
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.
splitVertically()
→ hou.Pane
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.
desktop()
→ hou.Desktop or None
Return the desktop in which this pane exists, or None if it is in
a floating panel that’s not attached to the desktop.
isMaximized()
→ bool
Return True if this pane is maximized.
setIsMaximized(on)
Set the maximized state of this pane.
getSplitParent()
→ hou.Pane or None
Return the parent split pane if the Pane is nested under a split.
getSplitChild(self,index)
→ hou.Pane or None
Return the split child Pane at index if the Pane is a split.
splitSwap()
Swap the left and right panes of an horizontal split Pane. Swap the top and bottom panes of a vertical split Pane.
splitRotate()
Turn an horizontal split Pane into a vertical split Pane.
isSplitMinimized()
→ bool
Return 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.
isSplitMaximized()
→ bool
Return 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.
setIsSplitMaximized(on)
→ bool
Set the maximized state of a split.
isSplit()
→ bool
Return True if the pane is a split.
setSplitFraction(self,fraction)
Set the split fraction of the parent split.
getSplitFraction(self,fraction)
→ double
Return the split fraction of the parent split.
setSplitDirection(self,dir)
Set the split direction of the parent split.
getSplitDirection(self,dir)
→ double
Return the split direction of the parent split.
isShowingPaneTabs()
→ bool
Return True if the Pane is showing pane tabs.
setShowPaneTabs(self,on)
Show or Hide the pane tabs bar.
This method is deprecated in favor of showPaneTabs.
showPaneTabs(self,on)
Show or Hide the pane tabs bar.
isShowingPaneTabsStow()
→ bool
Return True if the Pane is showing the pane tabs stow bar when pane tabs are hidden.
showPaneTabsStow(self,on)
Show or Hide the pane tabs stow bar button when pane tabs are hidden.
qtParentWindow()
→ QWidget
Return a PySide2.QtWidgets.QWidget instance that represents the window
containing the pane.
qtScreenGeometry()
→ QRect
Return the geometry of the pane as a PySide2.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.