Package bpy :: Module types :: Class Armature

[frames] | no frames]

Class Armature

The Armature Object

Armature datablock containing a hierarchy of bones, usually used for rigging characters.

References

Instance Methods

[hide private]

animation_data_clear()
Clear animation on this this ID. (Inherited from bpy.types.ID)

AnimData

animation_data_create()
Create animation data to this ID, note that not all ID types support this. (Inherited from bpy.types.ID)

copy()
Create a copy of this datablock (not supported for all datablocks). (Inherited from bpy.types.ID)

Instance Variables

[hide private]

AnimData (readonly)

animation_data
Animation data for this datablock.

boolean

auto_ik
Add temporaral IK constraints while grabbing bones in Pose Mode.

ArmatureBones Collection of Bone (readonly)

bones
Bones

boolean

deform_bbone_rest
Make B-Bones deform already in Rest Position

boolean

deform_envelope
Enable Bone Envelopes when defining deform

boolean

deform_quaternion
Enable deform rotation with Quaternions

boolean

deform_vertexgroups
Enable Vertex Groups when defining deform

boolean

delay_deform
Don't deform children when manipulating bones in Pose Mode

boolean

draw_axes
Draw bone axes.

boolean

draw_custom_bone_shapes
Draw bones with their custom shapes.

boolean

draw_group_colors
Draw bone group colors.

boolean

draw_names
Draw bone names.

enum

drawtype
Draw Type in...

ArmatureEditBones Collection of EditBone (readonly)

edit_bones
Edit Bones

boolean

fake_user
Saves this datablock even if it has no users (Inherited from bpy.types.ID)

int in [-inf, inf]

ghost_end_frame
End frame of range of Ghosts to display (not for 'Around Current Frame' Onion-skinning method).

boolean

ghost_only_selected
Draw Ghosts on Selected Bones Only

int in [1, 20]

ghost_size
Frame step for Ghosts (not for 'On Keyframes' Onion-skining method).

int in [-inf, inf]

ghost_start_frame
Starting frame of range of Ghosts to display (not for 'Around Current Frame' Onion-skinning method).

int in [0, 30]

ghost_step
Number of frame steps on either side of current frame to show as ghosts (only for 'Around Current Frame' Onion-skining method).

enum

ghost_type
Method of Onion-skinning for active Action in...

boolean array of 32 items

layer
Armature layer visibility.

boolean array of 32 items

layer_protection
Protected layers in Proxy Instances are restored to Proxy settings on file reload and undo.

Library (readonly)

library
Library file the datablock is linked from. (Inherited from bpy.types.ID)

string

name
Unique datablock ID name. (Inherited from bpy.types.ID)

int in [1, 150000]

path_after_current
Number of frames after current frame to show on Bone Paths (only for 'Around Current' option).

int in [1, 150000]

path_before_current
Number of frames before current frame to show on Bone Paths (only for 'Around Current' option).

int in [-inf, inf]

path_end_frame
End frame of range of frames to use for Bone Path calculations.

int in [1, 100]

path_size
Number of frames between 'dots' on Bone Paths (when drawing).

int in [-inf, inf]

path_start_frame
Starting frame of range of frames to use for Bone Path calculations.

boolean

paths_highlight_keyframes
When drawing Armature in Pose Mode, emphasize position of keyframes on Bone Paths

enum

paths_location
When calculating Bone Paths, use Head or Tips in...

boolean

paths_show_frame_numbers
When drawing Armature in Pose Mode, show frame numbers on Bone Paths

boolean

paths_show_keyframe_numbers
When drawing Armature in Pose Mode, show frame numbers of Keyframes on Bone Paths

enum

paths_type
Type of range to show for Bone Paths in...

enum

pose_position
Show armature in binding pose or final posed state.

boolean

tag
Tools can use this to tag data, (initial state is undefined). (Inherited from bpy.types.ID)

int (readonly) in [0, 32767]

users
Number of times this datablock is referenced. (Inherited from bpy.types.ID)

boolean

x_axis_mirror
Apply changes to matching bone on opposite side of X-Axis.

Instance Variable Details

[hide private]

drawtype

Draw Type in...

OCTAHEDRAL
STICK
BBONE
ENVELOPE

Type:: enum

ghost_type

Method of Onion-skinning for active Action in...

CURRENT_FRAME
RANGE
KEYS

Type:: enum

paths_location

When calculating Bone Paths, use Head or Tips in...

HEADS
TAILS

Type:: enum

paths_type

Type of range to show for Bone Paths in...

CURRENT_FRAME
RANGE

Type:: enum

pose_position

Show armature in binding pose or final posed state. in...

POSE_POSITION
REST_POSITION

Type:: enum