Return the current desktop.

Return the desktop with the specified name. Return None if no such desktop exists.

Return all the desktops.

See hou.Desktop.setAsCurrent() for an example.

Returns a hou.RadialMenu object representing the named menu, or None if the menu does not exist.

Returns a tuple of hou.RadialMenu objects representing existing menus.

Creates a new radial menu object with the given name and label.

Return a tuple of all visible pane tabs, including those in all floating windows.

See also hou.Desktop.paneTabs().

Return a tuple of all visible pane tabs that are selected in their containing panes, including those in all floating windows.

See also hou.Desktop.currentPaneTabs().

Return all the pane tabs in floating panels.

See also hou.Desktop.floatingPaneTabs().

Find and return the pane tab with the desired type. If no such tab exists, return None.

type: A hou.paneTabType enumerated variable.

index: If there are multiple tabs with the desired type, this parameter determines which one is returned. Use index=0 to return the first found tab, index=1 to return the second found tab, etc. By default, index is 0.

See also hou.Desktop.paneTabOfType().

Return the pane tab with the given name, or None if no such tab exists.

The name may optionally be prefixed by the desktop name and a period.

See also hou.Desktop.findPaneTab().

Return all the visible floating panels.

See also hou.Desktop.floatingPanels().

Return the hou.Pane object located under the mouse cursor. Return None if no pane is located under the mouse cursor.

This method searches all visible panes including panes not attached to the current desktop.

Similar to hou.ui.paneUnderCursor() but return the hou.PaneTab object instead located under the mouse cursor. Return None if no pane tab is located under the mouse cursor.

This method searches all visible pane tabs including pane tabs not attached to the current desktop.

Pop up a window with a message, OK and Cancel buttons, and wait for the user to press a button. Return True if the user hits OK, otherwise return False. The suppress parameter is used to skip the display of this dialog if the user requested not to be shown this confirmation dialog again. This dialog also presents the user with a check box to indicate that they don’t want to be presented with this dialog in the future.

text: The message to display.

severity: A hou.severityType value that determines which icon to display on the dialog. Note that using hou.severityType.Fatal will exit Houdini after the user closes the dialog.

help: Additional help information to display below the main message.

title: The window’s title. If None, the title is "Houdini".

details: A string containing extra messages that is not visible unless the user clicks "Show Details".

details_label: A string containing the label for the expand/collapse button that controls whether or not the detail text is visible. If details_expanded is set to true this parameter has no effect.

    '''Prompt the user if they want to overwrite a file, and save it if they
choose OK.'''
    if hou.ui.displayConfirmation("Overwrite the current hip file?", suppress=hou.confirmType.OverwriteFile):
        hou.hipFile.save()

Pop up a small window with a message and one or more buttons and wait for the user to press a button. Return the index of the button the user pressed.

text: The message to display.

buttons: A sequence of strings containing the names of the buttons. By default the message window contains a single OK button.

severity: A hou.severityType value that determines which icon to display on the dialog. Note that using hou.severityType.Fatal will exit Houdini after the user closes the dialog.

default_choice: The index of the button that is selected if the user presses enter.

close_choice: The index of the button that is selected if the user presses Escape or closes the dialog.

help: Additional help information to display below the main message.

title: The window’s title. If None, the title is "Houdini".

details: A string containing extra messages that is not visible unless the user clicks "Show Details".

details_label: A string containing the label for the expand/collapse button that controls whether or not the detail text is visible. If details_expanded is set to true this parameter has no effect.

details_expanded: A boolean, if true then the text area where the detail messages appear is always shown and cannot be collapsed. If false, the detail message area is initially folded when the message box is popped up and the user can expand to read the details.

def saveIfNeeded():
'''Prompt the user if they want to save, and save the hip file if they choose Yes.'''
if hou.ui.displayMessage("Save the current hip file?", buttons=("Yes", "No")) == 0:
    hou.hipFile.save()

Pop up a small window with a textbox and wait for the user to enter a line of text. Return a tuple containing an integer and the text they entered. The integer is the index of the pressed button. If close_choice is not None and the user closed the dialog by clicking on its close button or by pressing Escape, then the returned integer is set to close_choice.

message: The message to display above the text field.

buttons: A sequence of strings containing the names of the buttons. By default the message window contains a single OK button.

severity: A hou.severityType value that determines which icon to display on the dialog. Note that using hou.severityType.Fatal will exit Houdini after the user closes the dialog.

default_choice: The index of the button that is selected if the user presses enter.

close_choice: The index of the button that is selected if the user presses Escape or clicks on the dialog’s close button. If there is more than one button and close_choice is None, then the user cannot close the dialog with Escape or the dialog’s close button. If there is only one button and close_choice is None, then the user can close the dialog with Escape or the dialog’s close button, and the button’s index is returned.

help: Additional help information to display below the main message.

title: The window’s title. If None, the title is "Houdini".

initial_contents: The initial contents of the text field. If None, the text field is initially empty.

See also hou.ui.readMultiInput()

Pop up a small window with a textbox and wait for the user to enter a text into several input fields. Return a tuple containing an integer and the tuple of strings they entered, one for each input field. The integer is the index of the pressed button. If close_choice is not None and the user closed the dialog by clicking on its close button or by pressing Escape, then the returned integer is set to close_choice.

message: The message to display above the text field.

input_labels: A sequence of labels to appear in front of each input field. The length of the sequence determines the number of input fields that will appear in the window.

password_input_indices: A sequence of indices of which input fields are password fields. Fields whose index is not in this sequence will not be password fields.

buttons: A sequence of strings containing the names of the buttons. By default the message window contains a single OK button.

severity: A hou.severityType value that determines which icon to display on the dialog. Note that using hou.severityType.Fatal will exit Houdini after the user closes the dialog.

default_choice: The index of the button that is selected if the user presses enter.

close_choice: The index of the button that is selected if the user presses Escape or clicks on the dialog’s close button. If there is more than one button and close_choice is None, then the user cannot close the dialog with Escape or the dialog’s close button. If there is only one button and close_choice is None, then the user can close the dialog with Escape or the dialog’s close button, and the button’s index is returned.

help: Additional help information to display below the main message.

title: The window’s title. If None, the title is "Houdini".

initial_contents: The list that specifies the initial contents of each of the text field. The length of the list does not need to be the same as the number of the input fields. If it is shorter, then initially the remaining input fields will be empty.

See also hou.ui.readInput()

Pop up a window with a file chooser dialog and wait for the user to choose a file name. Return the path to the file that was selected.

start_directory: The directory the dialog should initially start in.

title: The window title for the dialog.

collapse_sequences: Whether sequences of files with common numeric patterns should be collapsed into patterns containing $F.

file_type: A hou.fileType enumerated value to say what type of file to select. The set of visible files is determined by this file type and the pattern.

pattern: Only files matching this pattern (and anything restricted by the file type) will be listed. By default, everything matches the pattern.

default_value: The default contents of the file name field in the dialog.

multiple_select: Whether the user may select multiple files.

image_chooser: Whether the dialog shows image thumbnails.

chooser_mode: A hou.fileChooserMode enumeration value to say if the user is being prompted for a file to read from, write to, or either.

Pop up a window with a set of choices in a list box and prompt the user to choose zero or more of them. If selection is accepted then the list of selected row indices are returned. If selection is cancelled then the initial selection (default choices) is returned.

choices: A sequence of strings containing the possible choices.

default_choices: A sequence of integers containing the indices of the choices that are initially selected.

exclusive: Whether or not the user must choose exactly one of the possible choices.

message: The message to display above the list box.

title: The window’s title. If None, the title is "Houdini".

column_header The column header for the list of choices. Users can click this header label to sort the list. If None, then the header is removed. Note that the tuple of integers represents the original order of items, regardless of the displayed sort order.

num_visible_rows: The number of rows of entries that are visible at a time. If there are more possible choices than visible rows, Houdini will use a scrollbar.

clear_on_cancel: If set to True then an empty tuple is returned when selection is cancelled. Otherwise the initial selection (default_choices) is returned when selection is cancelled.

Pop up a window with a set of choices in a tree chooser and prompt the user to choose zero or more of them. The choices are arranged into a tree using a forward slash as a path separator. If selection is accepted then the list of selected paths are returned. If selection is cancelled then the initial selection (picked) is returned.

choices: A sequence of strings containing the possible choices.

picked: A sequence of strings containing the items that should be initially selected.

exclusive: Whether or not the user must choose exactly one of the possible choices.

message: The message to display above the list box.

title: The window’s title. If None, the title is "Make Selection".

clear_on_cancel: If set to True then an empty tuple is returned when selection is cancelled. Otherwise the initial selection (picked) is returned when selection is cancelled.

Pop up a window with a node tree view and prompt the user to choose a node.

If the user selects a node, returns a string containing the path to the node. If the user presses clear, returns an empty string. If the user presses cancel, returns None.

relative_to_node: A hou.Node for relative paths, or None if relative paths are not supported. Passing in a node enables the Use Relative Paths checkbox.

If this parameter is supplied and the user checks the Use Relative Paths checkbox, this function returns a relative path to the node.

initial_node: The hou.Node that is initially selected.

node_type_filter: An optional hou.nodeTypeFilter enumerated value that determines which types of nodes appear in the tree view.

The following function takes a hou.Parm, prompts the user to choose a node, and sets the value of the parameter as long as the user does not click cancel.

def setParmOnNode(parm, node_type_filter=None):
path = hou.ui.selectNode(relative_to_node=parm.node(), node_type_filter=node_type_filter)
if path is not None:
    parm.set(path)

You might call this function as follows:

>>> setParmOnNode(hou.parm("/obj/box_object1/shop_materialpath"), hou.nodeTypeFilter.Shop)

Pop up a chooser dialog that prompts the user to select a geometry attribute in the scene. Return a tuple of the selected attributes represented as pairs of hou.Attrib and integer values. Return an empty tuple if the selection operation was cancelled.

Example:

# Pre-select the 2nd component of the 'myAttr' point attribute on the
# /obj/geo1/OUT Sop node.
attrib = hou.node("/obj/geo1/OUT").geometry().findPointAttrib("myAttr")
attrib_component_index = 1
preselected_attribs=((attrib, attrib_component_index), )

# Prompt the user to select an attribute.
selected_attribs = hou.ui.selectAttrib(
    initial_selection=preselected_attribs)

# Output the selected attribute.
print selected_attribs

Example with expand_components set to False:

# Pre-select the 'myAttr' point attribute on the
# /obj/geo1/OUT Sop node.
attrib = hou.node("/obj/geo1/OUT").geometry().findPointAttrib("myAttr")
attrib_component_index = -1
preselected_attribs=((attrib, attrib_component_index), )

# Prompt the user to select an attribute.
selected_attribs = hou.ui.selectAttrib(
    initial_selection=preselected_attribs,
    expand_components=False)

# Output the selected attribute.
print selected_attribs

Pop up a chooser dialog that prompts the user to select data from a node. The data can be a parameter, a component from an object node’s transform, a geometry node’s bounding box property, a geometry attribute, or even custom data defined by the custom_data_callback argument. Return a dictionary of selected data organized by the following keys :

• Parameters

  Contains a tuple of selected parameters. The elements in the tuple are hou.Parm objects. If expand_components is False then the elements are hou.ParmTuple objects.

• Transforms

  Contains a tuple of selected object node transforms or transform components. The elements in the tuple are 3-tuples of the form (node, transform_type, transform_component) where node is the hou.Node object that the selected transform is pulled from, transform_type is the type of transform (either Local or World), and transform_component is the specific component selected from the transform (i.e. Rotate[X]). If the whole transform is selected instead of a component then transform_component is None.

• Bounding Boxes

  Contains a tuple of selected geometry node bounding box properties. The elements in the tuple are 2-tuples of the form (node, bbox_property) where node is the hou.Node object that the selected bounding box property is pulled from, and bbox_property is the specific bounding box property (i.e. Size[X]).

• Attributes

  Contains a tuple of selected geometry attributes or attribute components. The elements in the tuple are 2-tuples of the form (attrib, attrib_index) where attrib is the selected hou.Attrib object and attrib_index is the index of the selected attribute component. If expand_components is False then attrib_index is always -1.

• Custom

  Contains a tuple of selected custom data as specified by the custom_data_callback argument. The elements in the tuple are 2-tuples of the form (node, custom_data) where node is the selected hou.Node object that the custom data is attached to and custom_data is the actual data.

Basic Example:

# Prompt to select node data.  Show all types of data.
selected_data = hou.ui.selectNodeData()

# Print out selected parameters (if any).
if "Parameters" in selected_data:
    for parm in selected_data["Parameters"]:
        print "Selected Parm: ", parm

# Print out selected object transforms (if any).
if "Transforms" in selected_data:
    for xform_info in selected_data["Transforms"]:
        print "Selected Node: ", xform_info[0]
        print "Selected Transform Type: ", xform_info[1]
        print "Selected Transform Component: ", xform_info[2]

# Print out selected geometry bounding boxes (if any).
if "Bounding Boxes" in selected_data:
    for bbox_info in selected_data["Bounding Boxes"]:
        print "Selected Node: ", bbox_info[0]
        print "Selected Bounding Box Property: ", bbox_info[1]

# Print out selected geometry attributes (if any).
if "Attributes" in selected_data:
    for attr_info in selected_data["Attributes"]:
        print "Selected Attribute: ", attr_info[0]
        print "Selected Attribute Index: ", attr_info[1]

Here is an example of setting an initial selection:

# Pre-select the 'tx', 'ty' and 'tz' parameters on /obj/geo1.
preselected_parms = (
    hou.parm("/obj/geo1/tx"), hou.parm("/obj/geo1/ty"), 
    hou.parm("/obj/geo1/tz"))

# Pre-select the scale z world transform component on /obj/geo1.
preselected_xforms = (
    (hou.node("/obj/geo1"), "World", "Scale[Z]"),
)

# Pre-select the centroid y bounding box property on /obj/geo1/OUT.
preselected_bboxes = (
    (hou.node("/obj/geo1/OUT"), "Centroid[Y]"),
)

# Pre-select the 2nd component of the 'myAttr' point attribute on the
# /obj/geo1/OUT Sop node.
attrib = hou.node("/obj/geo1/OUT").geometry().findPointAttrib("myAttr")
attrib_component_index = 1
preselected_attribs=((attrib, attrib_component_index), )

# Build up the initial selection dictionary.
initial_selection = {
    "Parameters" : preselected_parms,
    "Transforms" : preselected_xforms,
    "Bounding Boxes" : preselected_bboxes,
    "Attributes" : preselected_attribs,
}

# Prompt the user to select node data.
selected_data = hou.ui.selectNodeData(
    initial_selection=initial_selection,
    multiple_select=True)

# Output the selected data.
print selected_data

Here is an example of specifying custom data:

# Define the callback for returning custom data.
def getCustomData(node):
    # Add custom data only on Object nodes.
    if node.type().category().name() == "Object":
        return ["Fruits/Apples", "Fruits/Bananas", "Fruits/Oranges"]

    # Don't add custom data on all other nodes.
    return []

# Prompt the user to select node data.
selected_data = hou.ui.selectNodeData(custom_data_callback=getCustomData)

# Output the selected data.
print selected_data

Pop up a window with a tree view of recognized parameter tags and prompt the user to choose a tag. Parameter tags are metadata that can be attached to a parameter template with hou.ParmTemplate.setTags() and queried with hou.ParmTemplate.tags().

Tags listed in the window are recognized by Houdini. For example, choosing the GL Diffuse tag and assigning it to a parameter template causes the viewport to recognize the parameter as the diffuse color.

This method returns a 2-tuple where the first element is the selected tag name and the second element is the selected tag value. If no tag is selected or if the selection operation is cancelled, then a 2-tuple of empty strings is returned.

Pop up a window with a parameter tree view and prompts the user to select parameters, populated initially with initial_parms. If selection is accepted then a list of selected parameter paths are returned. If selection is cancelled then the initial selection (initial parameters) is returned.

category: A hou.NodeTypeCategory if filtering by node type, otherwise None if all parameters should be shown

bound_parms_only: True if the dialog should only display parameters that are bound to a default handle. False is all parameters should be shown.

relative_to_node: A hou.Node that you want the selected parameters paths to be relative to.

message: The message to display in the dialog.

title: The title of the dialog.

multiple_select: Whether the user may select multiple parameters.

use_parm_labels: This argument is deprecated. The chooser dialog always displays the parameter labels.

Pop up a window with a parameter tree view and prompts the user to select parameter tuples, populated initially with initial_parm_tuples.

See hou.ui.selectParm() for documentation on the arguments.

Pop up a window with a color chooser, and waits for the user to choose a color and hit the OK or Cancel button. If the user hits the OK button, this method returns the color chosen in the dialog. If the user hits Cancel, this method rturns None.

The initial_color parameter specifies a hou.Color that will appear in the dialog when it first opens. If not set, the initial color will be white.

Display the help for the specified node type. If no help browser is open, this function will create a new one.

If you want to display the help for a node instance, it is easy to access the hou.NodeType from the node, as illustrated in this example:

def displayHelpForNode(node):
'''Given a hou.Node, display its help.'''
hou.ui.displayNodeHelp(node.type())

Given a hou.Node or hou.NodeType instance, open the spare properties dialog.

promote_spare_parms: If this parameter is True and you passed in a node instance, automatically promote any spare parameters on the node into parameters on the node type.

immediately_save: When true, immediately save the current state of the node type, as if you clicked "Apply" in the type properties dialog.

Given a hou.RopNode instance, open the render control dialog for the node. This dialog can be used to override certain render parameters, and launch a render.

Given a hou.Node which contains other nodes, open a dialog for renaming all selected children of the node. The dialog uses pattern matching to rename all the selected nodes in one operation.

Open a dialog displaying the file dependencies in the current .hip file.

Return a 2-tuple where the first element in the tuple is True if the dialog was closed with the OK button and False otherwise, and the second element is a tuple of the selected file patterns. Each selected file pattern is represented as a <hou.Parm, string> pair which stores the source parameter that contains the file pattern and the file pattern itself.

NOTE: If the source parameter is not None then it is recommended that file pattern expansion be performed by evaluating the parameter’s value instead of calling hou.expandString(). Evaluating the source parameter is far more accurate since it accounts for channel references and context-specific variables like $OS.

Given an instance of a hou.SopNode that is a 'captureoverride' type, open the edit capture weight spreadsheet for the node. If a string is passed for pattern, then only the points specified by the pattern will be shown, otherwise all the points for the node will be displayed in the spreadsheet.

Display a message in Houdini’s status bar.

severity: A hou.severityType enum value that determines the background color of the message.

To clear the status bar, call hou.ui.setStatusMessage("").

Register a Python callback to be called whenever Houdini’s event loop is idle. This callback is called approximately every 50ms, unless Houdini is busy processing events.

def checkForAndProcessEvents():
    # Here is where you would check for and process any events.
    pass
    hou.ui.addEventLoopCallback(checkForAndProcessEvents)

You might use this function to integrate another user interface toolkit into Houdini’s event loop. See the PyQt and wxPython cookbook examples for example usages.

Keep calling the supplied callback until it returns True. In the meantime, Houdini will continue to be responsive, allowing you to continue to interact with it.

For example, start a blank Houdini session and put the following in a shelf tool. It will wait until you create an object node before finishing running the tool.

print "waiting until you create an object..."
hou.ui.waitUntil(lambda: len(hou.node("/obj").children()) > 0)
print "you created", hou.node("/obj").children()

If you find that your callback function is too slow to be run frequently, you can try only making it do work every so often:

import time

def throttle(callback, delay=2.0):
    # Returns a wrapper function around `callback`, which only calls
    # `callback` every `delay` seconds (default 2.0), no matter
    # how often the wrapper function is called.

    # This can be useful if the condition function is expensive to run,
    # so you want to limit how often it is called.

    # Store in a list, since Python 2.x doesn't have full nonlocal keyword
    last_check = [0.0]

    def wrapper():
        now = time.time()
        if now < _last_check[0] + delay:
            # Since we return False when we're inside the delay, Houdini
            # will continue to call the condition function
            return False
        else:
            _last_check[0] = now
            return callback()


# Then you could use this with hou.waitUntil like this:

def my_callback():
    return len(hou.node("/obj").children()) > 0

hou.waitUntil(throttle(my_callback, delay=0.5))

Remove a Python callback that was previously registered with hou.ui.addEventLoopCallback(). See hou.ui.addEventLoopCallback() for more information.

Raises hou.OperationFailed if the callback was not previously registered.

Return a tuple of all the Python callbacks that have been registered with hou.ui.addEventLoopCallback().

Force the viewports to update and perform any cooks necessary. You might call this function when Houdini’s Auto Update mode is on Manual.

Reloads all 3DSceneColors configuration files (in $HFS/houdini/config). You must cause the viewport to redraw (for example, by tumbling) to see the new colors.

This function may be useful if you are implementing a new color scheme: you can map to a hotkey or call it in the Python console so you can check your changes.

This method is deprecated in favor of hou.updateModeSetting().

This method is deprecated in favor of hou.setUpdateMode().

Return a string value from a symbolic resource name. The resource name should correspond to one of the entries in the $HH/config/*.hcs file for the currently selected color scheme.

Raises: hou.ValueError if the provided symbolic name doesn’t exist.

Return a color value from a symbolic color name. The color name should correspond to one of the entries in the $HH/config/*.hcs file for the currently selected color scheme.

Raises: hou.ValueError if the provided symbolic name doesn’t exist.

For example:

>>> hou.ui.colorFromName("DisplayOnColor")
<hou.Color r=0.3, g=0.5, b=1>

Return a hou.orientUpAxis indicating the current orientation mode’s up axis.

Return the supplied inches argument, expressing a distance on the screen, converted to a number of pixels. This calculation combines the number of dots per inch reported by the operating system, the Global UI Size setting accessible from Edit ▸ Preferences ▸ General User Interface, and the HOUDINI_UISCALE environment variable, if it has been set. As such, this value may not be accurate, but is consistent with the way the rest of Houdini converts distances from inches to pixels.

Return the supplied pixels argument, expressing a number of pixels on the screen, converted to a distance in inches. This calculation combines the number of dots per inch reported by the operating system, the Global UI Size setting accessible from Edit ▸ Preferences ▸ General User Interface, and the HOUDINI_UISCALE environment variable, if it has been set. As such, this value may not be accurate, but is consistent with the way the rest of Houdini converts distances from pixels to inches.

Return the scale factor that is set by Houdini’s Global UI Size preference. For example, this function returns 1.0 when Houdini is set to the Normal UI size.

The scale factor can be used to scale components in a PySide or PyQt built UI where hou.ui.scaledSize() cannot be called. For example, the scale factor can be used to set the zoom factor of a QWebEngineView object so that the web contents match the Global UI Size:

web_view = QWebEngineWidgets.QWebEngineView()
web_view.setZoomFactor(hou.ui.globalScaleFactor())

Scale the specified size by the global UI scale factor and return the scaled size. The scale factor is determined by Houdini’s Global UI Size preference. For example, the factor is 1.0 when Houdini is set to the Normal UI size.

This function is useful for scaling hard-coded sizes in PySide or PyQt code. Here is an example of using scaled sizes when setting a widget to a fixed size that is 640×480 with the Normal UI size:

widget = QtWidgets.QWidget()
widget.resize(hou.ui.scaledSize(640), hou.ui.scaledSize(480))

Here is another example of creating a scaled icon using the hou.qt.createIcon() function:

icon = hou.qt.createIcon(hou.ui.scaledSize(32), hou.ui.scaledSize(32))

Load a palette file and return the colors listed in the palette. The file parameter can be a full path, or just a file name. In the latter case, the Houdini path is searched for the first instance of the named file under the config subdirectory.

Save a palette file with the contents of the colors parameter, a tuple of hou.Color objects. The file parameter must be a full path to the file where the palette should be saved.

Raises hou.OperationFailed if the file could not be written.

Sets the supplied text into the system clipboard.

Returns any text currently copied into the system clipboard. If the clipboard is empty or contains non-text data, an empty string is returned.

Return a tuple of strings that represent the hotkeys currently assigned to the action associated with the hotkey symbol. The hotkey symbols can be found in the $HH/config/Hotkeys directory.

Raises: hou.ValueError if the provided hotkey symbol doesn’t exist.

For example:

>>> hou.ui.hotkeys("h.copy")
('Alt+C', 'Ctrl+C')
>>> hou.ui.hotkeys("h.pane.copytab")
('Ctrl+T',)

Return a string that contains a description of the action associated with the hotkey symbol. The hotkey symbols can be found in the $HH/config/Hotkeys directory.

Raises: hou.ValueError if the provided hotkey symbol doesn’t exist.

For example:

>>> hou.ui.hotkeyDescription("h.pane.copytab")
'Copy Tab'

Return True if the key described by the string key matches one of the hotkeys assigned to the provided hotkey symbol. The hotkey symbols can be found in the $HH/config/Hotkeys directory.

Raises: hou.ValueError if the provided hotkey symbol doesn’t exist, or the key string doesn’t represent a valid hotkey.

For example:

>>> hou.ui.isKeyMatch("Ctrl+C", "h.copy")
True
>>> hou.ui.isKeyMatch("Ctrl+C", "h.pane.copytab")
False

Save the command history from the current Python Shell to disk. If filename is None, then the history is written to $HOME/houdiniX.X/pyshell.history. If this function is invoked outside of a Python Shell, then the history is taken from the last active shell (i.e. the last shell that was opened or accepted input).

Raises hou.OperationFailed if no Python Shell has been opened. Raises hou.OperationFailed if filename cannot be created.

Load the contents from the specified file into the command history of the Python Shell. If filename is None, then the history is read from $HOME/houdiniX.X/pyshell.history. If this function is invoked outside of a Python Shell, then the history is loaded into the the last active shell (i.e. the last shell that was opened or accepted input).

Raises hou.OperationFailed if no Python Shell has been opened. Raises hou.OperationFailed if filename does not exist or cannot be read.

Return the hou.ShellIO object used to implement Houdini’s graphical Python shell. This function is used internally by Houdini, and you shouldn’t need to access the ShellIO directly.

Query the current drag source to determine if the specified data type is available.

Raises hou.NotAvailable if no drag operation is currently active.

Query the current drag source to obtain the dragged data. Returns None when the specified data in unavailable (or unsupported by HOM).

Raises hou.NotAvailable if no drag operation is currently active.

This method is deprecated. Call hou.qt.mainWindow() instead.

This method is deprecated. Call hou.qt.createIcon() instead.

This method is deprecated. Call hou.qt.styleSheet() instead.

Parse the given .ui file and return the dialog defined in the file.

The dialog must be written with Houdini’s User Interface Script Language. An overview of the language can be found in the Houdini Development Kit (HDK) documentation, specifically in the "Houdini User Interface → The .ui Script Language" section.

ui_file_name is the basename of the .ui file. The file must be located in a directory registered with the HOUDINI_UI_APP_PATH search path. For a list of HOUDINI_UI_APP_PATH search directories, run hconfig -ap from a terminal.

Raises hou.OperationFailed if the .ui file contains errors and the dialog could not be created. Raises hou.TypeError if ui_file_name is None.

Return the dialog defined by the given .ui file name and created by hou.ui.createDialog().

Return None if no dialog has been created with hou.ui.createDialog() for the specified .ui file.

Raises hou.TypeError if ui_file_name is None.

Return all dialogs created by hou.ui.createDialog().

Used internally by Houdini to get the current icon size in the tab menu.