Pose Operators

bpy.ops.pose.armature_apply()

Apply the current pose as the new rest pose

bpy.ops.pose.armature_layers(layers=(False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False))

Change the visible armature layers

Parameters:

• layers (boolean array of 32 items, (optional)) – Layer, Armature layers to make visible

bpy.ops.pose.autoside_names(axis='XAXIS')

Automatically renames the selected bones according to which side of the target axis they fall on

Parameters:

• axis (enum in [‘XAXIS’, ‘YAXIS’, ‘ZAXIS’], (optional)) – Axis, Axis tag names with.

bpy.ops.pose.bone_layers(layers=(False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False))

Change the layers that the selected bones belong to

Parameters:

• layers (boolean array of 32 items, (optional)) – Layer, Armature layers that bone belongs to

bpy.ops.pose.breakdown(prev_frame=0, next_frame=0, percentage=0.5)

Create a suitable breakdown pose on the current frame

Parameters:

• prev_frame (int in [-300000, 300000], (optional)) – Previous Keyframe, Frame number of keyframe immediately before the current frame.
• next_frame (int in [-300000, 300000], (optional)) – Next Keyframe, Frame number of keyframe immediately after the current frame.
• percentage (float in [0, 1], (optional)) – Percentage, Weighting factor for the sliding operation

bpy.ops.pose.constraint_add(type='')

Add a constraint to the active bone

Parameters:

• type (enum in [‘COPY_LOCATION’, ‘COPY_ROTATION’, ‘COPY_SCALE’, ‘COPY_TRANSFORMS’, ‘LIMIT_DISTANCE’, ‘LIMIT_LOCATION’, ‘LIMIT_ROTATION’, ‘LIMIT_SCALE’, ‘MAINTAIN_VOLUME’, ‘TRANSFORM’, ‘CLAMP_TO’, ‘DAMPED_TRACK’, ‘IK’, ‘LOCKED_TRACK’, ‘SPLINE_IK’, ‘STRETCH_TO’, ‘TRACK_TO’, ‘ACTION’, ‘CHILD_OF’, ‘FLOOR’, ‘FOLLOW_PATH’, ‘PIVOT’, ‘RIGID_BODY_JOINT’, ‘SCRIPT’, ‘SHRINKWRAP’], (optional)) – Type

bpy.ops.pose.constraint_add_with_targets(type='')

Add a constraint to the active bone, with target (where applicable) set to the selected Objects/Bones

Parameters:

• type (enum in [‘COPY_LOCATION’, ‘COPY_ROTATION’, ‘COPY_SCALE’, ‘COPY_TRANSFORMS’, ‘LIMIT_DISTANCE’, ‘LIMIT_LOCATION’, ‘LIMIT_ROTATION’, ‘LIMIT_SCALE’, ‘MAINTAIN_VOLUME’, ‘TRANSFORM’, ‘CLAMP_TO’, ‘DAMPED_TRACK’, ‘IK’, ‘LOCKED_TRACK’, ‘SPLINE_IK’, ‘STRETCH_TO’, ‘TRACK_TO’, ‘ACTION’, ‘CHILD_OF’, ‘FLOOR’, ‘FOLLOW_PATH’, ‘PIVOT’, ‘RIGID_BODY_JOINT’, ‘SCRIPT’, ‘SHRINKWRAP’], (optional, never None)) – Type

bpy.ops.pose.constraints_clear()

Clear all the constraints for the selected bones

bpy.ops.pose.constraints_copy()

Copy constraints to other selected bones.

bpy.ops.pose.copy()

Copies the current pose of the selected bones to copy/paste buffer

bpy.ops.pose.flags_set(type='DRAWWIRE', mode='CLEAR')

Set flags for armature bones

Parameters:

• type (enum in [‘DRAWWIRE’, ‘DEFORM’, ‘MULT_VG’, ‘HINGE’, ‘NO_SCALE’, ‘LOCKED’], (optional, never None)) – Type
• mode (enum in [‘CLEAR’, ‘ENABLE’, ‘TOGGLE’], (optional, never None)) – Mode

bpy.ops.pose.flip_names()

Flips (and corrects) the names of selected bones

bpy.ops.pose.group_add()

Add a new bone group

bpy.ops.pose.group_assign(type=0)

Add selected bones to the chosen bone group

Parameters:

• type (int in [0, 10], (optional)) – Bone Group Index

bpy.ops.pose.group_deselect()

Deselect bones of active Bone Group

bpy.ops.pose.group_remove()

Removes the active bone group

bpy.ops.pose.group_select()

Select bones in active Bone Group

bpy.ops.pose.group_unassign()

Remove selected bones from all bone groups

bpy.ops.pose.hide(unselected=False)

Undocumented (contribute)

Parameters:

• unselected (boolean, (optional)) – Unselected

bpy.ops.pose.ik_add(with_targets=True)

Add IK Constraint to the active Bone

Parameters:

• with_targets (boolean, (optional)) – With Targets, Assign IK Constraint with targets derived from the select bones/objects

bpy.ops.pose.ik_clear()

Remove all IK Constraints from selected bones

bpy.ops.pose.loc_clear()

Undocumented (contribute)

bpy.ops.pose.metarig_assign()

Assign to the active posebone

File :ui/properties_data_armature_rigify.py:278

bpy.ops.pose.metarig_clear()

Clear type from the active posebone

File :ui/properties_data_armature_rigify.py:297

bpy.ops.pose.metarig_generate()

Generates a metarig from the active armature

File :ui/properties_data_armature_rigify.py:149

bpy.ops.pose.metarig_graph()

Create a graph from the active armature through graphviz

File :ui/properties_data_armature_rigify.py:208

bpy.ops.pose.metarig_reload()

Re-Scan the metarig package directory for scripts

File :ui/properties_data_armature_rigify.py:116

bpy.ops.pose.metarig_sample_add(metarig_type="")

Create a sample metarig to be modified before generating the final rig.

Parameters:

• metarig_type (string, (optional)) – Type, Name of the rig type to generate a sample of, a blank string for all

File :

ui/properties_data_armature_rigify.py:187

bpy.ops.pose.metarig_to_script(filepath="")

Write the edit armature out as a python script

Parameters:

• filepath (string, (optional)) – File Path, File path used for exporting the Armature file

File :

ui/properties_data_armature_rigify.py:245

bpy.ops.pose.metarig_validate()

Validate a metarig from the active armature

File :ui/properties_data_armature_rigify.py:169

bpy.ops.pose.paste(flipped=False)

Pastes the stored pose on to the current pose

Parameters:

• flipped (boolean, (optional)) – Flipped on X-Axis

bpy.ops.pose.paths_calculate()

Calculate paths for the selected bones

bpy.ops.pose.paths_clear()

Clear path caches for selected bones

bpy.ops.pose.push(prev_frame=0, next_frame=0, percentage=0.5)

Exaggerate the current pose

Parameters:

• prev_frame (int in [-300000, 300000], (optional)) – Previous Keyframe, Frame number of keyframe immediately before the current frame.
• next_frame (int in [-300000, 300000], (optional)) – Next Keyframe, Frame number of keyframe immediately after the current frame.
• percentage (float in [0, 1], (optional)) – Percentage, Weighting factor for the sliding operation

bpy.ops.pose.quaternions_flip()

Flip quaternion values to achieve desired rotations, while maintaining the same orientations

bpy.ops.pose.relax(prev_frame=0, next_frame=0, percentage=0.5)

Make the current pose more similar to its surrounding ones

Parameters:

• prev_frame (int in [-300000, 300000], (optional)) – Previous Keyframe, Frame number of keyframe immediately before the current frame.
• next_frame (int in [-300000, 300000], (optional)) – Next Keyframe, Frame number of keyframe immediately after the current frame.
• percentage (float in [0, 1], (optional)) – Percentage, Weighting factor for the sliding operation

bpy.ops.pose.reveal()

Undocumented (contribute)

bpy.ops.pose.rot_clear()

Undocumented (contribute)

bpy.ops.pose.scale_clear()

Undocumented (contribute)

bpy.ops.pose.select_all(action='TOGGLE')

Undocumented (contribute)

Parameters:

• action (enum in [‘TOGGLE’, ‘SELECT’, ‘DESELECT’, ‘INVERT’], (optional, never None)) – Action, Selection action to execute

bpy.ops.pose.select_constraint_target()

Undocumented (contribute)

bpy.ops.pose.select_grouped(extend=False, type='LAYER')

Select all visible bones grouped by various properties

Parameters:

• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first.
• type (enum in [‘LAYER’, ‘GROUP’], (optional, never None)) – Type

bpy.ops.pose.select_hierarchy(direction='PARENT', extend=False)

Undocumented (contribute)

Parameters:

• direction (enum in [‘PARENT’, ‘CHILD’], (optional, never None)) – Direction
• extend (boolean, (optional)) – Add to Selection

bpy.ops.pose.select_inverse()

Undocumented (contribute)

bpy.ops.pose.select_linked(extend=False)

Undocumented (contribute)

Parameters:

• extend (boolean, (optional)) – Extend, Extend selection instead of deselecting everything first.

bpy.ops.pose.select_parent()

Undocumented (contribute)

bpy.ops.pose.visual_transform_apply()

Apply final constrained position of pose bones to their transform.