Back to – Game Dev Table of Contents
Back to – Python Table of Contents
The base class for all nodes in Houdini (objects, SOPs, COPs, etc.) An instance of this class corresponds to exactly one instance of a node in Houdini.
Be careful not to confuse this class with the function hou.node.
Table of Contents
Hierarchy
- node(node_path) : hou.Node or None
- nodes(node_path_tuple) : tuple of hou.Node or None
- item(item_path) : hou.NetworkMovableItem or None
- items(item_path_tuple) : tuple of hou.NetworkMovableItem or None
- isNetwork() : bool
- children() : tuple of hou.Node
- allItems() : tuple of hou.NetworkMovableItem
- allSubChildren(top_down=True, recurse_in_locked_nodes=True) : tuple of hou.Node
- allNodes() : generator of hou.Node
- glob(pattern, ignore_case=False) : tuple of hou.Node
- createNode(node_type_name, node_name=None, run_init_scripts=True, load_contents=True, exact_type_name=False) : hou.Node
- createOrMoveVisualizer(output_index)
- destroy(disable_safety_checks=False)
- copyTo(destination_node) : hou.Node
- copyItems(items, channel_reference_originals = False, relative_references = True, connect_outputs_to_multi_inputs = True) : tuple of hou.NetworkMovableItem
- deleteItems(items, disable_safety_checks=False)
Selection
- isCurrent() : bool
- setCurrent(on, clear_all_selected=False)
- selectedChildren(include_hidden=False, include_hidden_support_nodes=False) : tuple of hou.Node
- selectedItems(include_hidden=False, include_hidden_support_nodes=False) : tuple of hou.NetworkMovableItem
- numItems(item_type=None, selected_only=False, include_hidden=False) : int
Types
- type() : hou.NodeType
- changeNodeType(new_node_type, keep_name=True, keep_parms=True, keep_network_contents=True, force_change_on_node_type_match=False) : hou.Node
- childTypeCategory() : hou.NodeTypeCategory
Parameters
- parm(parm_path) : hou.Parm or None
- globParms(pattern, ignore_case=False, search_label=False, single_pattern=False) : tuple of hou.Parm
- evalParm(parm_path) : int , float , or str
- parms() : tuple of hou.Parm
- parmsReferencingThis() : tuple of hou.Parm
- allParms() : generator of hou.Parm
- setParms(parm_dict)
- setParmsPending(parm_dict)
- setParmExpressions(parm_dict, language=None, replace_expressions=True)
- parmTuple(parm_path) : hou.ParmTuple or None
- evalParmTuple(parm_path) : tuple of int , float , or str
- parmTuples() : tuple of hou.ParmTuple
- parmsInFolder(folder_names) : tuple of hou.Parm
- parmTuplesInFolder(folder_names) : tuple of hou.ParmTuple
- expressionLanguage() : hou.exprLanguage enum value
- setExpressionLanguage(language)
- parmAliases(recurse=False) : dict of hou.Parm to str
- clearParmAliases()
- spareParms() : tuple of hou.Parm
- removeSpareParms()
- parmTemplateGroup() : hou.ParmTemplateGroup
- setParmTemplateGroup(parm_template_group, rename_conflicting_parms=False)
- addSpareParmTuple(parm_template, in_folder=(), create_missing_folders=False) : hou.ParmTuple
- removeSpareParmTuple(parm_tuple)
- addControlParmFolder(folder_name=None, parm_name=None)
- addSpareParmFolder(folder_name, in_folder=(), parm_name=None, create_missing_folders=False)
- removeSpareParmFolder(folder)
- replaceSpareParmTuple(parm_tuple_name, parm_template)
- localVariables()
- saveParmClip(file_name, start=None, end=None, sample_rate=0, scoped_only=False)
- loadParmClip(file_name, sample_rate=0, start=None)
- parmClipData(start=None, end=None, binary=True, use_blosc_compression=True, sample_rate=0, scoped_only=False) : str
- setParmClipData(data, binary=True, blosc_compressed=True, sample_rate=0, start=1)
Inputs and outputs
inputs() : tuple of hou.Node
outputs() : tuple of hou.Node
inputConnections() : tuple of hou.NodeConnection
outputConnections() : tuple of hou.NodeConnection
inputConnectors() : tuple of tuple of hou.NodeConnection
outputConnectors() : tuple of tuple of hou.NodeConnection
indirectInputs() : tuple of hou.SubnetIndirectInput
subnetOutputs() : tuple of hou.Node
inputAncestors(include_ref_inputs=True, follow_subnets=False, only_used_inputs=False) : tuple of hou.Node
inputIndex(input_name)
outputIndex(output_name)
setInput(input_index, item_to_become_input, output_index=0)
setNamedInput(input_name, item_to_become_input, output_name_or_index)
setFirstInput(item_to_become_input, output_index=0)
setNextInput(item_to_become_input, output_index=0, unordered_only=False)
insertInput(input_index, item_to_become_input, output_index=0)
numOrderedInputs() : int
createInputNode(input_index, node_type_name, node_name=None, run_init_scripts=True, load_contents=True, bool exact_type_name=False)
createOutputNode(node_type_name, node_name=None, run_init_scripts=True, load_contents=True, bool exact_type_name=False)
inputNames() : tuple of str
inputLabels() : tuple of str
outputNames() : tuple of str
outputLabels() : tuple of str
editableInputStrings(input_index) : dict of str to str
editableInputString(input_index, key) : str
setEditableInputString(input_index, key, value)
Dependencies
references(include_children = True) : tuple of hou.Node
dependents(include_children = True) : tuple of hou.Node
Subnets
isSubNetwork() : bool
collapseIntoSubnet(child_nodes, subnet_name=None, subnet_type=None) : hou.Node
extractAndDelete() : tuple of hou.NetworkMovableItem
Assets
canCreateDigitalAsset() : bool
createDigitalAsset(name=None, hda_file_name=None, description=None, min_num_inputs=0, max_num_inputs=0, compress_contents=False, comment=None, version=None, save_as_embedded=False, ignore_external_references=False, change_node_type=True, create_backup=True, install_path=None) : Node
createCompiledDigitalAsset(name=None, hda_file_name=None, description=None)
allowEditingOfContents(propagate=False)
matchCurrentDefinition()
matchesCurrentDefinition() : bool
isLockedHDA() : bool
isInsideLockedHDA() : bool
isEditableInsideLockedHDA() : bool
isEditable() : bool
isMaterialManager() : bool
hdaModule() : hou.HDAModule
hm() : hou.HDAModule
hdaViewerStateModule() : hou.HDAViewerStateModule
syncNodeVersionIfNeeded(from_version)
Metadata
comment() : str
setComment(comment)
appendComment(comment)
isDisplayDescriptiveNameFlagSet() : bool
setDisplayDescriptiveNameFlag(on)
outputForViewFlag() : int
setOutputForViewFlag(output)
creationTime() : datetime.datetime
modificationTime() : datetime.datetime
creator() : Node
creatorState() : str
setCreatorState(state)
isBuiltExplicitly() : bool
setBuiltExplicitly(built_explicitly)
isTimeDependent() : bool
Layout
moveToGoodPosition(relative_to_inputs=True, move_inputs=True, move_outputs=True, move_unconnected=True) : hou.Vector2
layoutChildren(items=(), horizontal_spacing=-1.0, vertical_spacing=-1.0)
isHidden()
hide(on)
Cooking
cook(force=False, frame_range=())
needsToCook(time=hou.time()) : bool
cookCount() : int
updateParmStates()
errors() : tuple of str
warnings() : tuple of str
messages() : tuple of str
infoTree(verbose=False, debug=False, output_index=0) : hou.NodeInfoTree
canGenerateCookCode(check_parent=False, check_auto_shader=True) : bool
cookCodeGeneratorNode(check_parent=False) : hou.Node
cookCodeLanguage() : str
supportsMultiCookCodeContexts() : bool
saveCompiledCookCodeToFile(file_name, context_name=None)
saveCookCodeToFile(file_name, skip_header=False, context_name=None)
Network boxes
networkBoxes() : tuple of hou.NetworkBox
iterNetworkBoxes() : generator of hou.NetworkBox
findNetworkBox(name) : hou.NetworkBox
findNetworkBoxes(pattern) : tuple of hou.NetworkBox
createNetworkBox(name=None) : hou.NetworkBox
copyNetworkBox(network_box_to_copy, new_name=None, channel_reference_original=False) : hou.NetworkBox
Sticky notes
stickyNotes() : tuple of hou.StickyNote
iterStickyNotes() : generator of hou.StickyNote
findStickyNote(name) : hou.StickyNote
findStickyNotes(pattern) : tuple of hou.StickyNote
createStickyNote(name=None) : hou.StickyNote
copyStickyNote(network_box_to_copy, new_name=None) : hou.StickyNote
Network dots
createNetworkDot() : hou.NetworkDot
networkDots() : tuple of hou.NetworkDot
Node groups
addNodeGroup(name=None) : hou.NodeGroup
nodeGroup(name) : hou.NodeGroup
nodeGroups() : tuple of hou.NodeGroup
Scripts
runInitScripts()
deleteScript() : str
setDeleteScript(script_text, language=hou.scriptLanguage.Python)
Motion FX
motionEffectsNetworkPath() : str
findOrCreateMotionEffectsNetwork(create=True) : hou.chopNetNodeTypeCategory()
Stamping
stampValue(parm_name, default_value)
Serialization
copyItemsToClipboard(items)
saveItemsToFile(items, file_name, save_hda_fallbacks = False)
saveChildrenToFile(nodes, network_boxes, file_name)
loadItemsFromFile(file_name, ignore_load_warnings=False)
loadChildrenFromFile(file_name, ignore_load_warnings=False)
pasteItemsFromClipboard(position = None)
asCode(brief=False, recurse=False, save_channels_only=False, save_creation_commands=True, save_keys_in_frames=False, save_outgoing_wires=False, save_parm_values_only=False, save_spare_parms=True, function_name=None) : str
Operators
__eq__(node) : bool
__ne__(node) : bool
Callbacks
addEventCallback(event_types, callback)
removeEventCallback(event_types, callback)
removeAllEventCallbacks()
eventCallbacks() : tuple of (tuple of hou.nodeEventType, callback)
User data
setUserData(name, value)
userDataDict() : dict of str to str
userData(name) : str or None
destroyUserData(name)
clearUserDataDict()
setCachedUserData(name, value)
cachedUserDataDict() : dict of str to any python object`
cachedUserData(name) : any python obect or None
destroyCachedUserData(name)
clearCachedUserDataDict()
Data blocks
dataBlockKeys(blocktype) : tuple of str
dataBlockType(key) : str
dataBlock(key) : str
setDataBlock(key, block, blocktype)
Dynamics
simulation() : hou.DopSimulation
findNodesThatProcessedObject(dop_object) : tuple of hou.DopNode
Flags
isFlagReadable(flag) : bool
isFlagWritable(flag) : bool
isGenericFlagSet(flag) : bool
setGenericFlag(flag, value)
PDG Work Items
selectNextVisibleWorkItem()
selectPreviousVisibleWorkItem()
implemenmts hou.NetworkItem,
networkItemType() : hou.networkItemType
from hou.NetworkMovableItem
name() : str
setName(name, unique_name=False)
digitsInName() : int
path() : str
relativePathTo(base_node) : str
parent() : hou.Node
parentNetworkBox() : hou.NetworkBox or None
isSelected() : bool
isPicked() : bool
setSelected(on, clear_all_selected=False, show_asset_if_selected=False)
setPicked(on)
color() : hou.Color
setColor(color)
sessionId()
position() : hou.Vector2
setPosition(vector2)
move(vector2)
shiftPosition(vector2)
size() : hou.Vector2