#include <DNA_armature_types.h>

Public Attributes
struct Bone *	next
struct Bone *	prev
IDProperty *	prop
IDProperty *	system_properties
void *	_pad0
struct Bone *	parent
ListBase	childbase
char	name [64]
float	roll
float	head [3]
float	tail [3]
float	bone_mat [3][3]
int	flag
int8_t	drawtype
char	_pad1 [3]
BoneColor	color
char	inherit_scale_mode
char	_pad [3]
float	arm_head [3]
float	arm_tail [3]
float	arm_mat [4][4]
float	arm_roll
float	dist
float	weight
float	xwidth
float	length
float	zwidth
float	rad_head
float	rad_tail
float	roll1
float	roll2
float	curve_in_x
float	curve_in_z
float	curve_out_x
float	curve_out_z
float	ease1
float	ease2
float scale_in_x	DNA_DEPRECATED
float scale_in_x scale_in_z	DNA_DEPRECATED
float scale_out_x	DNA_DEPRECATED
float scale_out_x scale_out_z	DNA_DEPRECATED
float	scale_in [3]
float	scale_out [3]
float	size [3]
int	layer
short	segments
char	bbone_mapping_mode
char	_pad2 [7]
char	bbone_prev_type
char	bbone_next_type
int	bbone_flag
short	bbone_prev_flag
short	bbone_next_flag
struct Bone *	bbone_prev
struct Bone *	bbone_next
Bone_Runtime	runtime

Detailed Description

Definition at line 67 of file DNA_armature_types.h.

Member Data Documentation

◆ _pad

char Bone::_pad[3]

Definition at line 100 of file DNA_armature_types.h.

◆ _pad0

void* Bone::_pad0

Definition at line 74 of file DNA_armature_types.h.

◆ _pad1

char Bone::_pad1[3]

Definition at line 96 of file DNA_armature_types.h.

◆ _pad2

char Bone::_pad2[7]

Definition at line 146 of file DNA_armature_types.h.

◆ arm_head

float Bone::arm_head[3]

Head position in armature space. So should be the same as head in edit mode.

Definition at line 103 of file DNA_armature_types.h.

Referenced by add_verts_to_dgroups(), blender::bke::armature_vert_task_with_mixer(), armdef_accumulate_bone(), armdef_evaluate(), BKE_pchan_bbone_spline_params_get(), BKE_pose_eval_bone(), BKE_pose_where_is(), copy_bone_transform(), blender::bke::dist_bone_deform(), do_version_bone_head_tail_237(), and ED_armature_from_edit().

◆ arm_mat

float Bone::arm_mat[4][4]

◆ arm_roll

float Bone::arm_roll

Roll in Armature Space (rest pose).

Definition at line 109 of file DNA_armature_types.h.

Referenced by copy_bone_transform(), do_version_bone_roll_256(), and ED_armature_from_edit().

◆ arm_tail

float Bone::arm_tail[3]

Tail position in armature space. So should be the same as tail in edit mode.

Definition at line 105 of file DNA_armature_types.h.

Referenced by add_verts_to_dgroups(), armature_transform_recurse(), blender::bke::armature_vert_task_with_mixer(), armdef_accumulate_bone(), BKE_pchan_bbone_spline_params_get(), BKE_pose_eval_bone(), BKE_pose_where_is(), convert_tree(), copy_bone_transform(), blender::bke::dist_bone_deform(), do_version_bone_head_tail_237(), and ED_armature_from_edit().

◆ bbone_flag

int Bone::bbone_flag

B-Bone flags.

Definition at line 152 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ bbone_mapping_mode

char Bone::bbone_mapping_mode

Vertex to segment mapping mode.

Definition at line 145 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_segments_cache_compute(), and ED_armature_from_edit().

◆ bbone_next

struct Bone* Bone::bbone_next

Definition at line 157 of file DNA_armature_types.h.

Referenced by BKE_pchan_rebuild_bbone_handles(), copy_bonechildren_custom_handles(), direct_link_bones(), ED_armature_from_edit(), and make_boneList().

◆ bbone_next_flag

short Bone::bbone_next_flag

Definition at line 154 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ bbone_next_type

char Bone::bbone_next_type

Definition at line 150 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_handles_get(), BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ bbone_prev

struct Bone* Bone::bbone_prev

Next/prev bones to use as handle references when calculating bbones (optional).

Definition at line 156 of file DNA_armature_types.h.

Referenced by BKE_pchan_rebuild_bbone_handles(), copy_bonechildren_custom_handles(), direct_link_bones(), ED_armature_from_edit(), and make_boneList().

◆ bbone_prev_flag

short Bone::bbone_prev_flag

Definition at line 153 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ bbone_prev_type

char Bone::bbone_prev_type

Type of next/prev bone handles.

Definition at line 149 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_handles_get(), BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ bone_mat

float Bone::bone_mat[3][3]

Bone matrix in Bone Space (see top of this file).

bone.matrix in RNA. Computed in BKE_armature_where_is_bone().

Definition at line 92 of file DNA_armature_types.h.

Referenced by blender::ed::transform::add_pose_transdata(), BKE_armature_where_is_bone(), BKE_bone_offset_matrix_get(), convert_pose(), convert_tree(), copy_bone_transform(), draw_bone_degrees_of_freedom(), execute_posetree(), and blender::ed::transform::gimbal_axis_pose().

◆ childbase

ListBase Bone::childbase

Children.

Definition at line 78 of file DNA_armature_types.h.

Referenced by applyarmature_process_selected_recursive(), armature_foreach_id_bone(), BKE_armature_where_is_bone(), bone_looper(), copy_bonechildren(), copy_bonechildren_custom_handles(), direct_link_bones(), blender::ed::outliner::do_outliner_bone_select_recursive(), do_version_bone_head_tail_237(), do_version_bone_roll_256(), do_versions_idproperty_bones_recursive(), ED_armature_from_edit(), blender::ed::greasepencil::foreach_bone_in_armature_ex(), blender::ed::outliner::outliner_add_bone(), blender::animrig::pose_bone_descendent_iterator(), pose_channel_in_IK_chain(), blender::animrig::pose_depth_iterator_recursive(), blender::ed::transform::pose_grab_with_ik_children(), rebuild_pose_bone(), blender::ed::outliner::restrictbutton_recursive_bone(), version_system_idprops_children_bones_generate(), version_system_idprops_generate(), blender::io::usd::visit_bones(), and write_bone().

◆ color

BoneColor Bone::color

Definition at line 97 of file DNA_armature_types.h.

Referenced by blender::animrig::ANIM_bonecolor_posebone_get(), and ED_armature_from_edit().

◆ curve_in_x

float Bone::curve_in_x

Definition at line 130 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ curve_in_z

float Bone::curve_in_z

Definition at line 130 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ curve_out_x

float Bone::curve_out_x

Definition at line 131 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ curve_out_z

float Bone::curve_out_z

Definition at line 131 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ dist

float Bone::dist

Envelope distance, added to rad_head / rad_tail.

Definition at line 112 of file DNA_armature_types.h.

Referenced by blender::ed::greasepencil::add_armature_envelope_weights(), blender::ed::transform::add_pose_transdata(), blender::bke::armature_vert_task_with_mixer(), armdef_accumulate_bone(), bone_draw_envelope(), blender::bke::dist_bone_deform(), ED_armature_from_edit(), and envelope_bone_weighting().

◆ DNA_DEPRECATED [1/4]

float scale_out_x Bone::DNA_DEPRECATED

Definition at line 135 of file DNA_armature_types.h.

◆ DNA_DEPRECATED [2/4]

float scale_out_x scale_out_z Bone::DNA_DEPRECATED

Definition at line 135 of file DNA_armature_types.h.

◆ DNA_DEPRECATED [3/4]

float scale_in_x Bone::DNA_DEPRECATED

Definition at line 134 of file DNA_armature_types.h.

◆ DNA_DEPRECATED [4/4]

float scale_in_x scale_in_z Bone::DNA_DEPRECATED

Definition at line 134 of file DNA_armature_types.h.

◆ drawtype

int8_t Bone::drawtype

Definition at line 95 of file DNA_armature_types.h.

Referenced by blender::draw::overlay::Armatures::draw_armature_pose(), and ED_armature_from_edit().

◆ ease1

float Bone::ease1

Length of bezier handles.

Definition at line 133 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), ED_armature_from_edit(), gizmo_bbone_offset_get(), and gizmo_bbone_offset_set().

◆ ease2

float Bone::ease2

Definition at line 133 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), ED_armature_from_edit(), gizmo_bbone_offset_get(), and gizmo_bbone_offset_set().

◆ flag

int Bone::flag

Definition at line 94 of file DNA_armature_types.h.

Referenced by blender::ed::greasepencil::add_armature_vertex_groups(), blender::ed::transform::add_pose_transdata(), add_verts_to_dgroups(), applyarmature_process_selected_recursive(), blender::bke::armature_vert_task_with_mixer(), armdef_accumulate_bone(), BKE_armature_bone_flag_test_recursive(), BKE_bone_parent_transform_calc_from_pchan(), BKE_constraint_apply_for_pose(), BKE_pchan_bbone_handles_get(), BKE_pchan_to_mat4(), BKE_pose_bone_done(), BKE_pose_update_constraint_flags(), BKE_pose_where_is_bone(), bone_collection_select(), blender::ed::outliner::bone_fn(), blender::animrig::bone_is_selectable(), blender::animrig::bone_is_selectable(), blender::animrig::bone_is_selected(), blender::animrig::bone_is_visible(), bone_mouse_select_menu(), bone_skinnable_cb(), convert_tree(), blender::ed::transform::createTransPose(), dgroup_skinnable_cb(), direct_link_bones(), do_pose_tag_select_op_exec(), blender::draw::overlay::Armatures::draw_armature_pose(), ED_armature_from_edit(), ed_armature_pick_bone_from_selectbuffer_impl(), ED_armature_pose_select_pick_bone(), blender::bke::get_armature_deform_params(), blender::ed::greasepencil::get_bone_mat(), blender::ed::greasepencil::get_skinnable_bones_and_deform_group_names(), blender::ed::transform::gimbal_axis_pose(), blender::io::usd::init_deform_bones_map(), ob_parbone(), blender::ed::outliner::outliner_draw_restrictbuts(), blender::ed::object::parent_set_with_depsgraph(), blender::ed::transform::pose_channel_children_clear_transflag(), pose_do_bone_select(), blender::ed::transform::pose_grab_with_ik(), blender::ed::transform::pose_grab_with_ik_add(), pose_select_connected_invoke(), pose_select_constraint_target_exec(), pose_select_linked_exec(), pose_select_parent_exec(), pose_select_same_collection(), pose_select_same_color(), blender::ed::transform::pose_transform_mirror_update(), rebuild_pose_bone(), blender::ed::outliner::restrictbutton_bone_select_fn(), selectconnected_posebonechildren(), blender::ed::outliner::tree_element_bone_activate(), blender::ed::outliner::tree_element_bone_state_get(), blender::bke::tests::ArmatureDeformTestBase::update_pose_matrices(), v3d_transform_butsR(), vgroup_add_unique_bone_cb(), and blender::animrig::visualkey_get_values().

◆ head

float Bone::head[3]

Head position in Bone Space (see top of this file).

Definition at line 85 of file DNA_armature_types.h.

Referenced by BKE_armature_where_is_bone(), BKE_bone_offset_matrix_get(), copy_bone_transform(), and blender::bke::tests::ArmatureDeformTestBase::create_test_armature_object().

◆ inherit_scale_mode

char Bone::inherit_scale_mode

Definition at line 99 of file DNA_armature_types.h.

Referenced by applyarmature_process_selected_recursive(), BKE_bone_parent_transform_calc_from_pchan(), and ED_armature_from_edit().

◆ layer

int Bone::layer

Layers that bone appears on.

Definition at line 141 of file DNA_armature_types.h.

Referenced by ED_armature_from_edit().

◆ length

◆ name

char Bone::name[64]

Name of the bone - must be unique within the armature.

Definition at line 80 of file DNA_armature_types.h.

Referenced by blender::ed::greasepencil::add_armature_vertex_groups(), blender::ed::object::add_hook_object(), add_verts_to_dgroups(), applyarmature_process_selected_recursive(), bone_collection_select(), bone_skinnable_cb(), blender::deg::DepsgraphRelationBuilder::build_driver_data(), blender::io::usd::build_usd_joint_path(), buttons_context_path_pose_bone(), convert_tree(), copy_bonechildren_custom_handles(), blender::bke::tests::ArmatureDeformTestBase::create_test_armature_object(), dgroup_skinnable_cb(), draw_selected_name(), ED_armature_bone_rename(), ed_armature_bone_unique_name(), ED_armature_from_edit(), ED_armature_pose_select_pick_bone(), ED_wpaint_ensure_data(), blender::ed::sculpt_paint::greasepencil::WeightPaintOperation::ensure_active_vertex_group_in_object(), blender::io::usd::get_armature_bone_names(), blender::ed::greasepencil::get_skinnable_bones_and_deform_group_names(), blender::io::usd::init_deform_bones_map(), blender::ed::outliner::namebutton_fn(), pose_channel_find_bone(), blender::ed::transform::pose_grab_with_ik_children(), rebuild_pose_bone(), blender::ui::sample_data_from_outliner(), blender::animrig::tests::KeyframingTest::SetUp(), blender::animrig::tests::PoseTest::SetUp(), blender::ed::animation::tests::TEST_F(), vgroup_add_unique_bone_cb(), and blender::ed::object::vgroup_sync_from_pose().

◆ next

struct Bone* Bone::next

Next/previous elements within this list.

Definition at line 69 of file DNA_armature_types.h.

Referenced by armature_copy_data(), BKE_armature_copy_bone_transforms(), BKE_armature_where_is_bone(), bone_looper(), copy_bonechildren(), copy_bonechildren_custom_handles(), blender::ed::greasepencil::foreach_bone_in_armature_ex(), blender::ed::transform::pose_grab_with_ik(), rebuild_pose_bone(), and blender::ed::outliner::tree_element_bone_activate().

◆ parent

struct Bone* Bone::parent

Parent (IK parent if appropriate flag is set).

Definition at line 76 of file DNA_armature_types.h.

Referenced by applyarmature_process_selected_recursive(), armature_copy_data(), BKE_armature_bone_flag_test_recursive(), BKE_bone_offset_matrix_get(), BKE_bone_parent_transform_calc_from_pchan(), blender::io::usd::build_usd_joint_path(), copy_bonechildren(), direct_link_bones(), ED_armature_from_edit(), blender::io::usd::init_deform_bones_map(), v3d_transform_butsR(), and blender::animrig::visualkey_get_values().

◆ prev

struct Bone * Bone::prev

Definition at line 69 of file DNA_armature_types.h.

◆ prop

IDProperty* Bone::prop

User-Defined Properties on this Bone.

Definition at line 71 of file DNA_armature_types.h.

Referenced by armature_foreach_id_bone(), copy_bonechildren(), direct_link_bones(), do_versions_idproperty_bones_recursive(), ED_armature_from_edit(), and write_bone().

◆ rad_head

float Bone::rad_head

Radius for head/tail sphere, defining deform as well, parent->rad_tip overrides rad_head.

Definition at line 126 of file DNA_armature_types.h.

Referenced by blender::ed::greasepencil::add_armature_envelope_weights(), blender::bke::armature_vert_task_with_mixer(), armdef_accumulate_bone(), bone_draw_envelope(), blender::bke::tests::ArmatureDeformTestBase::create_test_armature_object(), blender::bke::dist_bone_deform(), ED_armature_from_edit(), and envelope_bone_weighting().

◆ rad_tail

float Bone::rad_tail

Definition at line 126 of file DNA_armature_types.h.

Referenced by blender::ed::greasepencil::add_armature_envelope_weights(), blender::bke::armature_vert_task_with_mixer(), armdef_accumulate_bone(), bone_draw_envelope(), blender::bke::tests::ArmatureDeformTestBase::create_test_armature_object(), blender::bke::dist_bone_deform(), ED_armature_from_edit(), and envelope_bone_weighting().

◆ roll

float Bone::roll

Roll is input for edit-mode, length calculated.

Definition at line 83 of file DNA_armature_types.h.

Referenced by armature_transform_recurse(), BKE_armature_where_is_bone(), copy_bone_transform(), and ED_armature_from_edit().

◆ roll1

float Bone::roll1

Curved bones settings - these define the "rest-pose" for a curved bone.

Definition at line 129 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ roll2

float Bone::roll2

Definition at line 129 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ runtime

Bone_Runtime Bone::runtime

Definition at line 160 of file DNA_armature_types.h.

Referenced by add_reference(), ANIM_armature_bonecoll_contains_active_bone(), ANIM_armature_bonecoll_show_from_bone(), ANIM_armature_bonecoll_unassign(), ANIM_armature_bonecoll_unassign_all(), ANIM_bone_in_visible_collection(), copy_bonechildren(), copy_bonecollection_membership(), direct_link_bones(), ED_armature_from_edit(), pose_select_same_collection(), and write_bone().

◆ scale_in

float Bone::scale_in[3]

Definition at line 136 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ scale_out

float Bone::scale_out[3]

Definition at line 136 of file DNA_armature_types.h.

Referenced by BKE_pchan_bbone_spline_params_get(), and ED_armature_from_edit().

◆ segments

short Bone::segments

◆ size

float Bone::size[3]

Patch for upward compatibility, UNUSED!

Definition at line 139 of file DNA_armature_types.h.

Referenced by write_bone().

◆ system_properties

IDProperty* Bone::system_properties

System-Defined Properties storage.

Definition at line 73 of file DNA_armature_types.h.

Referenced by armature_foreach_id_bone(), copy_bonechildren(), direct_link_bones(), ED_armature_from_edit(), and write_bone().

◆ tail

float Bone::tail[3]

Tail position in Bone Space (see top of this file).

Definition at line 87 of file DNA_armature_types.h.

Referenced by BKE_armature_where_is_bone(), copy_bone_transform(), and blender::bke::tests::ArmatureDeformTestBase::create_test_armature_object().

◆ weight

float Bone::weight

Weight: for non-deformgroup deforms.

Definition at line 114 of file DNA_armature_types.h.

Referenced by blender::bke::tests::ArmatureDeformTestBase::create_test_armature_object(), blender::bke::dist_bone_deform(), and ED_armature_from_edit().

◆ xwidth

float Bone::xwidth

The width for block bones. The final X/Z bone widths are double these values.

Note: keep in this order for transform code which stores a pointer to xwidth, accessing length and zwidth as offsets.

Definition at line 121 of file DNA_armature_types.h.

Referenced by blender::ed::transform::add_pose_transdata(), BKE_armature_where_is_bone(), draw_bone_update_disp_matrix_bbone(), ED_armature_from_edit(), and blender::ed::transform::pose_transform_mirror_update().

◆ zwidth

float Bone::zwidth

Definition at line 121 of file DNA_armature_types.h.

Referenced by BKE_armature_where_is_bone(), draw_bone_update_disp_matrix_bbone(), ED_armature_from_edit(), and blender::ed::transform::pose_transform_mirror_update().

The documentation for this struct was generated from the following file:

DNA_armature_types.h

Public Attributes

Detailed Description

Member Data Documentation

◆ _pad

◆ _pad0

◆ _pad1

◆ _pad2

◆ arm_head

◆ arm_mat

◆ arm_roll

◆ arm_tail

◆ bbone_flag

◆ bbone_mapping_mode

◆ bbone_next

◆ bbone_next_flag

◆ bbone_next_type

◆ bbone_prev

◆ bbone_prev_flag

◆ bbone_prev_type

◆ bone_mat

◆ childbase

◆ color

◆ curve_in_x

◆ curve_in_z

◆ curve_out_x

◆ curve_out_z

◆ dist

◆ DNA_DEPRECATED [1/4]

◆ DNA_DEPRECATED [2/4]

◆ DNA_DEPRECATED [3/4]

◆ DNA_DEPRECATED [4/4]

◆ drawtype

◆ ease1

◆ ease2

◆ flag

◆ head

◆ inherit_scale_mode

◆ layer

◆ length

◆ name

◆ next

◆ parent

◆ prev

◆ prop

◆ rad_head

◆ rad_tail

◆ roll

◆ roll1

◆ roll2

◆ runtime

◆ scale_in

◆ scale_out

◆ segments

◆ size

◆ system_properties

◆ tail

◆ weight

◆ xwidth

◆ zwidth