Pose(bpy_struct)

base class — bpy_struct

class bpy.types.Pose(bpy_struct)

A collection of pose channels, including settings for animating bones

animation_visualization

Animation data for this data-block (readonly, never None)

Type:

AnimViz

bones

Individual pose bones for the armature (default None, readonly)

Type:

bpy_prop_collection[PoseBone]

ik_param

Parameters for IK solver (readonly)

Type:

IKParam

ik_solver

Selection of IK solver for IK chain (default 'LEGACY')

  • LEGACY Standard – Original IK solver.

  • ITASC iTaSC – Multi constraint, stateful IK solver.

Type:

Literal[‘LEGACY’, ‘ITASC’]

use_auto_ik

Add temporary IK constraints while grabbing bones in Pose Mode (default False)

Type:

bool

use_mirror_relative

Apply relative transformations in X-mirror mode (not supported with Auto IK) (default False)

Type:

bool

use_mirror_x

Apply changes to matching bone on opposite side of X-Axis (default False)

Type:

bool

classmethod apply_pose_from_action(action, *, evaluation_time=0.0)

Apply the given action to this pose by evaluating it at a specific time. Only updates the pose of selected bones, or all bones if none are selected.

Parameters:

  • action (Action) – Action, The Action containing the pose

  • evaluation_time (float) – Evaluation Time, Time at which the given action is evaluated to obtain the pose (in [-inf, inf], optional)

classmethod blend_pose_from_action(action, *, blend_factor=1.0, evaluation_time=0.0)

Blend the given action into this pose by evaluating it at a specific time. Only updates the pose of selected bones, or all bones if none are selected.

Parameters:

  • action (Action) – Action, The Action containing the pose

  • blend_factor (float) – Blend Factor, How much the given Action affects the final pose (in [0, 1], optional)

  • evaluation_time (float) – Evaluation Time, Time at which the given action is evaluated to obtain the pose (in [-inf, inf], optional)

classmethod backup_create(action)

Create a backup of the current pose. Only those bones that are animated in the Action are backed up. The object owns the backup, and each object can have only one backup at a time. When you no longer need it, it must be freed use backup_clear().

Parameters:

action (Action) – Action, An Action with animation data for the bones. Only the animated bones will be included in the backup.

classmethod backup_restore()

Restore the previously made pose backup. This can be called multiple times. See Pose.backup_create() for more info.

Returns:

True when the backup was restored, False if there was no backup to restore

Return type:

bool

classmethod backup_clear()

Free a previously made pose backup. See Pose.backup_create() for more info.

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References