autorigs.modules.arm package

Submodules

autorigs.modules.arm.armModule module

Used by autodoc_mock_imports.

autorigs.modules.arm.autoRigsArmBuilder module

class autorigs.modules.arm.autoRigsArmBuilder.AutoRigsArmBuilder

Bases: autorigs.modules.limb.autoRigsLimbBuilder.AutoRigsLimbBuilder

CENTER_SIDE_NAME = 2

DEFAULT_LIMB_PREFIX = 'Arm'

LEFT_LIMB_PREFIX = 'L_Arm'

LEFT_SIDE_NAME = 0

LIMBTYPE = 'BIPED'

RIGHT_LIMB_PREFIX = 'R_Arm'

RIGHT_SIDE_NAME = 1

SUFFIX = {'basicbonegroup': 'basic_bone_group', 'basiccontrolgroup': 'control_basic_group', 'basiccontrolsgroup': 'control_basic_group', 'beforelimbbone': 'clavicle', 'beforelimbend': 'clavicle_end', 'beforelimbroot': 'clavicleroot', 'beforelimbsolver': 'clavicle_solver', 'chopnet': 'chopnet', 'controlgroup': 'control_all_group', 'ctrl0normal': 'shoulder_normal', 'ctrl0tangent': 'shoulder_tangent', 'ctrl1midangle': 'elbow_midangle', 'ctrl1normal': 'elbow_normal', 'ctrl1tangentlower': 'elbow_tangent_lower', 'ctrl1tangentupper': 'elbow_tangent_upper', 'ctrl2normal': 'wrist_normal', 'ctrl2tangent': 'wrist_tangent', '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', 'lowerbone': 'lowerarm', 'lowercurve': 'lowerarm_curve', 'lowercurvenormalattrib': 'lower_curvenormal', 'lowercurvepointsop': 'lower_curvepointsop', 'lowercurvesop': 'lower_curvesop', 'lowerfkcontrol': 'lowerarm_fkcontrol', 'lowerfkinit': 'lowerarm_fkinit', 'lowerinit': 'lowerarm_init', 'lowermid': 'lowerarm_mid', 'lowernoodlebone': 'lower_noodlebone', 'lowernoodlesolver': 'lower_noodlesolver', 'lowertangenttrans': 'lower_tangent_translate', 'nodegroup': 'node_group', 'noodleboneblend': 'noodlebone_blend', 'noodlebonegroup': 'noodle_bone_group', 'noodlecontrolgroup': 'control_noodle_group', 'noodlectrl0': 'noodle_ctrl_shoulder', 'noodlectrl1': 'noodle_ctrl_elbow', 'noodlectrl2': 'noodle_ctrl_wrist', 'noodlectrllower': 'noodle_ctrl_lowerarm', 'noodlectrlupper': 'noodle_ctrl_upperarm', 'paraendaffector': 'paraendaffector', 'paraendcontrol': 'paraendcontrol', 'paratwistaffector': 'paratwistaffector', 'paratwistcontrol': 'paratwistcontrol', 'parent': 'parent', 'qendaffector': 'qendaffector', 'qendcontrol': 'qendcontrol', 'qtwistaffector': 'qtwistaffector', 'qtwistcontrol': 'qtwistcontrol', 'solver': 'arm_solver', 'twistaffector': 'twistaffector', 'twistcontrol': 'twistcontrol', 'upperbone': 'upperarm', 'uppercurve': 'upperarm_curve', 'uppercurvenormalattrib': 'upper_curvenormal', 'uppercurvepointsop': 'upper_curvepointsop', 'uppercurvesop': 'upper_curvesop', 'upperfkcontrol': 'upperarm_fkcontrol', 'upperinit': 'upperarm_init', 'uppermid': 'upperarm_mid', 'uppernoodlebones': 'upper_noodlebone', 'uppernoodlesolver': 'upper_noodlesolver', 'uppertangenttrans': 'upper_tangent_translate', 'visiblegroup': 'visible_all_group'}

classmethod buildRig(index, autorigs_asset, options, armguide, parent, modulename)

autorigs.modules.arm.autoRigsArmInterfaceBuilder module

class autorigs.modules.arm.autoRigsArmInterfaceBuilder.AutoRigsArmInterfaceBuilder

Bases: autorigs.modules.limb.autoRigsLimbInterfaceBuilder.AutoRigsLimbInterfaceBuilder

INTERFACE_NAME_LABEL = {'beforelimbinitlen': ('shoulderinitlen', 'Shoulder Initial Length'), 'beforelimbstretch': ('shoulderstretch', 'Shoulder Stretch'), 'beforelimbstretchcalc': ('shouldercalc', 'Shoulder Calculations'), 'bonedisplay': ('bonedisplay', 'Bone Display'), 'controlbeforelimb': ('clavicleroot', 'Clavicle Root'), 'controldisplay': ('controldisplay', 'Control Display'), 'controlend': ('end', 'End Control'), 'controllimbend': ('clavicleend', 'Clavicle End'), 'controllowerlimbfk': ('lowerarmfk', 'Lower Arm FK'), 'controlnoodle0': ('noodleshoulder', 'Shoulder Root'), 'controlnoodle0tangent': ('shouldertangent', 'Shoulder Tangent'), 'controlnoodle1': ('noodleelbow', 'Elbow'), 'controlnoodle1lowertangent': ('elbow_lowertangent', 'Elbow Lower Tangent'), 'controlnoodle1tangents': ('elbow_tangents', 'Elbow Tangents'), 'controlnoodle1uppertangent': ('elbow_uppertangent', 'Elbow Upper Tangent'), 'controlnoodle2': ('noodlewrist', 'Wrist'), 'controlnoodle2tangent': ('wristtangent', 'Wrist Tangent'), 'controlnoodlelower': ('noodlelower', 'Lower Arm'), 'controlnoodleupper': ('noodleupper', 'Upper Arm'), 'controlsfolder': ('controls', 'Controls'), 'controltwist': ('twist', 'Twist Control'), 'controlupperlimbfk': ('upperarmfk', 'Upper Arm FK'), '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'), 'lowerfkstretch': ('lowerfkstretch', 'Lowerarm FK Stretch'), 'lowerikstretch': ('lowerikstretch', 'Lowerarm IK Stretch'), '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'), 'maxstretch': ('maxstretch', 'Arm Max Stretch'), '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'), 'upperfkstretch': ('upperfkstretch', 'Upperarm FK Stretch'), 'upperikstretch': ('upperikstretch', 'Upperarm IK Stretch'), 'upperinitlen': ('upperinitlen', 'Upper Initial Length'), 'uppermanualstretchlen': ('uppermanualstretchlen', 'Upper Manual Stretch'), 'upperstretchcalc': ('upperstretchcalc', 'Upper Stretch Calculations')}

LIMBTYPE = 'BIPED'

L_INTERFACE_NAME_LABEL = ('left', 'Left ')

L_PREFIX_NAME = 'leftarm'

R_INTERFACE_NAME_LABEL = ('right', 'Right ')

R_PREFIX_NAME = 'rightarm'

autorigs.modules.arm.buildArmGuide module

class autorigs.modules.arm.buildArmGuide.ArmFactory

Bases: autorigs.modules.limb.buildLimbGuide.LimbFactory

classmethod createFromJsonExisting(json, assetnode)

classmethod createFromJsonNew(json, guidejson, assetnode)

class autorigs.modules.arm.buildArmGuide.ArmGuide(assetnode)

Bases: autorigs.modules.limb.buildLimbGuide.LimbGuide

JSON_LABELS = {'beforelimb': 'clavicle', 'guidecurve': 'guidecurve', 'guidecurve_add': 'guidecurve_add', 'guidecurve_merge': 'guidecurve_merge', 'guidecurve_out': 'guidecurve_out', 'guidecurve_polywire': 'guidecurve_polywire', 'limbend': 'wrist', 'limbmiddle': 'elbow', 'limbstart': 'shoulder', 'limbtwist': 'elbow_twist', 'limbtwisttrans': 'elbow_twist_transform', 'master': 'master'}

JSON_PARAM_LABELS = {'beforelimb': 'clavicle', 'limbend': 'wrist', 'limbmiddle': 'elbow', 'limbstart': 'shoulder', 'master': 'master'}

Module contents