This class represents only dialogs created by hou.ui.createDialog.
Custom dialogs can be created 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.
Methods ¶
addCallback(name, callback)
Register a callback function for the specified UI variable.
The function is invoked when the value of the UI variable changes and receives no arguments.
Raises TypeError if name
is None
.
Raises hou.OperationFailed if no UI variable with the specified name
exists.
callbacks(name)
→ tuple
of callbacks
Return all callback functions registered with the given UI variable.
Raises TypeError if name
is None
.
Raises hou.OperationFailed if no UI variable with the specified name
exists.
destroy()
Delete this dialog.
If you call methods on a Dialog instance after it has been destroyed, Houdini will raise hou.ObjectWasDeleted.
enableValue(name, onoff)
Enable or disable the specified UI variable.
Set onoff
to True
to enable the variable.
Set onoff
to False
to disable the variable.
Raises TypeError if either name
is None
.
Raises hou.OperationFailed if no UI variable with the specified name
exists.
removeCallback(name, callback)
Remove the specified callback function from the UI variable.
Raises TypeError if name
is None
.
Raises hou.OperationFailed if no UI variable with the specified name
exists.
Raises hou.OperationFailed if the specified callback is not
registered with the UI variable.
setMenuItems(name, items)
Set the menu entries in the specified UI variable.
Raises TypeError if name
is None
.
Raises hou.OperationFailed if no UI variable with the specified name
exists.
Raises hou.OperationFailed if the UI variable does not point to a
menu.
setValue(name, value)
Set the value of the specified UI variable.
Raises TypeError if either name
or value
is None
.
Raises hou.OperationFailed if no UI variable with the specified name
exists.
value(name)
Return the value of the given UI variable.
Raises TypeError if name
is None
.
Raises hou.OperationFailed if no UI variable with the specified name
exists.
waitForValueToChangeTo(name, new_value)
Wait for the specified UI variable to change its value to new_value
.
This is a blocking call. The method will return execution when the variable has changed to the desired value. Note that Houdini will remain responsive even when this method is blocked waiting.
If the variable’s current value is already set to new_value
then this
method will return immediately.
Raises TypeError if name
is None
.
Raises hou.OperationFailed if no UI variable with the specified name
exists.