Blender V5.3
ED_armature.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_compiler_attrs.hh"
12#include "BLI_span.hh"
13
14#include "DNA_armature_types.h"
15#include "DNA_listBase.h"
17
18namespace blender {
19
20struct Base;
21struct Bone;
22struct Depsgraph;
23struct EditBone;
24struct GPUSelectResult;
25struct Main;
26struct Mesh;
28struct Object;
29struct ReportList;
30struct Scene;
32struct UndoType;
33struct View3D;
34struct ViewLayer;
35struct bArmature;
36struct bContext;
37struct bPoseChannel;
38struct wmKeyConfig;
39struct wmOperator;
40
41#define BONESEL_ROOT (1u << 29)
42#define BONESEL_TIP (1u << 30)
43#define BONESEL_BONE (1u << 31)
44#define BONESEL_ANY (BONESEL_TIP | BONESEL_ROOT | BONESEL_BONE)
45
46#define EBONE_SELECTABLE(arm, ebone) \
47 (animrig::bone_is_visible(arm, ebone) && !((ebone)->flag & BONE_UNSELECTABLE))
48
49#define EBONE_EDITABLE(ebone) \
50 (CHECK_TYPE_INLINE(ebone, EditBone *), \
51 (((ebone)->flag & BONE_SELECTED) && !((ebone)->flag & BONE_EDITMODE_LOCKED)))
52
53/* Used in `armature_select.cc` and `pose_select.cc`. */
54
55#define BONE_SELECT_PARENT 0
56#define BONE_SELECT_CHILD 1
57
58/* `armature_add.cc` */
59
65EditBone *ED_armature_ebone_add(bArmature *arm, const char *name);
66EditBone *ED_armature_ebone_add_primitive(Object *obedit_arm, float length, bool view_aligned);
67
68void ED_armature_ebone_copy(EditBone *dest, const EditBone *source);
69
73bArmature *ED_armature_context(const bContext *C);
74
78float ED_armature_ebone_roll_to_vector(const EditBone *bone,
79 const float align_axis[3],
80 bool axis_only);
87 Main *bmain, Object *ob, const float cursor[3], int centermode, int around);
91void ED_armature_edit_transform(bArmature *arm, const float mat[4][4], bool do_props);
92void ED_armature_transform(bArmature *arm, const float mat[4][4], bool do_props);
93
94/* `armature_naming.cc` */
95
100void ED_armature_ebone_unique_name(ListBaseT<EditBone> *ebones, char *name, EditBone *bone);
101
107void ED_armature_bone_rename(Main *bmain,
108 bArmature *arm,
109 const char *oldnamep,
110 const char *newnamep);
121void ED_armature_bones_flip_names(Main *bmain,
122 bArmature *arm,
123 ListBaseT<LinkData> *bones_names,
124 bool do_strip_numbers);
125
126/* `armature_ops.cc` */
127
130void ED_keymap_armature(wmKeyConfig *keyconf);
131
132/* `armature_relations.cc` */
133
137wmOperatorStatus ED_armature_join_objects_exec(bContext *C, wmOperator *op);
138
139/* `armature_select.cc` */
140
144bool ED_armature_selectresult_is_bone(const GPUSelectResult &hit_result);
146 unsigned int select_id,
147 EditBone **r_ebone);
149 unsigned int select_id,
150 EditBone **r_ebone);
152 unsigned int select_id,
153 bPoseChannel **r_pchan);
158 unsigned int select_id,
159 Bone **r_bone);
169 Base *basact,
170 EditBone *ebone,
171 eBone_Flag selmask,
172 const SelectPick_Params &params);
176bool ED_armature_edit_select_pick(bContext *C, const int mval[2], const SelectPick_Params &params);
190
191/* `armature_skinning.cc` */
192
193#define ARM_GROUPS_NAME 1
194#define ARM_GROUPS_ENVELOPE 2
195#define ARM_GROUPS_AUTO 3
196void ED_object_vgroup_calc_from_armature(ReportList *reports,
197 Depsgraph *depsgraph,
198 Scene *scene,
199 Object *ob,
200 Object *par,
201 int mode,
202 bool mirror);
203
204/* `editarmature_undo.cc` */
205
207void ED_armature_undosys_type(UndoType *ut);
208
209/* `armature_utils.cc` */
210
212void ED_armature_edit_sync_selection(ListBaseT<EditBone> *edbo);
216void ED_armature_ebone_remove_ex(bArmature *arm, EditBone *exBone, bool clear_connected);
217void ED_armature_ebone_remove(bArmature *arm, EditBone *exBone);
218bool ED_armature_ebone_is_child_recursive(EditBone *ebone_parent, EditBone *ebone_child);
226EditBone *ED_armature_ebone_find_shared_parent(EditBone *ebone_child[],
227 unsigned int ebone_child_tot);
228void ED_armature_ebone_to_mat3(EditBone *ebone, float r_mat[3][3]);
229void ED_armature_ebone_to_mat4(EditBone *ebone, float r_mat[4][4]);
230void ED_armature_ebone_from_mat3(EditBone *ebone, const float mat[3][3]);
231void ED_armature_ebone_from_mat4(EditBone *ebone, const float mat[4][4]);
235EditBone *ED_armature_ebone_find_name(const ListBaseT<EditBone> *edbo, const char *name);
239EditBone *ED_armature_ebone_get_mirrored(const ListBaseT<EditBone> *edbo, EditBone *ebo);
240void ED_armature_ebone_transform_mirror_update(bArmature *arm, EditBone *ebo, bool check_select);
247void ED_armature_from_edit(Main *bmain, bArmature *arm);
249void ED_armature_to_edit(bArmature *arm);
250void ED_armature_edit_free(bArmature *arm);
251void ED_armature_ebone_listbase_temp_clear(ListBaseT<EditBone> *lb);
252
256void ED_armature_ebone_listbase_free(ListBaseT<EditBone> *lb, bool do_id_user);
257void ED_armature_ebone_listbase_copy(ListBaseT<EditBone> *lb_dst,
258 ListBaseT<EditBone> *lb_src,
259 bool do_id_user);
260
261int ED_armature_ebone_selectflag_get(const EditBone *ebone);
262void ED_armature_ebone_selectflag_set(EditBone *ebone, eBone_Flag flag);
263void ED_armature_ebone_select_set(EditBone *ebone, bool select);
264void ED_armature_ebone_selectflag_enable(EditBone *ebone, eBone_Flag flag);
265void ED_armature_ebone_selectflag_disable(EditBone *ebone, eBone_Flag flag);
266
267/* `pose_edit.cc` */
268
270bool ED_object_posemode_exit_ex(Main *bmain, Object *ob);
271bool ED_object_posemode_exit(bContext *C, Object *ob);
273bool ED_object_posemode_enter_ex(Main *bmain, Object *ob);
274bool ED_object_posemode_enter(bContext *C, Object *ob);
275
282void ED_pose_recalculate_paths(bContext *C, Scene *scene, Object *ob);
283
284/* `pose_select.cc` */
285
289bool ED_armature_pose_select_pick_bone(const Main &bmain,
290 const Scene *scene,
291 ViewLayer *view_layer,
292 View3D *v3d,
293 Object *ob,
294 bPoseChannel *pchan,
295 const SelectPick_Params &params) ATTR_NONNULL(2, 3, 4, 5);
302bool ED_armature_pose_select_pick_with_buffer(const Main &bmain,
303 const Scene *scene,
304 ViewLayer *view_layer,
305 View3D *v3d,
306 Base *base,
307 const GPUSelectResult *hit_results,
308 int hits,
309 const SelectPick_Params &params,
310 bool do_nearest) ATTR_NONNULL(2, 3, 4, 5, 6);
319void ED_armature_pose_select_in_wpaint_mode(const Main &bmain,
320 const Scene *scene,
321 ViewLayer *view_layer,
322 Base *base_select);
323bool ED_pose_deselect_all_multi_ex(Span<Base *> bases, int select_mode, bool ignore_visibility);
324bool ED_pose_deselect_all_multi(bContext *C, int select_mode, bool ignore_visibility);
330bool ED_pose_deselect_all(Object *ob, int select_mode, bool ignore_visibility);
337void ED_pose_bone_select(Object *ob, bPoseChannel *pchan, bool select, bool change_active);
338
339/* `meshlaplacian.cc` */
340
343 Mesh *cagemesh,
344 float *vertexcos,
345 int verts_num,
346 float cagemat[4][4]);
347
348EditBone *ED_armature_pick_ebone(bContext *C, const int xy[2], bool findunsel, Base **r_base);
349bPoseChannel *ED_armature_pick_pchan(bContext *C, const int xy[2], bool findunsel, Base **r_base);
350Bone *ED_armature_pick_bone(bContext *C, const int xy[2], bool findunsel, Base **r_base);
351
352} // namespace blender
#define ATTR_NONNULL(...)
These structs are the foundation for all linked lists in the library system.
#define C
Definition RandGen.cpp:29
Definition scene.h:133
#define select(A, B, C)
float length(VecOp< float, D >) RET
BMesh Iterators.
void ED_armature_bones_flip_names(Main *bmain, bArmature *arm, ListBaseT< LinkData > *bones_names, const bool do_strip_numbers)
Base * ED_armature_base_and_ebone_from_select_buffer(const Span< Base * > bases, const uint select_id, EditBone **r_ebone)
bool ED_armature_edit_select_pick(bContext *C, const int mval[2], const SelectPick_Params &params)
void ED_armature_origin_set(Main *bmain, Object *ob, const float cursor[3], int centermode, int around)
void ED_armature_to_edit(bArmature *arm)
bool ED_armature_selectresult_is_bone(const GPUSelectResult &hit_result)
void ED_armature_from_edit(Main *bmain, bArmature *arm)
void ED_armature_ebone_selectflag_disable(EditBone *ebone, eBone_Flag flag)
void ED_armature_edit_transform_mirror_update(Object *obedit)
void ED_armature_ebone_selectflag_enable(EditBone *ebone, eBone_Flag flag)
void ED_operatormacros_armature()
bool ED_armature_ebone_is_child_recursive(EditBone *ebone_parent, EditBone *ebone_child)
Bone * ED_armature_pick_bone(bContext *C, const int xy[2], bool findunsel, Base **r_base)
bool ED_armature_edit_deselect_all_visible_multi_ex(const Span< Base * > bases)
void ED_armature_ebone_listbase_copy(ListBaseT< EditBone > *lb_dst, ListBaseT< EditBone > *lb_src, const bool do_id_user)
void ED_armature_ebone_unique_name(ListBaseT< EditBone > *ebones, char *name, EditBone *bone)
void ED_armature_ebone_remove_ex(bArmature *arm, EditBone *exBone, bool clear_connected)
void ED_armature_edit_transform(bArmature *arm, const float mat[4][4], const bool do_props)
void ED_armature_ebone_transform_mirror_update(bArmature *arm, EditBone *ebo, bool check_select)
Object * ED_pose_object_from_context(bContext *C)
Definition pose_edit.cc:62
bool ED_armature_edit_select_op_from_tagged(bArmature *arm, const int sel_op)
void ED_armature_ebone_listbase_temp_clear(ListBaseT< EditBone > *lb)
void ED_armature_bone_rename(Main *bmain, bArmature *arm, const char *oldnamep, const char *newnamep)
bool ED_armature_pose_select_pick_bone(const Main &bmain, const Scene *scene, ViewLayer *view_layer, View3D *v3d, Object *ob, bPoseChannel *pchan, const SelectPick_Params &params)
Base * ED_armature_base_and_pchan_from_select_buffer(const Span< Base * > bases, const uint select_id, bPoseChannel **r_pchan)
EditBone * ED_armature_ebone_find_shared_parent(EditBone *ebone_child[], const uint ebone_child_tot)
EditBone * ED_armature_pick_ebone(bContext *C, const int xy[2], bool findunsel, Base **r_base)
EditBone * ED_armature_ebone_get_mirrored(const ListBaseT< EditBone > *edbo, EditBone *ebo)
bPoseChannel * ED_armature_pick_pchan(bContext *C, const int xy[2], bool findunsel, Base **r_base)
void ED_armature_ebone_from_mat4(EditBone *ebone, const float mat[4][4])
bool ED_armature_edit_select_pick_bone(bContext *C, Base *basact, EditBone *ebone, const eBone_Flag selmask, const SelectPick_Params &params)
void ED_armature_ebone_to_mat3(EditBone *ebone, float r_mat[3][3])
void ED_keymap_armature(wmKeyConfig *keyconf)
bool ED_object_posemode_exit_ex(Main *bmain, Object *ob)
Definition pose_edit.cc:117
void ED_armature_ebone_selectflag_set(EditBone *ebone, eBone_Flag flag)
void ED_armature_edit_sync_selection(ListBaseT< EditBone > *edbo)
wmOperatorStatus ED_armature_join_objects_exec(bContext *C, wmOperator *op)
bool ED_pose_deselect_all(Object *ob, int select_mode, const bool ignore_visibility)
bool ED_pose_deselect_all_multi_ex(const Span< Base * > bases, int select_mode, const bool ignore_visibility)
bArmature * ED_armature_context(const bContext *C)
bool ED_pose_deselect_all_multi(bContext *C, int select_mode, const bool ignore_visibility)
void ED_pose_bone_select(Object *ob, bPoseChannel *pchan, bool select, bool change_active)
void ED_armature_transform(bArmature *arm, const float mat[4][4], const bool do_props)
void ED_armature_pose_select_in_wpaint_mode(const Main &bmain, const Scene *scene, ViewLayer *view_layer, Base *base_select)
void ED_armature_ebone_to_mat4(EditBone *ebone, float r_mat[4][4])
bool ED_armature_pose_select_pick_with_buffer(const Main &bmain, const Scene *scene, ViewLayer *view_layer, View3D *v3d, Base *base, const GPUSelectResult *hit_results, const int hits, const SelectPick_Params &params, bool do_nearest)
void ED_armature_edit_free(bArmature *arm)
void ED_armature_undosys_type(UndoType *ut)
void ED_armature_ebone_from_mat3(EditBone *ebone, const float mat[3][3])
void ED_pose_bone_select_tag_update(Object *ob)
void ED_operatortypes_armature()
bool ED_armature_edit_deselect_all_visible(Object *obedit)
void ED_armature_ebone_copy(EditBone *dest, const EditBone *source)
void ED_mesh_deform_bind_callback(Object *object, MeshDeformModifierData *mmd, Mesh *cagemesh, float *vertexcos, int verts_num, float cagemat[4][4])
void ED_armature_ebone_remove(bArmature *arm, EditBone *exBone)
int ED_armature_ebone_selectflag_get(const EditBone *ebone)
bool ED_object_posemode_exit(bContext *C, Object *ob)
Definition pose_edit.cc:130
Base * ED_armature_base_and_bone_from_select_buffer(const Span< Base * > bases, const uint select_id, Bone **r_bone)
EditBone * ED_armature_ebone_add(bArmature *arm, const char *name)
bool ED_object_posemode_enter_ex(Main *bmain, Object *ob)
Definition pose_edit.cc:81
EditBone * ED_armature_ebone_add_primitive(Object *obedit_arm, const float length, const bool view_aligned)
float ED_armature_ebone_roll_to_vector(const EditBone *bone, const float align_axis[3], const bool axis_only)
void ED_object_vgroup_calc_from_armature(ReportList *reports, Depsgraph *, Scene *scene, Object *ob, Object *par, const int mode, const bool mirror)
void ED_armature_ebone_listbase_free(ListBaseT< EditBone > *lb, const bool do_id_user)
bool ED_armature_edit_deselect_all_multi_ex(const Span< Base * > bases)
Object * ED_armature_object_and_ebone_from_select_buffer(const Span< Object * > objects, const uint select_id, EditBone **r_ebone)
void ED_armature_ebone_select_set(EditBone *ebone, bool select)
void ED_pose_recalculate_paths(bContext *C, Scene *scene, Object *ob)
Definition pose_edit.cc:146
EditBone * ED_armature_ebone_find_name(const ListBaseT< EditBone > *edbo, const char *name)
bool ED_object_posemode_enter(bContext *C, Object *ob)
Definition pose_edit.cc:102
bool ED_armature_edit_deselect_all(Object *obedit)
bool ED_armature_edit_deselect_all_visible_multi(bContext *C)