Inheritance |
|
Methods ¶
filterEnabled()
→ bool
Return True if Parameter Editor filtering is enabled.
setFilterEnabled(self,on)
Enable Parameter Editor filtering. hou.parmFilterCriteria.
filterMode()
→ hou.parmFilterMode
Return the Parameter Editor hou.parmFilterMode.
setFilterMode(self,mode)
Set the Parameter Editor filter mode. The hou.parmFilterMode defines on which parameters to apply the filter pattern.
filterCriteria()
→ hou.parmFilterCriteria
Return the Parameter Editor hou.parmFilterCriteria.
setFilterCriteria(self,criteria)
Set the Parameter Editor filter criteria. The hou.parmFilterCriteria defines how the filter pattern is applied to parameters.
filterPattern()
→ str
Return the Parameter Editor filter pattern.
setFilterPattern(self,pattern)
Set the Parameter Editor filter pattern. The filter pattern is applied on a hou.parmFilterCriteria string from parameters that match the hou.parmFilterMode. The pattern matching can use exact name matching or find the pattern within the string. The filter pattern can be a list of pattern separated by commas and can also contain wildcard '*' character.
filterExactMatch()
→ bool
Return True if Parameter Editor filtering uses exact pattern matching.
setFilterExactMatch(self,on)
Set Parameter Editor filtering to use exact pattern matching.
scrollPosition()
→ hou.Vector2
Return the Parameter Editor scroll bars position as percentages.
setScrollPosition(self,pos)
Set Parameter Editor scroll bars position as hou.Vector2 percentages.
scrollTo(parms, scroll_pos)
Adjust the Parameter Editor vertical scroll bar to align one or more parameters using hou.scrollPosition mode.
The parms
argument can be a list
or a single str
, hou.Parm or hou.ParmTuple. The types can also be mixed in the list. If an entry is a str
, you can pass a comma separated list of parameter names but wildcards are not supported.
The scroll_pos
argument defines how to align the vertical bounding box of the affected parameters. See hou.scrollPosition.
moveFocusTo(parm)
Try to move keyboard focus to the specified parameter in the Parameter Editor.
isShowingParmDialog()
→ bool
Return True if the Parameter Editor is currently displaying a parameter dialog (as opposed to, for example, a Python Panel).
setShowParmDialog(self,show)
Set the Parameter Editor to display a parameter dialog if show
is True, and switch to a Python Panel if show
is False.
Raise hou.OperationFailed if the Parameter Editor’s current node has no corresponding Python Panel interface and show
is set to False.
setMultiParmTab(self,parm, tab_index)
Switch a Multi Parameter Tab to a given tab using a parameter name.
multiParmTab(self,parm)
→ int
Returns the currently visible tab index using a parameter name.
visibleParms()
→ tuple
of hou.ParmTuple
Returns the currently visible parameters.
pressJumpButton(parm)
Press the jump button on a parameter. parm
can be a string, a hou.Parm or a hou.ParmTuple.
Return True if it succeeded.
pressPlusButton(parm)
Press the plus button on a parameter. parm
can be a string, a hou.Parm or a hou.ParmTuple.
Return True if it succeeded.
pressScriptActionButton(parm)
Press the script action button on a parameter. parm
can be a string, a hou.Parm or a hou.ParmTuple.
Return True if it succeeded.
pressColorButton(parm)
Press the color button on a parameter. parm
can be a string, a hou.Parm or a hou.ParmTuple.
Return True if it succeeded.
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 PySide2.QtWidgets.QWidget
instance that represents the window
containing the pane tab.
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.
Methods from hou.PathBasedPaneTab ¶
cd(path)
currentNode()
→ Node
pwd()
→ Node
setCurrentNode(node, pick_node = True)
setPwd(node)