autorigs.modules.limb package

Submodules

autorigs.modules.limb.autoRigsLimbBuilder module

class autorigs.modules.limb.autoRigsLimbBuilder.AutoRigsLimbBuilder
BEFORE_LIMB_CONTROL_RATIO = 2.5
CENTER_SIDE_NAME = 2
LEFT_SIDE_NAME = 0
NUM_NOODLE_BONES = 10
RIGHT_SIDE_NAME = 1
SUFFIX = {'basicbonegroup': 'basic_bone_group', 'basiccontrolgroup': 'control_basic_group', 'basiccontrolsgroup': 'control_basic_group', 'chopnet': 'chopnet', 'controlgroup': 'control_all_group', 'deformbonegroup': 'deform_bone_group', 'detailcontrolsgroup': 'control_detail_group', 'endaffector': 'endaffector', 'endcontrol': 'endcontrol', 'fkcontrolgroup': 'control_fk_group', 'fkcontrolsgroup': 'control_fk_group', 'ikcontrolgroup': 'control_ik_group', 'ikcontrolsgroup': 'control_ik_group', 'nodegroup': 'node_group', 'noodleboneblend': 'noodlebone_blend', 'noodlebonegroup': 'noodle_bone_group', 'noodlecontrolgroup': 'control_noodle_group', 'paraendaffector': 'paraendaffector', 'paraendcontrol': 'paraendcontrol', 'paratwistaffector': 'paratwistaffector', 'paratwistcontrol': 'paratwistcontrol', 'parent': 'parent', 'qendaffector': 'qendaffector', 'qendcontrol': 'qendcontrol', 'qtwistaffector': 'qtwistaffector', 'qtwistcontrol': 'qtwistcontrol', 'twistaffector': 'twistaffector', 'twistcontrol': 'twistcontrol', 'visiblegroup': 'visible_all_group'}
classmethod buildLimbRig(index, autorigs_asset, options, limbguide, parentinfo, interfacebuilder, modulename)
classmethod buildNoodleSide(maincontrols, prefix, rigscale)

TODO(dian) refactor this into components too large!

classmethod buildRigSide(prefix, autorigs_asset, options, limbguide, ismain, parent)
classmethod cleanupMainViewport(maincontrols, rigscale)
classmethod cleanupNoodleViewport(noodlecontrols, rigscale)
classmethod getPrefix(index, side)

autorigs.modules.limb.autoRigsLimbInterfaceBuilder module

class autorigs.modules.limb.autoRigsLimbInterfaceBuilder.AutoRigsLimbInterfaceBuilder
CENTER_SIDE = 2
DISPLAY_MENU = ['ON', 'OFF']
DISPLAY_NOODLE_MENU = ['All', 'Basic', 'Noodle', 'OFF']
INTERFACE_NAME_LABEL = {'bonedisplay': ('bonedisplay', 'Bone Display'), 'controldisplay': ('controldisplay', 'Control Display'), 'controlsfolder': ('controls', 'Controls'), 'displayfkcontrols': ('displayfkcontrols', 'Display FK Controls'), 'fkikblend': ('fkikblend', 'FK->IK Blend'), 'fkikthresh': ('fkikthresh', 'FK Display Threshold'), 'ikdampen': ('ikdampen', 'Max IK Dampening'), 'ikhandlepath': ('ikhandlepath', 'IK Handle Path'), 'iktwisthandlepath': ('iktwisthandlepath', 'IK Twist Handle Path'), 'kinsolverpath': ('kinsolverpath', 'Kinematic Solver Path'), 'lowerbonepath': ('lowerbonepath', 'Lower Bone Path'), 'lowerfkcontrolpath': ('lowerfkcontrolpath', 'Lower FK Control Path'), 'lowerinitlen': ('lowerinitlen', 'Lower Initial Length'), 'lowermanualstretchlen': ('lowermanualstretchlen', 'Lower Manual Stretch'), 'lowerstretchcalc': ('lowerstretchcalc', 'Lower Stretch Calculations'), 'matchfkik': ('matchfkik', 'Match FK to IK'), 'matchikfk': ('matchikfk', 'Match IK to FK'), 'optionsfolder': ('options', 'Options'), 'stretch': ('stretch', 'Stretch'), 'totalautostretch': ('totalautostretch', 'Total Auto Stretch'), 'totalmanstretchlen': ('totalmanstretchlen', 'Total Manual Stretch Len'), 'upperbonepath': ('upperbonepath', 'Upper Bone Path'), 'upperfkcontrolpath': ('upperfkcontrolpath', 'Upper FK Control Path'), 'upperinitlen': ('upperinitlen', 'Upper Initial Length'), 'uppermanualstretchlen': ('uppermanualstretchlen', 'Upper Manual Stretch'), 'upperstretchcalc': ('upperstretchcalc', 'Upper Stretch Calculations')}
LEFT_SIDE = 0
MATCH_FK_IK_POSTFIX = 'MatchFKIK'
MATCH_IK_FK_POSTFIX = 'MatchIKFK'
MATCH_NOODLE_TWIST_POSTFIX = 'NoodleTwist'
RIGHT_SIDE = 1
classmethod buildRigControlsInterfaceParms(controls, assetnode, options, prefix, side)
classmethod buildRigInterface(autorig_asset, options, rigcontrols, side, index, modulename)
classmethod buildRigInterfaceParms(controls, assetnode, options, prefix, side, modulename)
classmethod buildRigOptionsInterfaceParms(assetnode, options, prefix, side)
classmethod getBeforeLimbStretchExpr(beforelimbroot, beforelimbend, initlengthstr, assetnode, prefix)
classmethod getEvalParmStr(parm, prefix)
classmethod getLimbMatchFKtoIKStr(assetnode, controls, isstretchy, prefix)
classmethod getLimbMatchIKtoFKStr(assetnode, controls, isstretchy, prefix)
classmethod getLimbNoodleTwistStr(assetnode, controls, isstretchy, prefix)
classmethod getParmStr(parm, prefix)
classmethod linkRigControlsInterfaceParms(assetnode, controls, options, prefix)
classmethod linkRigInterfaceParms(assetnode, controls, options, prefix)
classmethod linkRigOptionsInterfaceParms(assetnode, controls, options, prefix)
classmethod setMidTangentExpressions(lowertangenttrans, uppertangenttrans, lower, upper)
classmethod setupBoneDisplayChannel(bone, assetnode, prefix)

autorigs.modules.limb.buildLimbGuide module

class autorigs.modules.limb.buildLimbGuide.LimbFactory

Bases: autorigs.modules.base.buildBaseGuide.BaseFactory

classmethod createFromDefault(json, assetnode)
class autorigs.modules.limb.buildLimbGuide.LimbGuide(assetnode)

Bases: autorigs.modules.base.buildBaseGuide.BaseGuide

SIDE_LEFT = 0
SIDE_RIGHT = 1
createFromJson(json, guidejson)
deleteGuides()
existingFromJson(json)

Assumes that the guide nodes exists in the network and finds it to set this class instead of creating the nodes

getGuideObject(guidename)
getGuideObjectSide(mainbool, guidepart)
setMirrorGuidesDisplay(canchangedisplay)
toJSON()
toJsonGuideTypeNames(jsonobj, ismain)

overridden by subclass

toJsonGuidenames(jsonobj, ismain)
toggleGuideDisplay(toggle)
toggleMainGuidesDisplay(toggle)
toggleMirrorGuidesDisplay(toggle)
updateMirror(toggle)
updateSide(side)
updateToMasterParent(masternode)
updateToSpineHookParent(spinenode)

autorigs.modules.limb.limbGuideOptions module

class autorigs.modules.limb.limbGuideOptions.ArmOptionsWidget(limbguide, spinemodules, mastermodule)

Bases: autorigs.modules.limb.limbGuideOptions.ModuleOptionsWidget

MIRROR_LABEL = 'Mirror'
NOODLE_LABEL = 'Noodle'
PARENT_LABEL = 'Arm Parent'
PREFIX_DEFAULT_LABEL = 'L_Arm'
PREFIX_LABEL = 'Prefix'
SIDE_BUTTON_LABELS = ['Left', 'Right']
SIDE_LABEL = 'Side'
STRETCH_LABEL = 'Stretch'
getSpineParentGuides(spinemodule)
updateParent(parentmodule, node)
class autorigs.modules.limb.limbGuideOptions.LegOptionsWidget(limbguide, spinemodules, mastermodule)

Bases: autorigs.modules.limb.limbGuideOptions.ModuleOptionsWidget

MIRROR_LABEL = 'Mirror'
NOODLE_LABEL = 'Noodle'
PARENT_LABEL = 'Leg Parent'
PREFIX_DEFAULT_LABEL = 'L_Leg'
PREFIX_LABEL = 'Prefix'
SIDE_BUTTON_LABELS = ['Left', 'Right']
SIDE_LABEL = 'Side'
STRETCH_LABEL = 'Stretch'
getSpineParentGuides(spinemodule)
updateParent(parentmodule, node)
class autorigs.modules.limb.limbGuideOptions.ModuleOptionsWidget(limbguide, spinemodules, mastermodule)

Bases: sphinx.ext.autodoc.importer._MockObject

createParentWidget(spinemodules)
fromJSON(json)
getAllWidgets()
getBuiltParentInfo()
getDefaultParentPath()
getExistingParents(spinemodules)
getLeftRightSide()
getLegPrefix()
getMasterParentGuides(mastermodule)
getSide()
isMirror()
isNoodle()
isStretchy()
linkSide(callback_fcn)
onNoodleChanged(toggle)
onSideChanged(index)
toJSON()
unlinkAllNodes()
unlinkSide(callback_fcn)
updateParentModules(spinemodules)
class autorigs.modules.limb.limbGuideOptions.QuadLegOptionsWidget(limbguide, spinemodules, mastermodule)

Bases: autorigs.modules.limb.limbGuideOptions.ModuleOptionsWidget

MIRROR_LABEL = 'Mirror'
NOODLE_LABEL = 'Noodle'
PARENT_LABEL = 'QuadLeg Parent'
PREFIX_DEFAULT_LABEL = 'QL_Leg'
PREFIX_LABEL = 'Prefix'
SIDE_BUTTON_LABELS = ['Left', 'Right']
SIDE_LABEL = 'Side'
STRETCH_LABEL = 'Stretch'
getSpineParentGuides(spinemodule)
updateParent(parentmodule, node)

autorigs.modules.limb.limbGuideParams module

class autorigs.modules.limb.limbGuideParams.ArmParamsWidget(limbguide)

Bases: autorigs.modules.limb.limbGuideParams.ModuleParamsWidget

JSON_ALL = 'allguides'
JSON_BEFORE_LIMB = 'clavicle'
JSON_LIMB_END = 'wrist'
JSON_LIMB_MIDDLE = 'elbow'
JSON_LIMB_START = 'shoulder'
JSON_LIMB_TWIST = 'armtwist'
JSON_MASTER = 'master'
LABEL_ALL = 'All Guides'
LABEL_BEFORE_LIMB = 'Clavicle'
LABEL_LIMB_END = 'Wrist'
LABEL_LIMB_MIDDLE = 'Elbow'
LABEL_LIMB_START = 'Shoulder'
LABEL_LIMB_TWIST = 'Arm Twist'
LABEL_MASTER = 'Master'
class autorigs.modules.limb.limbGuideParams.LegParamsWidget(limbguide)

Bases: autorigs.modules.limb.limbGuideParams.ModuleParamsWidget

JSON_ALL = 'allguides'
JSON_BEFORE_LIMB = 'pelvis'
JSON_LIMB_END = 'ankle'
JSON_LIMB_MIDDLE = 'knee'
JSON_LIMB_START = 'hip'
JSON_LIMB_TWIST = 'legtwist'
JSON_MASTER = 'master'
LABEL_ALL = 'All Guides'
LABEL_BEFORE_LIMB = 'Pelvis'
LABEL_LIMB_END = 'Ankle'
LABEL_LIMB_MIDDLE = 'Knee'
LABEL_LIMB_START = 'Hip'
LABEL_LIMB_TWIST = 'Leg Twist'
LABEL_MASTER = 'Master'
class autorigs.modules.limb.limbGuideParams.ModuleParamsWidget(limbguide)

Bases: sphinx.ext.autodoc.importer._MockObject

fromJSON(json)
toJSON()
unlinkAllNodes()
class autorigs.modules.limb.limbGuideParams.QuadLegParamsWidget(limbguide)

Bases: autorigs.modules.limb.limbGuideParams.ModuleParamsWidget

JSON_ALL = 'allguides'
JSON_BEFORE_LIMB = 'pelvis'
JSON_FOOT_END = 'foot'
JSON_LIMB_END = 'ankle'
JSON_LIMB_MIDDLE = 'knee'
JSON_LIMB_START = 'hip'
JSON_LIMB_TWIST = 'legtwist'
JSON_MASTER = 'master'
LABEL_ALL = 'All Guides'
LABEL_BEFORE_LIMB = 'Pelvis'
LABEL_FOOT_END = 'Foot'
LABEL_LIMB_END = 'Ankle'
LABEL_LIMB_MIDDLE = 'Knee'
LABEL_LIMB_START = 'Hip'
LABEL_LIMB_TWIST = 'Leg Twist'
LABEL_MASTER = 'Master'

autorigs.modules.limb.limbModule module

class autorigs.modules.limb.limbModule.LimbGuideTab(buildguides, spinemodules, mastermodule)

Bases: autorigs.modules.base.rootModule.ModuleGuideTab

getBuiltParentInfo()
getSide()
linkSide(callback_fcn)
unlinkSide(callback_fcn)
updateParent(spinemodules)
class autorigs.modules.limb.limbModule.LimbModule(autorig_asset, guidesfactory)

Bases: autorigs.modules.base.rootModule.Module

buildFromDefault(json)
buildFromJsonExisting(json)
buildFromJsonNew(json)
buildRig(index)
getBUiltObject(builtkey)
getBuiltObjectSide(builtkey, ismain)
getBuiltParentInfo()
getBuiltRig()
getSide()
linkSide(callback_fcn)
unlinkSide(callback_fcn)
updateParent(modulesdict)

Module contents