Inheritance |
|
Methods ¶
enableLiveUpdates(on)
Enable or disable live updates for recordings. If live updates is enabled, then statistics are displayed in the statistics viewer and are periodically updated while the performance monitor is recording.
isLiveUpdatesEnabled()
→ bool
Return whether live updates is enabled.
isRecording()
→ bool
Return whether the performance monitor is recording.
isSamplingCookStats()
→ bool
Return whether the sampling of cook statistics is turned on.
isSamplingPDGCookStats()
→ bool
Return whether the sampling of PDG node cook statistics is turned on.
isSamplingErrors()
→ bool
Return whether the sampling of warnings and errors is turned on.
isSamplingFrameStats()
→ bool
Return whether the sampling of frame statistics is turned on.
isSamplingObjectDrawStats()
→ bool
Return whether the sampling of object drawing statistics is turned on.
isSamplingObjectGPUDrawStats()
→ bool
Return whether the sampling of object GPU drawing statistics is turned on.
isSamplingRenderStats()
→ bool
Return whether the sampling of render statistics is turned on.
isSamplingScriptStats()
→ bool
Return whether the sampling of script statistics is turned on.
isSamplingSolveStats()
→ bool
Return whether the sampling of DOP solve statistics is turned on.
isSamplingThreadStats()
→ bool
Return whether the sampling of thread statistics is turned on.
isSamplingViewportStats()
→ bool
Return whether the sampling of viewport statistics is turned on.
objectView()
→ hou.perfMonObjectView enum value
Return the structure type that is used to view objects in the statistics viewer.
sampleCookStats(on)
Turn sampling of cook statistics on or off.
samplePDGCookStats(on)
Turn sampling of PDG node cook statistics on or off.
sampleErrors(on)
Turn sampling of warnings and errors on or off.
sampleFrameStats(on)
Turn sampling of frame statistics on or off.
sampleObjectDrawStats(on)
Turn sampling of object drawing statistics on or off.
sampleObjectGPUDrawStats(on)
Turn sampling of object GPU drawing statistics on or off.
sampleRenderStats(on)
Turn sampling of render statistics on or off.
sampleScriptStats(on)
Turn sampling of script statistics on or off.
sampleSolveStats(on)
Turn sampling of DOP solve statistics on or off.
sampleThreadStats(on)
Turn sampling of thread statistics on or off. Note that turning on thread sampling can add overhead to the processing times (i.e. cook times, solve times, etc.) in the scene.
sampleViewportStats(on)
Turn sampling of object-drawing statistics on or off.
showProfile(profile)
View the given profile in the performance monitor.
setObjectView(view)
Set the structure type to use when viewing objects in the statistics viewer.
setTimeFormat(format)
Set the format to use when viewing times in the statistics viewer.
setTimeUnit(unit)
Set the unit to use when viewing times in the statistics viewer.
startRecording()
Start recording in the performance monitor.
Raises hou.OperationFailed if the performance monitor is already recording.
stopRecording()
Stop recording in the performance monitor.
Raises hou.OperationFailed if the performance monitor is already stopped.
timeFormat()
→ hou.perfMonTimeFormat enum value
Return the format that is used to view times in the statistics viewer.
timeUnit()
→ hou.perfMonTimeUnit enum value
Return the unit that is used to view times in the statistics viewer.
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.