Armature(ID)

base classes — bpy_struct, ID

class bpy.types.Armature(ID)

Armature data-block containing a hierarchy of bones, usually used for rigging characters

animation_data

Animation data for this data-block (readonly)

Type:

AnimData

axes_position

The position for the axes on the bone. Increasing the value moves it closer to the tip; decreasing moves it closer to the root. (in [0, 1], default 0.0)

Type:

float

bones

(default None, readonly)

Type:

ArmatureBones[Bone]

collections

(default None)

Type:

BoneCollections[BoneCollection]

collections_all

List of all bone collections of the armature (default None, readonly)

Type:

bpy_prop_collection[BoneCollection]

display_type

(default 'OCTAHEDRAL')

  • OCTAHEDRAL Octahedral – Display bones as octahedral shape (default).

  • STICK Stick – Display bones as simple 2D lines with dots.

  • BBONE B-Bone – Display bones as boxes, showing subdivision and B-Splines.

  • ENVELOPE Envelope – Display bones as extruded spheres, showing deformation influence volume.

  • WIRE Wire – Display bones as thin wires, showing subdivision and B-Splines.

Type:

Literal[‘OCTAHEDRAL’, ‘STICK’, ‘BBONE’, ‘ENVELOPE’, ‘WIRE’]

edit_bones

(default None, readonly)

Type:

ArmatureEditBones[EditBone]

is_editmode

True when used in editmode (default False, readonly)

Type:

bool

pose_position

Show armature in binding pose or final posed state (default 'POSE')

  • POSE Pose Position – Show armature in posed state.

  • REST Rest Position – Show Armature in binding pose state (no posing possible).

Type:

Literal[‘POSE’, ‘REST’]

relation_line_position

The start position of the relation lines from parent to child bones (default 'TAIL')

  • TAIL Tail – Draw the relationship line from the parent tail to the child head.

  • HEAD Head – Draw the relationship line from the parent head to the child head.

Type:

Literal[‘TAIL’, ‘HEAD’]

show_axes

Display bone axes (default False)

Type:

bool

show_bone_colors

Display bone colors (default True)

Type:

bool

show_bone_custom_shapes

Display bones with their custom shapes (default True)

Type:

bool

show_names

Display bone names (default False)

Type:

bool

use_mirror_x

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

Type:

bool

transform(matrix)

Transform armature bones by a matrix

Parameters:

matrix (mathutils.Matrix) – Matrix (multi-dimensional array of 4 * 4 items, in [-inf, inf])

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