Return all the digital asset definitions inside an hda file. See hou.HDADefinition for more information.

Raises hou.OperationFailed if file_path does not refer to a valid hda file.

# Print the node types defined by digital assets in $HOME/houdiniX.Y/hda/OPcustom.hda:
>>> import os
>>> my_hda_file = "%s/hda/OPcustom.hda" % hou.homeHoudiniDirectory()
>>> for definition in hou.hda.definitionsInFile(my_hda_file):
...     print definition.nodeTypeCategory().name() + "/" + definition.nodeTypeName()
Sop/gcoggeo
Sop/gCogFlatGeo
Sop/gDivideAtCentroid
Object/gAxle
Object/gCog

Install all the node types defined in an hda file into the current Houdini session. This function is equivalent to File ▸ Install Digital Asset Library… in Houdini.

Note that, if you do not store the path to the hda file in an OPlibraries file, Houdini will store it in the current Houdini session. So, when you load a hip file, it will try to load the hda files that it references.

Uninstall an hda file and all the node type definitions it provides from the current Houdini session. The hda file and its contents on disk are unchanged.

You can set file_path to the special name "Embedded" to refer to the digital assets embedded in the current hip file. The following example removes any embedded digital asset definitions from the current Houdini session:

hou.hda.uninstallFile("Embedded")

If oplibraries_file is not None and change_oplibraries_file is True, Houdini will remove the path to the hda from the specified OPlibraries file. See hou.hda.installFile for more information about these parameters.

If all the definitions of a node type are uninstalled, any instances of that node type will warn that they are using an incomplete asset definition. They will, however, retain their parameter values as spare parameters. Installing an hda file with the missing node type will restore those node instances and remove the warnings.

See also hou.HDADefinition.destroy.

Reload the contents of an hda file, loading any updated digital asset definitions inside it.

You only need to call this function if an hda file was modified from outside the current Houdini session.

Reload the digital asset files and update asset definitions in the current session.

If the rescan is true, Houdini will check the hda directories for any new hda files and load them too.

See also hou.hda.reloadFile.

Check HOUDINI_OPNAMESPACE_HIERARCHY environment variable and rebuild the node type preference order that determines the node type to use when only unqualified root name is used in scripts, or, when Tab menu settings specify to show only a single preferred entry among several potential choices from different namespaces.

Return a tuple of paths to the hda files that are loaded into the current Houdini session.

This method is can be approximately implemented as follows:

def loadedFiles():
    '''Return a list of hda files loaded into this Houdini session.'''
    # Look through all the node types, and for those that have digital
    # asset definitions, remember the hda file containing the definition.
    result = []
    for category in hou.nodeTypeCategories().values():
        for node_type in category.nodeTypes().values():
            definition = node_type.definition()
            if definition is None:
                continue
            if definition.libraryFilePath() not in result:
                result.append(definition.libraryFilePath())
    return result

See hou.HDADefinition.isCurrent for an example.

Expand the contents of the hda file in file_path into the directory directory_path. If the directory does not already exist it is created.

When expanding an hda file, Houdini puts each digital asset definition in the file into its own directory. As well, it puts each section inside a definition into its own file. Each directory inside the expanded file tree contains a Sections.List file that maps the actual file or directory names into the section names, since section names may contain characters that cannot occur in directory or file names. See hou.HDASection for more information about sections.

This function provides an easy way to inspect and modify the contents of an hda file. See also hou.hda.collapseFromDirectory.

Given a directory that contains a previously expanded hda file, collapse it into the hda file specified by file_path.

This function provides the inverse of hou.hda.expandToDirectory.

Give a name to an OPlibraries file. This name appears in the Operator Type Manager's list of OPlibraries file. If source_name is None, the name is removed from the OPlibraries file.

If the oplibraries_file does not already exist, it is created.

See hou.hda.installFile for more information about OPlibraries files.

Returns a tuple of operator type name components that constitute the full node type name. The components in the tuple appear in the following order: scope network type, node type namespace, node type core name, and version.

>>> # Parse the full name into components
>>> hou.hda.componentsFromFullNodeTypeName('MyUserNamespace::MyHDA::2.5')
('', 'MyUserNamespace', 'MyHDA', '2.5')
>>> hou.hda.componentsFromFullNodeTypeName('Sop/foreach::MyCounterHDA')
('Sop/foreach', '', 'MyCounterHDA', '')

Returns a full node type name build out of the given components. The arguments represent the following components: scope network type, node type namespace, node type core name, and version.

>>> # Compose the node type full name from components
>>> hou.hda.fullNodeTypeNameFromComponents('', 'userA', 'sphere', '')
'userA::sphere'
>>> hou.hda.fullNodeTypeNameFromComponents('', 'userB', 'myHda', '2.6')
'userB::myHda::2.6'
>>> hou.hda.fullNodeTypeNameFromComponents('Sop/foreach', '', 'MyCounterHDA', '')
'Sop/foreach::MyCounterHDA'

Reload the code in the PythonModule section corresponding to hda_module. hda_module must be an hou.HDAModule object.

For example this code reloads and re-executes the code in the PythonModule section of the HDA definition for the 'foobar' node:

hou.hda.reloadHDAModule(hou.node("/obj/foobar").hdaModule())

Reload the code in the ViewerStateModule section corresponding to hda_module. hda_module must be an hou.HDAViewerStateModule object.

For example this code reloads the viewer state code in the ViewerStateModule section of the HDA definition for the 'foobar' node:

hou.hda.reloadHDAViewerStateModule(hou.node("/obj/foobar").hdaViewerStateModule())

Reload the code in the ViewerHandleModule section of hda_module. hda_module must be an hou.HDAViewerHandleModule object.

This example shows how to reload the code in the ViewerHandleModule section of the HDA definition for the 'xyz' node:

hou.hda.reloadHDAViewerHandleModule(hou.node("/obj/xyz").hdaViewerHandleModule())

Return True if the Safeguard Operator Definitions configuration option is turned on. When safeguarding is turned on then no digital asset definition can be modified in the Houdini session.

Set whether the Safeguard Operator Definitions configuration option should be turned on or off. The on argument must be either True of False.