Package bpy :: Package ops :: Module pose
[hide private]
[frames] | no frames]

Module pose

Functions [hide private]
 
apply()
Apply the current pose as the new rest pose.
 
armature_layers(layers=(False, False, False, False, False, False, False, False, False...)
Change the visible armature layers.
 
autoside_names(axis='XAXIS')
Automatically renames the selected bones according to which side of the target axis they fall on.
 
bone_layers(layers=(False, False, False, False, False, False, False, False, False...)
Change the layers that the selected bones belong to.
 
breakdown(prev_frame=0, next_frame=0, percentage=0.5)
Create a suitable breakdown pose on the current frame.
 
constraint_add(type='')
Add a constraint to the active bone.
 
constraint_add_with_targets(type='')
Add a constraint to the active bone, with target (where applicable) set to the selected Objects/Bones.
 
constraints_clear()
Clear all the constraints for the selected bones.
 
copy()
Copies the current pose of the selected bones to copy/paste buffer.
 
flags_set(type='DRAWWIRE', mode='CLEAR')
Set flags for armature bones.
 
flip_names()
Flips (and corrects) the names of selected bones.
 
group_add()
Add a new bone group.
 
group_assign(type=0)
Add selected bones to the chosen bone group.
 
group_remove()
Removes the active bone group.
 
group_unassign()
Add selected bones from all bone groups
 
hide(unselected=False)
(undocumented operator)
 
ik_add(with_targets=True)
Add IK Constraint to the active Bone.
 
ik_clear()
Remove all IK Constraints from selected bones.
 
loc_clear()
(undocumented operator)
 
paste(flipped=False)
Pastes the stored pose on to the current pose.
 
paths_calculate()
Calculate paths for the selected bones.
 
paths_clear()
Clear path caches for selected bones.
 
push(prev_frame=0, next_frame=0, percentage=0.5)
Exaggerate the current pose
 
relax(prev_frame=0, next_frame=0, percentage=0.5)
Make the current pose more similar to its surrounding ones.
 
reveal()
(undocumented operator)
 
rot_clear()
(undocumented operator)
 
scale_clear()
(undocumented operator)
 
select_all(action='TOGGLE')
(undocumented operator)
 
select_constraint_target()
(undocumented operator)
 
select_hierarchy(direction='PARENT', extend=False)
(undocumented operator)
 
select_inverse()
(undocumented operator)
 
select_linked(extend=False)
(undocumented operator)
 
select_parent()
(undocumented operator)
Function Details [hide private]

armature_layers(layers=(False, False, False, False, False, False, False, False, False...)

 

Change the visible armature layers.

Parameters:
  • layers (boolean array of 32 items)

autoside_names(axis='XAXIS')

 

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

Parameters:
  • axis (enum) - Axis tag names with. in (XAXIS, YAXIS, ZAXIS)

bone_layers(layers=(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)

breakdown(prev_frame=0, next_frame=0, percentage=0.5)

 

Create a suitable breakdown pose on the current frame.

Parameters:
  • prev_frame (int) - Frame number of keyframe immediately before the current frame. in (-300000, 300000)
  • next_frame (int) - Frame number of keyframe immediately after the current frame. in (-300000, 300000)
  • percentage (float) - Weighting factor for the sliding operation in (0, 1)

constraint_add(type='')

 

Add a constraint to the active bone.

Parameters:
  • type (enum) - in (COPY_LOCATION, COPY_ROTATION, COPY_SCALE, LIMIT_DISTANCE, LIMIT_LOCATION, LIMIT_ROTATION, LIMIT_SCALE, TRANSFORM, CLAMP_TO, DAMPED_TRACK, IK, LOCKED_TRACK, SPLINE_IK, STRETCH_TO, TRACK_TO, ACTION, CHILD_OF, FLOOR, FOLLOW_PATH, RIGID_BODY_JOINT, SCRIPT, SHRINKWRAP)

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, LIMIT_DISTANCE, LIMIT_LOCATION, LIMIT_ROTATION, LIMIT_SCALE, TRANSFORM, CLAMP_TO, DAMPED_TRACK, IK, LOCKED_TRACK, SPLINE_IK, STRETCH_TO, TRACK_TO, ACTION, CHILD_OF, FLOOR, FOLLOW_PATH, RIGID_BODY_JOINT, SCRIPT, SHRINKWRAP)

flags_set(type='DRAWWIRE', mode='CLEAR')

 

Set flags for armature bones.

Parameters:
  • type (enum) - in (DRAWWIRE, DEFORM, MULT_VG, HINGE, NO_SCALE, LOCKED)
  • mode (enum) - in (CLEAR, ENABLE, TOGGLE)

group_assign(type=0)

 

Add selected bones to the chosen bone group.

Parameters:
  • type (int) - in (0, 10)

hide(unselected=False)

 

(undocumented operator)

Parameters:
  • unselected (boolean)

ik_add(with_targets=True)

 

Add IK Constraint to the active Bone.

Parameters:
  • with_targets (boolean)

paste(flipped=False)

 

Pastes the stored pose on to the current pose.

Parameters:
  • flipped (boolean)

push(prev_frame=0, next_frame=0, percentage=0.5)

 

Exaggerate the current pose

Parameters:
  • prev_frame (int) - Frame number of keyframe immediately before the current frame. in (-300000, 300000)
  • next_frame (int) - Frame number of keyframe immediately after the current frame. in (-300000, 300000)
  • percentage (float) - Weighting factor for the sliding operation in (0, 1)

relax(prev_frame=0, next_frame=0, percentage=0.5)

 

Make the current pose more similar to its surrounding ones.

Parameters:
  • prev_frame (int) - Frame number of keyframe immediately before the current frame. in (-300000, 300000)
  • next_frame (int) - Frame number of keyframe immediately after the current frame. in (-300000, 300000)
  • percentage (float) - Weighting factor for the sliding operation in (0, 1)

select_all(action='TOGGLE')

 

(undocumented operator)

Parameters:
  • action (enum) - Selection action to execute in (TOGGLE, SELECT, DESELECT, INVERT)

select_hierarchy(direction='PARENT', extend=False)

 

(undocumented operator)

Parameters:
  • direction (enum) - in (PARENT, CHILD)
  • extend (boolean)

select_linked(extend=False)

 

(undocumented operator)

Parameters:
  • extend (boolean)