Blender V5.3
blender::bArmature Struct Reference

#include <DNA_armature_types.h>

Public Attributes

ID id
struct AnimData * adt = nullptr
ListBaseT< Bone > bonebase = {nullptr, nullptr}
struct GHash * bonehash = nullptr
void * _pad1 = nullptr
ListBaseT< EditBone > * edbo = nullptr
Bone * act_bone = nullptr
struct EditBone * act_edbone = nullptr
char needs_flush_to_id = 0
char _pad0 [3] = {}
eArmature_Flag flag = ARM_COL_CUSTOM
eArmature_Drawtype drawtype = ARM_DRAW_TYPE_OCTA
eArmature_DeformFlag deformflag = ARM_DEF_VGROUP | ARM_DEF_ENVELOPE
short pathflag = 0
ListBaseT< BoneCollection > collections_legacy = {nullptr, nullptr}
struct BoneCollection ** collection_array
int collection_array_num = 0
int collection_root_count = 0
char active_collection_name [64] = ""
DNA_DEPRECATED unsigned int layer_used = 0
DNA_DEPRECATED unsigned int layer = 1
DNA_DEPRECATED unsigned int layer_protected = 0
float axes_position = 0
bke::bArmature_Runtime * runtime = nullptr

Detailed Description

Definition at line 403 of file DNA_armature_types.h.

Member Data Documentation

◆ _pad0

char blender::bArmature::_pad0[3] = {}

Definition at line 436 of file DNA_armature_types.h.

◆ _pad1

void* blender::bArmature::_pad1 = nullptr

Definition at line 418 of file DNA_armature_types.h.

◆ act_bone

◆ act_edbone

◆ active_collection_name

char blender::bArmature::active_collection_name[64] = ""

Do not directly assign, use ANIM_armature_bonecoll_active_set instead. This is stored as a string to make it possible for the library overrides system to understand when it actually changed (compared to a BoneCollection*, which would change on every load).

Definition at line 466 of file DNA_armature_types.h.

Referenced by blender::ANIM_armature_bonecoll_active_index_set(), blender::ANIM_armature_bonecoll_active_runtime_refresh(), blender::ANIM_armature_bonecoll_active_set(), blender::ANIM_armature_bonecoll_name_set(), blender::armature_bonecoll_active_clear(), and blender::undoarm_from_editarm().

◆ adt

◆ axes_position

float blender::bArmature::axes_position = 0

Relative position of the axes on the bone, from head (0.0f) to tail (1.0f).

Definition at line 475 of file DNA_armature_types.h.

Referenced by blender::blo_do_versions_290(), and blender::draw_axes().

◆ bonebase

ListBaseT<Bone> blender::bArmature::bonebase = {nullptr, nullptr}

Root bones. Children are listed in Bone::childbase.

Definition at line 414 of file DNA_armature_types.h.

Referenced by blender::add_verts_to_dgroups(), blender::ANIM_armature_bonecoll_reconstruct(), blender::ANIM_armature_runtime_free(), blender::apply_armature_pose2bones_exec(), blender::armature_blend_read_data(), blender::armature_blend_write(), blender::armature_bone_from_name_map(), blender::ed::object::armature_coords_and_quats_apply_with_mat4(), blender::ed::object::armature_coords_and_quats_get(), blender::armature_copy_data(), blender::armature_foreach_id(), blender::armature_free_data(), blender::BKE_armature_copy_bone_transforms(), blender::BKE_armature_find_bone_name(), blender::bke::BKE_armature_find_selected_bones(), blender::BKE_armature_foreach_bone(), blender::BKE_armature_transform(), blender::BKE_armature_where_is(), blender::blo_do_versions_250(), blender::blo_do_versions_270(), blender::blo_do_versions_280(), blender::blo_do_versions_300(), blender::blo_do_versions_401(), blender::blo_do_versions_405(), blender::blo_do_versions_pre250(), blender::deg::DepsgraphNodeBuilder::build_armature(), blender::deg::DepsgraphRelationBuilder::build_armature(), blender::bke::tests::BoneIndexTestBase::create_armature(), blender::bke::tests::ArmatureDeformTestBase::create_test_armature_object(), blender::ed::object::data_xform_create_ex(), blender::do_versions_idproperty_ui_data(), blender::ED_armature_from_edit(), blender::ED_armature_to_edit(), blender::ED_object_vgroup_calc_from_armature(), blender::ed::greasepencil::foreach_bone_in_armature(), blender::rebuild_bone_array(), blender::animrig::tests::ArmatureBoneCollections::SetUp(), blender::animrig::tests::KeyframingTest::SetUp(), blender::animrig::tests::PoseTest::SetUp(), blender::bke::tests::BKE_armature_find_selected_bones_test::SetUp(), blender::ed::tests::TransformableTest::SetUp(), blender::editor::animation::tests::KeylistSummaryTest::SetUp(), blender::animrig::tests::ArmatureBoneCollections::TearDown(), blender::ed::animation::tests::TEST_F(), blender::ed::outliner::tree_element_bone_activate(), blender::version_bonelayers_to_bonecollections(), blender::version_set_default_bone_drawtype(), blender::version_system_idprops_children_bones_generate(), blender::version_system_idprops_generate(), blender::ed::object::vgroup_sort_bone_hierarchy(), and blender::io::usd::visit_bones().

◆ bonehash

◆ collection_array

struct BoneCollection** blender::bArmature::collection_array

◆ collection_array_num

◆ collection_root_count

◆ collections_legacy

ListBaseT<BoneCollection> blender::bArmature::collections_legacy = {nullptr, nullptr}

This is used only for reading/writing BoneCollections in blend files, for forwards/backwards compatibility with Blender 4.0. It should always be empty at runtime. Use collection_array for everything other than file reading/writing. TODO: remove this in Blender 5.0, and instead write the contents of collection_array to blend files directly.

Definition at line 450 of file DNA_armature_types.h.

Referenced by blender::armature_blend_write(), and blender::read_bone_collections().

◆ deformflag

eArmature_DeformFlag blender::bArmature::deformflag = ARM_DEF_VGROUP | ARM_DEF_ENVELOPE

◆ drawtype

◆ edbo

ListBaseT<EditBone>* blender::bArmature::edbo = nullptr

EditBone list (use an allocated pointer so the state can be checked).

Definition at line 421 of file DNA_armature_types.h.

Referenced by blender::ANIM_armature_bonecoll_contains_active_bone(), blender::apply_armature_pose2bones_exec(), blender::applyarmature_adjust_edit_position(), blender::applyarmature_process_selected_recursive(), blender::armature_align_bones_exec(), blender::armature_autoside_names_exec(), blender::armature_blend_read_data(), blender::armature_blend_write(), blender::armature_bone_select_poll(), blender::armature_calc_roll_exec(), blender::armature_circle_select(), blender::armature_clear_swap_done_flags(), blender::armature_click_extrude_exec(), blender::armature_copy_data(), blender::armature_delete_ebone_cb(), blender::armature_delete_selected_exec(), blender::armature_dissolve_ebone_cb(), blender::armature_dissolve_selected_exec(), blender::armature_duplicate_selected(), blender::armature_extrude_exec(), blender::armature_flip_names_exec(), blender::armature_foreach_id(), blender::armature_foreachScreenBone(), blender::armature_free_data(), blender::armature_hide_exec(), blender::armature_parent_clear_exec(), blender::armature_parent_clear_invoke(), blender::armature_parent_set_exec(), blender::armature_parent_set_invoke(), blender::armature_reveal_exec(), blender::armature_roll_clear_exec(), blender::armature_select_hierarchy_exec(), blender::armature_select_linked_exec(), blender::armature_select_linked_impl(), blender::armature_select_linked_pick_invoke(), blender::armature_select_mirror_exec(), blender::armature_select_mirrored_ex(), blender::armature_select_more_less(), blender::armature_shortest_path_pick_invoke(), blender::armature_split_exec(), blender::armature_switch_direction_exec(), blender::armature_symmetrize_exec(), blender::armature_tag_select_mirrored(), blender::armature_tag_unselect(), blender::armature_undosys_step_decode(), blender::BKE_pose_bone_done(), blender::BKE_pose_constraints_evaluate(), blender::BKE_pose_eval_bbone_segments(), blender::BKE_pose_eval_bone(), blender::BKE_pose_iktree_evaluate(), blender::BKE_pose_splineik_evaluate(), blender::BKE_pose_where_is(), blender::blo_do_versions_401(), blender::blo_do_versions_405(), blender::bone_collection_assign_editbones(), blender::bone_collection_assign_named_mode_specific(), blender::bone_collection_select(), blender::bone_free(), blender::bone_mouse_select_menu(), blender::animrig::internal::bonecoll_unassign_and_free(), blender::buttons_context_path_bone(), blender::buttons_context_path_pose_bone(), blender::ui::context_copy_to_selected_list(), blender::ed::transform::createTransArmatureVerts(), blender::ed::object::data_xform_create_ex(), blender::do_armature_box_select(), blender::do_lasso_select_armature(), blender::draw::overlay::Armatures::draw_armature_edit(), blender::draw_selected_name(), blender::ED_armature_base_and_ebone_from_select_buffer(), blender::ED_armature_bone_rename(), blender::ED_armature_ebone_add(), blender::ED_armature_ebone_remove_ex(), blender::ED_armature_ebone_transform_mirror_update(), blender::ED_armature_edit_deselect_all(), blender::ED_armature_edit_deselect_all_visible(), blender::ED_armature_edit_free(), blender::ED_armature_edit_select_op_from_tagged(), blender::ED_armature_edit_select_pick_bone(), blender::ED_armature_edit_transform(), blender::ED_armature_edit_transform_mirror_update(), blender::ED_armature_from_edit(), blender::ED_armature_join_objects_exec(), blender::ED_armature_object_and_ebone_from_select_buffer(), blender::ED_armature_origin_set(), blender::ED_armature_to_edit(), blender::ED_armature_transform(), blender::ED_transverts_create_from_obedit(), blender::ED_transverts_update_obedit(), blender::edbo_compute_bbone_child(), blender::ed::object::edit_armature_coords_and_quats_apply_with_mat4(), blender::ed::object::edit_armature_coords_and_quats_get(), blender::editarm_object_from_context(), blender::ed::object::editmode_load_free_ex(), blender::ed::outliner::TreeElementPoseBase::expand(), blender::get_nearest_editbonepoint(), blender::get_symmetrized_bone(), blender::ed::transform::getTransformOrientation_ex(), blender::ed::transform::gizmo_3d_foreach_selected(), blender::ed::object::jump_to_bone(), blender::mirror_bone_collection_assignments(), blender::ed::object::modifier_skin_armature_create(), blender::ed::outliner::namebutton_fn(), blender::pose_channel_flush_to_orig_if_needed(), blender::ed::transform::recalcData_edit_armature(), blender::ed::transform::restoreBones(), blender::ed::outliner::restrictbutton_recursive_ebone(), blender::screen_ctx_active_bone(), blender::screen_ctx_selected_bones_(), blender::screen_ctx_visible_or_editable_bones_(), blender::select_similar_bone_collection(), blender::select_similar_bone_color(), blender::select_similar_children(), blender::select_similar_children_immediate(), blender::select_similar_data_pchan(), blender::select_similar_direction(), blender::select_similar_length(), blender::select_similar_prefix(), blender::select_similar_siblings(), blender::select_similar_suffix(), blender::separate_armature_bones(), blender::separate_armature_exec(), blender::ed::transform::snapArmature(), blender::stats_object_edit(), blender::undoarm_from_editarm(), blender::undoarm_to_editarm(), blender::update_duplicate_subtarget(), blender::bke::verify_armature_deform_valid(), blender::version_bonelayers_to_bonecollections(), blender::version_set_default_bone_drawtype(), and blender::wm_context_member_from_ptr().

◆ flag

eArmature_Flag blender::bArmature::flag = ARM_COL_CUSTOM

Definition at line 438 of file DNA_armature_types.h.

Referenced by blender::acf_dsarm_setting_ptr(), blender::ANIM_armature_bonecoll_is_visible_effectively(), blender::ANIM_armature_bonecoll_solo_set(), blender::ANIM_armature_refresh_solo_active(), blender::any_bone_collection_visible(), blender::armature_align_bones_exec(), blender::armature_autoside_names_exec(), blender::armature_bone_primitive_add_exec(), blender::armature_calc_roll_exec(), blender::armature_click_extrude_exec(), blender::armature_dissolve_selected_exec(), blender::armature_duplicate_selected(), blender::armature_extrude_exec(), blender::armature_flip_names_exec(), blender::armature_parent_set_exec(), blender::armature_roll_clear_exec(), blender::armature_select_mirrored_ex(), blender::armature_tag_select_mirrored(), blender::BKE_pchan_minmax(), blender::BKE_pose_constraints_evaluate(), blender::BKE_pose_eval_bone(), blender::BKE_pose_eval_init_ik(), blender::BKE_pose_iktree_evaluate(), blender::BKE_pose_splineik_evaluate(), blender::BKE_pose_where_is(), blender::blo_do_versions_280(), blender::blo_do_versions_pre250(), blender::draw::overlay::Armatures::create_draw_context(), blender::ed::transform::createTransArmatureVerts(), blender::ed::transform::createTransPose(), blender::draw::overlay::Armatures::draw_armature_edit(), blender::draw::overlay::Armatures::draw_armature_pose(), blender::draw_axes(), blender::ED_armature_pose_select_pick_bone(), blender::ED_pose_bone_select_tag_update(), blender::ED_transverts_update_obedit(), blender::pose_de_select_all_exec(), blender::ed::transform::recalcData_edit_armature(), blender::ed::transform::recalcData_pose(), blender::ed::transform::restoreBones(), blender::screen_ctx_selected_bones_(), blender::screen_ctx_visible_or_editable_bones_(), blender::set_ctx_bcolor(), blender::transform_follows_custom_tx(), and blender::update_depsgraph().

◆ id

ID blender::bArmature::id

Definition at line 410 of file DNA_armature_types.h.

Referenced by blender::active_bone_collection_poll(), blender::add_or_move_to_collection_bcoll(), blender::add_or_move_to_collection_exec(), blender::ANIM_armature_bonecoll_insert_copy_after(), blender::ANIM_armature_bonecoll_is_editable(), blender::ANIM_armature_bonecoll_name_set(), blender::ANIM_armature_bonecoll_new(), blender::armature_align_bones_exec(), blender::armature_blend_write(), blender::armature_calc_roll_exec(), blender::armature_delete_selected_exec(), blender::armature_dissolve_selected_exec(), blender::armature_fill_bones_exec(), blender::armature_hide_exec(), blender::armature_reveal_exec(), blender::armature_roll_clear_exec(), blender::armature_select_linked_impl(), blender::armature_split_exec(), blender::armature_switch_direction_exec(), blender::armature_undosys_step_decode(), blender::BKE_object_modifier_update_subframe(), blender::BKE_pose_blend_read_after_liblink(), blender::BKE_pose_ensure(), blender::blo_do_versions_pre250(), blender::bone_collection_add_poll(), blender::bone_collection_assign_named_mode_specific(), blender::bone_collection_assign_pchans(), blender::bone_collection_assign_poll(), blender::bone_collection_create_and_assign_poll(), blender::bone_collection_remove_exec(), blender::bone_collection_select(), blender::animrig::internal::bonecolls_debug_list(), blender::deg::DepsgraphNodeBuilder::build_armature(), blender::deg::DepsgraphRelationBuilder::build_armature(), blender::deg::DepsgraphRelationBuilder::build_rig(), blender::buttons_context_path_bone(), blender::deg::DepsgraphBuilder::check_pchan_has_bbone(), blender::bke::tests::PoseBoneIndexTest::create_object(), blender::ed::object::data_xform_tag_update(), blender::do_pose_tag_select_op_prepare(), blender::do_versions_after_linking_402(), blender::do_versions_after_linking_500(), blender::ED_armature_bone_rename(), blender::ED_armature_edit_select_pick_bone(), blender::ED_armature_from_edit(), blender::ED_armature_join_objects_exec(), blender::ED_armature_pose_select_pick_bone(), blender::ED_operator_posemode_local(), blender::ED_pose_bone_select_tag_update(), blender::move_to_collection_poll(), blender::ed::outliner::namebutton_fn(), blender::ed::object::object_origin_set_exec(), blender::ui::bonecollections::BoneCollectionDropTarget::on_drop(), blender::ed::outliner::outliner_draw_restrictbuts(), blender::ed::outliner::outliner_select_sync_to_edit_bone(), blender::ed::outliner::outliner_select_sync_to_pose_bone(), blender::ed::outliner::outliner_set_properties_tab(), blender::ed::outliner::TreeElementBoneCollection::owner_id(), blender::ed::outliner::TreeElementBoneCollectionBase::owner_id(), blender::pose_de_select_all_exec(), blender::pose_hide_exec(), blender::pose_reveal_exec(), blender::pose_select_mirror_exec(), blender::read_bone_collections(), blender::ed::outliner::restrictbutton_bone_select_fn(), blender::ui::rnapointer_pchan_to_bone(), blender::ui::sample_data_from_3d_view(), blender::screen_ctx_active_bone(), blender::screen_ctx_selected_bones_(), blender::screen_ctx_visible_or_editable_bones_(), blender::animrig::tests::ArmatureBoneCollections::SetUp(), blender::animrig::tests::ArmatureBoneCollectionsLiboverrides::SetUp(), blender::animrig::tests::ArmatureBoneCollectionsTestList::SetUp(), blender::ed::transform::snapArmature(), blender::animrig::tests::ArmatureBoneCollections::TearDown(), blender::animrig::tests::ArmatureBoneCollectionsLiboverrides::TearDown(), blender::animrig::tests::ArmatureBoneCollectionsTestList::TearDown(), blender::ui::template_bone_collection_tree(), blender::animrig::tests::TEST_F(), blender::ed::outliner::tree_element_posechannel_activate(), blender::v3d_editarmature_buts(), blender::version_bonegroup_migrate_color(), blender::version_bonelayers_to_bonecollections(), and blender::WIDGETGROUP_armature_spline_poll().

◆ layer

DNA_DEPRECATED unsigned int blender::bArmature::layer = 1

For buttons to work, both variables in this order together.

Definition at line 471 of file DNA_armature_types.h.

Referenced by blender::blo_do_versions_pre250(), and blender::version_bonelayers_to_bonecollections().

◆ layer_protected

DNA_DEPRECATED unsigned int blender::bArmature::layer_protected = 0

Definition at line 472 of file DNA_armature_types.h.

◆ layer_used

DNA_DEPRECATED unsigned int blender::bArmature::layer_used = 0

For UI, to show which layers are there.

Definition at line 469 of file DNA_armature_types.h.

Referenced by blender::version_bonelayers_to_bonecollections().

◆ needs_flush_to_id

char blender::bArmature::needs_flush_to_id = 0

◆ pathflag

short blender::bArmature::pathflag = 0

Definition at line 442 of file DNA_armature_types.h.

Referenced by blender::blo_do_versions_250().

◆ runtime

bke::bArmature_Runtime* blender::bArmature::runtime = nullptr

Keep last, for consistency with the position of other DNA runtime structures.

Definition at line 478 of file DNA_armature_types.h.

Referenced by blender::active_bone_collection_poll(), blender::ANIM_armature_bonecoll_active_index_set(), blender::ANIM_armature_bonecoll_active_runtime_refresh(), blender::ANIM_armature_bonecoll_active_set(), blender::ANIM_armature_bonecoll_assign_active(), blender::ANIM_armature_bonecoll_name_set(), blender::ANIM_armature_bonecoll_new(), blender::ANIM_armature_bonecoll_remove_from_index(), blender::armature_blend_read_data(), blender::armature_blend_write(), blender::armature_bone_select_poll(), blender::armature_bonecoll_active_clear(), blender::animrig::armature_bonecoll_child_number_set(), blender::armature_copy_data(), blender::armature_free_data(), blender::armature_init_data(), blender::BKE_pose_ensure_bone_indices(), blender::bone_collection_add_exec(), blender::bone_collection_deselect_exec(), blender::bone_collection_move_exec(), blender::bone_collection_remove_exec(), blender::bone_collection_select_exec(), blender::bonecoll_insert_at_index(), blender::animrig::internal::bonecolls_rotate_block(), blender::ED_armature_ebone_add_primitive(), blender::ED_armature_from_edit(), blender::get_bonecoll_named_or_active(), blender::rebuild_bone_array(), blender::rebuild_pose_bone_indices(), blender::animrig::tests::ArmatureBoneCollections::SetUp(), blender::animrig::tests::ArmatureBoneCollectionsLiboverrides::SetUp(), blender::animrig::tests::ArmatureBoneCollectionsTestList::SetUp(), blender::bke::tests::TEST_F(), and blender::ed::outliner::tree_element_bone_collection_state_get().


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