| Inheritance |
|
Methods ¶
renderMask()
→ str
Returns a string with space-separated names of the renderers that this
VOP type supports. Note that some VOP types, like the switch VOP,
return "*" to indicate that they support all renderers, while others
return an empty string to indicate they are not real shaders.
See hou.VopNode.shaderString for an example.
shaderType()
→ hou.shaderType enum value
Returns the type of shader for this VOP type. For example, this vop type might be a surface shader or a displacement shader. See hou.shaderType for the possible shader types.
See also hou.VopNode.shaderType.
vopnetMask()
→ str
Returns a glob pattern that matches the network parents in which this VOP node can appear.
See hou.VopNode.shaderString for an example.
inputTags(input_name)
→ dict
of str
to string
Returns a dictionary of key-value pairs associated with the given input. This dictionary allows attaching arbitrary data to node inputs.
outputTags(output_name)
→ dict
of str
to str
Returns a dictionary of key-value pairs associated with the given output. This dictionary allows attaching arbitrary data to node outputs.
Methods from hou.NodeType ¶
name()
→ str
Return the name of this node type. For example, for the geometry object type, the name is “geo”. The name and the node type category together uniquely identify a node type.
nameComponents()
→ tuple
of str
Returns a tuple of node 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 >>> node_type = hou.nodeType(hou.dopNodeTypeCategory(), 'pyrosolver::2.0') >>> node_type.nameComponents() ('', '', 'pyrosolver', '2.0')
nameWithCategory()
→ str
Return the name of the node type, prefixed with the name of the node
type category. For example, for the geometry object, this function
returns "Object/geo". The category name and type name together
uniquely identify a node type.
>>> hou.nodeType(hou.objNodeTypeCategory(), "geo").nameWithCategory() 'Object/geo'
namespaceOrder()
→ tuple
of str
Returns a node type name list sorted in the descending namespace precedence order. The node types in the list have the same base type as this node type. They have different namespace and/or version.
Houdini uses this list when resolving an unqualified type name in
hou.Node.createNode() when the Edit > Preferences > Shelf Tools and Tab Menu > TAB Menu Operator Namespace Filtering
preference is set to Show single Operator from the Preferred Namespace; it
will use the first entry in that list that matches the name specified in
the function.
# parse the full name into components >>> node_type = hou.nodeType(hou.dopNodeTypeCategory(), 'pyrosolver') >>> node_type.namespaceOrder() ('pyrosolver::2.0', 'pyrosolver')
Note
The hou.Node.createNode() behavior may differ if the HOUDINI_OPNAMESPACE_HIERARCHY environment variable is set.
versionNamespaceOrder()
→ tuple
of str
Returns a node type name list sorted in the descending version precedence order. The node types in the list have the same namespace and base type as this node type, but have different versions.
Houdini uses this list when resolving an unqualified type name in
hou.Node.createNode() when the Edit > Preferences > Shelf Tools and Tab Menu > TAB Menu Operator Namespace Filtering
preference is set to Show Only Operators with Preferred Versions; it will
use the first entry in that list that matches the name specified in the
function.
Note
The hou.Node.createNode() behavior may differ if the HOUDINI_OPNAMESPACE_HIERARCHY environment variable is set.
description()
→ str
Return the description of this node type that appears in the tab menu.
For example, for the geometry object, the description is "Geometry".
This description is also called the operator label in Houdini.
category()
→ hou.NodeTypeCategory
Return the node type category for this node type. For example, for the geometry object, the result is the object returned by hou.objNodeTypeCategory().
parmTemplateGroup()
→ hou.ParmTemplateGroup
Return the group of parm templates corresponding to this node type’s parameter interface.
See hou.ParmTemplateGroup for more information on parm template groups. To change the parameter interface for a node type defined by a digital asset, see hou.HDADefinition.setParmTemplateGroup.
parmTemplates()
→ tuple
of hou.ParmTemplate
Return a tuple of parm templates for the parameters on this node type. Note that spare parameters on individual node instances are not included in this tuple, since they are independent from the node type.
minNumInputs()
→ int
Return the minimum number of inputs that nodes of this type can have. If these inputs are not connected, the node will generate an error.
maxNumInputs()
→ int
Return the maximum number of inputs that nodes of this type can have. Return 9999 if this node type can accept an unlimited number of inputs (e.g. the merge SOP).
maxNumOutputs()
→ int
Return the maximum number of outputs that nodes of this type can have. Most node types have only one output, but some, like the split dop, can have multiple.
hasEditableInputData()
→ bool
Return True if nodes of this node type allow the user to associate data with each input to the node. The purpose of this data may vary from one node type to another. This data can be accessed with methods such as hou.Node.editableInputName and hou.Node.setEditableInputName.
hasPermanentUserDefaults()
→ bool
Returns whether a user has set permanent defaults for this node type.
See also hou.Parm.hasTemporaryDefaults
hasUnorderedInputs()
→ bool
Return whether it is impossible for this node type to have gaps in its connected inputs. For example, the cookie SOP has two inputs, and it’s possible for only the second input to be connected, so this method would return False. However, the merge SOP cannot have any gaps in its inputs, so this method would return True.
See also hou.Node.inputs, hou.Node.inputConnections, and hou.Node.inputConnectors.
isGenerator()
→ bool
Return if this node type has been flagged as a generator. For example, a grid SOP generates new geometry, while a subdivide SOP does not, and instead processes the geometry passed into it. See also hou.NodeType.minNumInputs.
isManager(include_management_types=True)
→ bool
Return whether this NodeType is a manager. The manager node instances are
/obj, /out, /part, /ch, /shop, /img, and /vex.
If include_management_types is set to True then this method will
additionally return True if this node type is a management node type such
as a SHOP network, or VOP network, etc.
icon()
→ str
Return the name or path of the icon for this node type. Note that node types that ship with Houdini use a name instead of a full path, and Houdini uses its search path to locate the icon with that name.
resolvedIcon()
→ str
Same as icon() except that this is intended for use with UI elements
which may not know how to resolve certain syntaxes particular to specific
hou.NodeType subclasses.
isReadable()
→ bool
Return True if this node type is readable and False otherwise. A readable node type is one that you can create node instances from.
isWritable()
→ bool
Return True if this node type is writable and False otherwise. A writable node type is one that you can make changes to.
areContentsViewable()
→ bool
Return True if the node network contained in the node type is viewable and False otherwise.
containedNodeTypes()
→ tuple
of str
Return a tuple of all NodeType names of the contents of an HDA.
childTypeCategory()
→ hou.NodeTypeCategory or None
Return the NodeTypeCategory for this NodeType’s children, or None if
this NodeType doesn’t allow children.
embeddedHelp()
→ str
Return the help text embedded in this node type. Return an empty string if no embedded help exists.
The embedded help is searched for in two different places in the following order:
-
If an HDK node, the text given by its
OP_Operator::getHDKHelp()override -
If an HDA node, the corresponding result of hou.HDADefinition.embeddedHelp()
helpUrl()
→ str
Return the URL where the node type stores the documentation, e.g., a file name or an HDA section path. May return an empty string if node type does not know where the documentation is.
defaultHelpUrl()
→ str
Return a generic URL that the help system will try to resolve to the actual location that stores the node type documentation. The generic URL is in the form “operator:table/optypename” and may include additional information such as a namespace or a version.
defaultColor()
→ hou.Color
Return the color used to display a node of this type in the network view if the node’s hou.nodeFlag.ColorDefault flag is set.
setDefaultColor(color)
Set the color used to display a node of this type in the
network view if the node’s hou.nodeFlag.ColorDefault flag is set.
Pass None as the color parameter to remove the type-specific default.
defaultShape()
→ str
Return the name of the shape used to display a node of this type in the network view if no shape is explicitly assigned to the node.
setDefaultShape(shape)
Set the name of the shape used to display a node of this type in the
network view if no shape is explicitly assigned to the node.
Pass None as the shape parameter to remove the type-specific default.