OPERATORS IN bpy.ops.mhx

bpy.ops.mhx.bake_mhx()

Bake MHX properties to make MHX animations work also if the MHX RTS add-on is disabled

bpy.ops.mhx.clear_animation(startFrame = 1, endFrame = 250, clearArmFK = False, clearArmIK = False, clearLegFK = False, clearLegIK = False, clearSpineFK = False, clearSpineIK = False, useEntireAnimation = True)

Clear Animation For FK or IK Bones

Parameters:

• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation
• clearArmFK (boolean) - Clear Arm FK animation
• clearArmIK (boolean) - Clear Arm IK animation
• clearLegFK (boolean) - Clear Leg FK animation
• clearLegIK (boolean) - Clear Leg IK animation
• clearSpineFK (boolean) - Clear Spine FK animation
• clearSpineIK (boolean) - Clear Spine IK animation
• useEntireAnimation (boolean) - Remove entire animation rather than a frame range

bpy.ops.mhx.clear_feet()

Clear pose for feet and toes

bpy.ops.mhx.clear_fingers()

Clear pose for fingers

bpy.ops.mhx.clear_ik_twist_bones()

Clear IK twist bones

bpy.ops.mhx.constrain_feet()

Add aggressive constraints to the feet

bpy.ops.mhx.convert_mhx_actions(direction = 'MODERN')

Convert actions between legacy MHX (root/hips) and modern MHX (hip/pelvis)

Parameters:

• direction (enum in ['MODERN', 'LEGACY']) - Direction

bpy.ops.mhx.disable_all_layers()

(undocumented operator)

bpy.ops.mhx.enable_all_layers()

(undocumented operator)

bpy.ops.mhx.enforce_all_limits(startFrame = 1, endFrame = 250)

Keep all channels within limits for active action

Parameters:

• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation

bpy.ops.mhx.enforce_limits()

Keep all channels within limits

bpy.ops.mhx.error()

(undocumented operator)

bpy.ops.mhx.floor_fk_feet(startFrame = 1, endFrame = 250, useLeft = True, useRight = True, useHips = True, useMarkers = True)

Keep FK Feet Above Zero Plane

Parameters:

• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation
• useLeft (boolean) - Keep left foot above floor
• useRight (boolean) - Keep right foot above floor
• useHips (boolean) - Also adjust character COM when keeping feet above floor
• useMarkers (boolean) - Use markers to determine foot location

bpy.ops.mhx.floor_ik_feet(startFrame = 1, endFrame = 250, useLeft = True, useRight = True, useHips = True, useMarkers = True, useGlue = True, easeInOut = 3)

Keep IK Feet Above Zero Plane

Parameters:

• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation
• useLeft (boolean) - Keep left foot above floor
• useRight (boolean) - Keep right foot above floor
• useHips (boolean) - Also adjust character COM when keeping feet above floor
• useMarkers (boolean) - Use markers to determine foot location
• useGlue (boolean) - Remove movement of IK effector on shifted frames
• easeInOut (int) - Ease In/Out

bpy.ops.mhx.limbs_bend_positive(useElbows = True, useKnees = True, useBendPositive = True, startFrame = 1, endFrame = 250)

Ensure that limbs' X rotation is positive.

Parameters:

• useElbows (boolean) - Keep elbow bending positive
• useKnees (boolean) - Keep knee bending positive
• useBendPositive (boolean) - Ensure that elbow and knee bending is positive
• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation

bpy.ops.mhx.message()

(undocumented operator)

bpy.ops.mhx.remove_unused_fcurves()

Remove unused f-curves

bpy.ops.mhx.set_fk_all()

Set all limbs to FK

bpy.ops.mhx.set_ik_all()

Set all limbs to IK

bpy.ops.mhx.shift_animation(startFrame = 1, endFrame = 250)

Shift the animation globally for selected boens

Parameters:

• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation

bpy.ops.mhx.snap_fingers(suffix = "")

Snap finger links

Parameters:

• suffix (string) - suffix

bpy.ops.mhx.snap_fk_all()

Snap all FK limbs to the pose of IK limbs

bpy.ops.mhx.snap_fk_left_arm()

Snap the left FK arm to the pose of the left IK arm

bpy.ops.mhx.snap_fk_left_leg()

Snap the left FK leg to the pose of the left IK leg

bpy.ops.mhx.snap_fk_right_arm()

Snap the right FK arm to the pose of the right IK arm

bpy.ops.mhx.snap_fk_right_leg()

Snap the right FK leg to the pose of the right IK leg

bpy.ops.mhx.snap_ik_all(useRotation = True)

Snap all IK limbs to the pose of FK limbs

Parameters:

• useRotation (boolean) - Also match IK effector rotation. Suitable for hand animation

bpy.ops.mhx.snap_ik_left_arm()

Snap the left IK arm to the pose of the left FK arm

bpy.ops.mhx.snap_ik_left_leg(useRotation = True)

Snap the left IK leg to the pose of the left FK leg

Parameters:

• useRotation (boolean) - Also match IK effector rotation. Suitable for hand animation

bpy.ops.mhx.snap_ik_right_arm()

Snap the right IK arm to the pose of the right FK arm

bpy.ops.mhx.snap_ik_right_leg(useRotation = True)

Snap the right IK leg to the pose of the right FK leg

Parameters:

• useRotation (boolean) - Also match IK effector rotation. Suitable for hand animation

bpy.ops.mhx.snap_reverse(prop = "", value = 0.000, bonename = "", revname = "", fk = "", ik = "")

Snap bone to reversed bone

Parameters:

• prop (string) - prop
• value (float) - value
• bonename (string) - bonename
• revname (string) - revname
• fk (string) - fk
• ik (string) - ik

bpy.ops.mhx.snap_shaft()

Snap the shaft links and clear the shaft bone

bpy.ops.mhx.snap_spine()

Snap the spine bones and clear the back bone

bpy.ops.mhx.snap_tongue()

Snap the tongue links and clear the tongue bone

bpy.ops.mhx.toggle_fkik_left_arm()

Toggle left arm FK - IK

bpy.ops.mhx.toggle_fkik_left_leg()

Toggle left leg FK - IK

bpy.ops.mhx.toggle_fkik_right_arm()

Toggle right arm FK - IK

bpy.ops.mhx.toggle_fkik_right_leg()

Toggle right leg FK - IK

bpy.ops.mhx.toggle_left_toe_tarsal()

Toggle left small toes parent (toe or tarsal bone)

bpy.ops.mhx.toggle_limits()

Toggle limit constraints (location, rotation, scale)

bpy.ops.mhx.toggle_right_toe_tarsal()

Toggle right small toes parent (toe or tarsal bone)

bpy.ops.mhx.transfer_to_fk(useElbows = True, useKnees = True, useBendPositive = True, startFrame = 1, endFrame = 250, useRotation = True, useArms = False, useLegs = True, useSpine = False)

Transfer IK animation to FK bones

Parameters:

• useElbows (boolean) - Keep elbow bending positive
• useKnees (boolean) - Keep knee bending positive
• useBendPositive (boolean) - Ensure that elbow and knee bending is positive
• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation
• useRotation (boolean) - Also match IK effector rotation. Suitable for hand animation
• useArms (boolean) - Include arms in FK/IK snapping
• useLegs (boolean) - Include legs in FK/IK snapping
• useSpine (boolean) - Include spine in FK/IK snapping

bpy.ops.mhx.transfer_to_ik(startFrame = 1, endFrame = 250, useRotation = True, useArms = False, useLegs = True, useSpine = False)

Transfer FK animation to IK bones

Parameters:

• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation
• useRotation (boolean) - Also match IK effector rotation. Suitable for hand animation
• useArms (boolean) - Include arms in FK/IK snapping
• useLegs (boolean) - Include legs in FK/IK snapping
• useSpine (boolean) - Include spine in FK/IK snapping

bpy.ops.mhx.transfer_to_links(startFrame = 1, endFrame = 250, useSpine = True, useFingers = False, useTongue = False)

Transfer animation to link bones

Parameters:

• startFrame (int) - Starting frame for the animation
• endFrame (int) - Last frame for the animation
• useSpine (boolean) - Include spine in snapping
• useFingers (boolean) - Include fingers in snapping
• useTongue (boolean) - Include tongue in snapping

bpy.ops.mhx.unbake_mhx()

Remove baked MHX properties to use the MHX RTS add-on

bpy.ops.mhx.unhinge(limb = "", suffix = "")

Remove hinges

Parameters:

• limb (string) - limb
• suffix (string) - suffix

bpy.ops.mhx.update_elbow_knee_parents()

Update parents of the elbow and knee pole targets

bpy.ops.mhx.update_mhx()

(undocumented operator)

bpy.ops.mhx.update_mhx_blender4()

(undocumented operator)