husd package

Subpackages

• husd.UsdHoudini package
  • Module contents
• husd.UsdMantra package
  • Module contents

Submodules

husd.attrutils module

husd.attrutils.GetEditorNodesForLayer(layer)

husd.attrutils.GetLabelForLayer(layer)

husd.attrutils.GetRootLayerStackInfo(layer)

husd.attrutils.GetScalarTypeFromAttr(attr)

returns the (scalar, isArray) where isArray is True if it was an array type

husd.attrutils.GetShortString(prop, frame)

husd.attrutils.GetValue(prop, frame)

husd.attrutils.ToString(v, typeName=None)

Returns a string representing a “detailed view” of the value v. This string is used in the watch window

husd.parmutils module

husd.parmutils.addParmsToGroup(grpOrFolder, parms, ctrlMenu=None)

The Edit LOP only support the constant primvar for now, so we even don’t need the menu for controlling the primvar.

husd.parmutils.appendSpareParm(lop, parm, folder=None)

husd.parmutils.bakeAnimation(lop, prim, perFrame=True)

husd.parmutils.createAttributesForParmTemplateGroup(prim, parm_template_group, parent_class, node_type, parms, namespace=None)

Creates attributes properties on prim, one for each parameter in parm_template_group

node_type is required to retrieve parameter documentation from the houdinihelp system.

parm_filter is a function accepting of the following form.

def parmfilter(parm_template_group, parm_template)

If this returns false the parm template is skipped.

husd.parmutils.createClassForNodeType(stage, node_type, class_name, internal_class_name, parms, parent_class=None, parent_class_name=None, property_namespace=None)

Based on a houdini node type, create a Usd Class Primitive on stage with a property for each of the node_type’s parameters.

This can be used to create the class definition required for schema.usda files, the source files used by usdGenSchema.py

husd.parmutils.createParmForAttr(label, name, valueType, default=None, menu=None)

husd.parmutils.createParmForRelationship(label, name, default=[])

husd.parmutils.createPropertyForParmTemplate(prim, propname, parm_template)

Creates the property named propname on Usd.Prim “prim” if it doesn’t exist yet

husd.parmutils.createSchemaHeader(stage, library_name)

husd.parmutils.fixParmName(name)

Remove the illegal characters for setting the name of the parameter.

husd.parmutils.getParmForProperty(prop)

husd.parmutils.getParmTemplateGroupForPrim(prim, inclProps=[])

Get the parameter template group by reading the properties from the given usd prim.

The properties with the same namespace will be collected into a seperate subfolder.

husd.parmutils.getParmValue(parm)

husd.parmutils.getPropertyClassForParmTemplate(parmtemplate)

Returns the type of property (Usd.Attribute or Usd.Relationship) to be used for parmtemplate.

husd.parmutils.getValueTypeForParmTemplate(parmtemplate)

Returns the best fitting Sdf.ValueTypeName for parmtemplate

husd.parmutils.importPropsAtPrim(lop, prim, inclProps=[])

husd.parmutils.isValidParm(parm)

Every parameter with the correct spare datas would be the valid husd parameter.

husd.parmutils.listPropsAtNode(prim, regex_pattern='')

Returns a list of property names that exist on the USD primitive, which match the given regex pattern.

husd.parmutils.populateScalarValue(attr, isArray, frame=None)

Populate scalar value from given attribute then convert it to Python builtin types. Treat one-length array value as scalar value, and return None if the length is over one.

husd.parmutils.printTypeListForParmTemplateGroup(parm_template_group)

Finds a corresponding Sdf.ValueTypeName for all parameters in the hou.ParmTemplateGroup when possible, and prints a list of parameters for each type.

Can be used to quickly analyze the mappings.”

husd.parmutils.setPropertyToParmValue(prim, propname, parm)

Sets the property named propname on Usd.Prim “prim” to the value of hou.Parm “parm”.

If the property doesn’t exist on the prim, it is only created if create=True.

husd.parmutils.translateParmValue(parm_template, value)

husd.primpicker module

class husd.primpicker.CollectionItem(prim, collection)

Bases: sphinx.ext.autodoc.importer._MockObject

class husd.primpicker.PrimItem(prim, showcollections)

Bases: sphinx.ext.autodoc.importer._MockObject

appendChildren(prim)

class husd.primpicker.SelectPrimDialog(stage, multiSel, destparm)

Bases: sphinx.ext.autodoc.importer._MockObject

buttonClicked(button)

selected()

setSelection(paths)

husd.primpicker.selectPrims(lopnode, multisel, destparm)

husd.propcreator module

class husd.propcreator.PropCreatorDialog

Bases: sphinx.ext.autodoc.importer._MockObject

basename

name

namespace

propType

valueType

husd.propcreator.createParmForNewProperty(lop)

husd.proppicker module

class husd.proppicker.PropItem(label, name)

Bases: sphinx.ext.autodoc.importer._MockObject

Simple wrapper for QStandardItem with a bunch of custom behaviours

class husd.proppicker.SelectPropertiesDialog(prim, picked=[])

Bases: sphinx.ext.autodoc.importer._MockObject

buildTree(prim)

Traverse build the tree by populating every properties from the given primitive.

selected

traverseTree(name)

Traverse find the item from the built item hierarchy.

husd.proppicker.createParmsForExistingProperties(lop, prim)

husd.proppicker.selectProperties(prim, picked=[])

husd.scenegraphdetails module

class husd.scenegraphdetails.SceneGraphDetails(pane)

Bases: sphinx.ext.autodoc.importer._MockObject

husd.textviewer module

class husd.textviewer.ViewTextDialog(text, title)

Bases: sphinx.ext.autodoc.importer._MockObject

saveText()

husd.textviewer.viewActiveLayer(lop)

husd.textviewer.viewStage(lop)

husd.typeutils module

husd.typeutils.convertFromGf(gfValue)

Convert Usd Gf types to python builtin types.

husd.typeutils.isGfType(gfValue)

Check if the given value has an valid Gf type.

husd.utils module

husd.utils.getAllDescendants(prim)

Module contents