autorigs.modules.base package

Submodules

autorigs.modules.base.autoRigsBaseBuilder module

class autorigs.modules.base.autoRigsBaseBuilder.AutoRigsBaseBuilder(index, modulename, moduletype, autorigs_asset, buildguide, model, parentinfo, prefix='', parent=None, geo_builder=None)

Bases: object

BONEGROUP = 'bone_group'

CONTROLGROUP = 'control_group'

INTERFACE = {}

NODEGROUP = 'node_group'

NODES = {}

VISIBLENODEGROUP = 'visible_node_group'

addBoneGroupToGeoSkin(group)

addToInterfaceDict(key, name, label)

addToNodesDict(key, name)

buildRig()

Build the rig and creates the autorig interface for the module. Override this function if the function orders need to be different.

buildRigControls()

Creates the bones and controls based on the guide objects. prefix: the prefix to use for all the nodes created assetnode: the autorig assset node in which to create the rig model: the module’s model for build options buildguide: the module’s buildguides parent: a function takes a node as the argument and parent the node

captureGeometry()

Captures the geometry

createAllNodeGroups()

createBone(key, name='', deform=True, grp_idx=0, node=None)

Creates a bone modifies node deform: whether the bone will be captured or not

createControl(key, name='', grp_idx=0, node=None)

Creates a control null modifies node

createFolderTemplate()

Creates the folder parm template for the module. model: the module’s model for build options

createGeometry(key, name='', grp_idx=0, node=None)

Creates a geometry node or modifies node

createGroup(group_prefix, nodes_dict=None, interface_dict=None)

Creates a new builder group. prefix: the prefix for the builder group. The prefix of the module is included by default.

createGroups()

createNode(node_type, key, name='', grp_idx=0, network=None, node=None)

Creates a node of type node_type

createNodeGroups(grp_idx=0)

createParm(template_type, key, *args, **kwargs)

createRoot(key, name='', grp_idx=0, node=None)

Creates a root null modifies node

getBones(grp_idx=0)

getControls(grp_idx=0)

getDeformBones(grp_idx=0)

getGroup(grp_idx)

getGroups()

getMainGroup()

getNode(key, grp_idx=0)

getNodeGroups(grp_idx=0)

getNodeName(name)

getNodes(grp_idx=0)

getParent()

Get the parent hook object

getPrefix(index)

Return the node-naming prefix for this module

linkParm(node, parm_info)

Links the parameter of a node based on given parm_info node: the node to set up the parm expression parm_info: (tuple) (parm_id, parm_label, link_parm_id)

linkRigInterfaceParms()

onCaptureCompleted()

Processes to run after geometry is captured

setParent(node)

class autorigs.modules.base.autoRigsBaseBuilder.BuilderGroup(assetnode, module_prefix, group_prefix, nodes_dict, interface_dict)

Bases: object

BONEGROUP = 'bone_group'

CONTROLGROUP = 'control_group'

DEFORMBONEGROUP = 'deform_bone_group'

INTERFACE = {}

NODEGROUP = 'node_group'

NODES = {}

VISIBLENODEGROUP = 'visible_node_group'

createBone(key, name='', deform=True, node=None)

Creates a bone deform: whether the bone will be used to capture or not

createControl(key, name='', node=None)

Creates a control null

createGeometry(key, name='', node=None)

createNode(node_type, key, name='', network=None, node=None)

Creates a node of type node_type

createNodeGroups()

Convert the data stored to nodegroups

createParm(template_type, key, *args, **kwargs)

Creates and adds a parmTemplate of template_type as part of the class template_type: one of the hou.ParmTemplate type, name: the key and name for the parm (without prefix), label: the label for the parm

createRoot(key, name='', node=None)

Creates a root null

getBones()

getControls()

getDeformBones()

getLabelName(label)

getNode(key)

getNodeGroup(key)

Get the converted node group. Make sure node groups have been converted first.

getNodeGroups()

getNodeName(name)

getNodes()

getParmName(key)

getPrefix()

hasNode(key)

setConvertFlag(flag)

setGroups(groups)

setPrefix(prefix)

autorigs.modules.base.autoRigsBaseWidget module

class autorigs.modules.base.autoRigsBaseWidget.AutoRigsBaseWidget

Bases: sphinx.ext.autodoc.importer._MockObject

fromJSON(json)

hasUnsavedChanges()

markSaved()

setLayout(layout, has_scroll=True)

toJSON()

unlinkAllNodes()

class autorigs.modules.base.autoRigsBaseWidget.BaseOptionsWidget(model)

Bases: autorigs.modules.base.autoRigsBaseWidget.AutoRigsBaseWidget

hasUnsavedChanges()

markSaved()

class autorigs.modules.base.autoRigsBaseWidget.BaseParamWidget(buildguide)

Bases: autorigs.modules.base.autoRigsBaseWidget.AutoRigsBaseWidget

createParamLayout(name, label, params, node=None)

fromJSON(json)

getWidgetsDict()

hasUnsavedChanges()

markSaved()

toJSON()

unlinkAllNodes()

autorigs.modules.base.baseGuideModel module

class autorigs.modules.base.baseGuideModel.BaseGuideModel

Bases: object

hasUnsavedChanges()

markSaved()

autorigs.modules.base.baseGuideModel.model_setter(arg)

autorigs.modules.base.buildBaseGuide module

class autorigs.modules.base.buildBaseGuide.BaseFactory

Bases: object

classmethod createFromDefault()

classmethod createFromJsonExisting(json)

classmethod createFromJsonNew(json)

class autorigs.modules.base.buildBaseGuide.BaseGuide

Bases: object

BUILD_ERROR_MSG = ''

deleteGuides()

displayGuideData(guidedata, display)

displayGuides(display)

getBuildErrorMsg()

getGuideData(guidename)

getGuideNodesData()

getGuideObject(guidename)

isToggled()

lockGuide(guide, lock)

lockGuideData(guidedata, lock)

lockGuides(lock)

removeGuideObject(guidename)

setGuideDisplay(guidename, display)

showGuides(value)

toJSON()

toggleModule(toggle)

updateDisplay()

autorigs.modules.base.moduleTabsWidget module

class autorigs.modules.base.moduleTabsWidget.ModuleTabsWidget(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

createTabs(prefix, hasproxy, optionswidget, paramswidget)

fromJSON(json)

rename(name)

autorigs.modules.base.rootModule module

Module contents