5d193c56c06f0f9138983b198bd1db8994b956f3
[blender.git] / source / blender / editors / armature / armature_relations.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  * Operators for relations between bones and for transferring bones between armature objects
19  */
20
21 /** \file
22  * \ingroup edarmature
23  */
24
25 #include "MEM_guardedalloc.h"
26
27 #include "DNA_anim_types.h"
28 #include "DNA_armature_types.h"
29 #include "DNA_constraint_types.h"
30 #include "DNA_object_types.h"
31 #include "DNA_scene_types.h"
32
33 #include "BLI_blenlib.h"
34 #include "BLI_ghash.h"
35 #include "BLI_math.h"
36
37 #include "BLT_translation.h"
38
39 #include "BKE_action.h"
40 #include "BKE_animsys.h"
41 #include "BKE_constraint.h"
42 #include "BKE_context.h"
43 #include "BKE_fcurve.h"
44 #include "BKE_layer.h"
45 #include "BKE_main.h"
46 #include "BKE_report.h"
47
48 #include "DEG_depsgraph.h"
49 #include "DEG_depsgraph_build.h"
50
51 #include "RNA_access.h"
52 #include "RNA_define.h"
53
54 #include "WM_api.h"
55 #include "WM_types.h"
56
57 #include "ED_armature.h"
58 #include "ED_object.h"
59 #include "ED_screen.h"
60
61 #include "UI_interface.h"
62 #include "UI_resources.h"
63
64 #include "armature_intern.h"
65
66 /* *************************************** Join *************************************** */
67 /* NOTE: no operator define here as this is exported to the Object-level operator */
68
69 static void joined_armature_fix_links_constraints(
70     Object *tarArm, Object *srcArm, bPoseChannel *pchan, EditBone *curbone, ListBase *lb)
71 {
72   bConstraint *con;
73
74   for (con = lb->first; con; con = con->next) {
75     const bConstraintTypeInfo *cti = BKE_constraint_typeinfo_get(con);
76     ListBase targets = {NULL, NULL};
77     bConstraintTarget *ct;
78
79     /* constraint targets */
80     if (cti && cti->get_constraint_targets) {
81       cti->get_constraint_targets(con, &targets);
82
83       for (ct = targets.first; ct; ct = ct->next) {
84         if (ct->tar == srcArm) {
85           if (ct->subtarget[0] == '\0') {
86             ct->tar = tarArm;
87           }
88           else if (STREQ(ct->subtarget, pchan->name)) {
89             ct->tar = tarArm;
90             BLI_strncpy(ct->subtarget, curbone->name, sizeof(ct->subtarget));
91           }
92         }
93       }
94
95       if (cti->flush_constraint_targets)
96         cti->flush_constraint_targets(con, &targets, 0);
97     }
98
99     /* action constraint? (pose constraints only) */
100     if (con->type == CONSTRAINT_TYPE_ACTION) {
101       bActionConstraint *data = con->data;
102
103       if (data->act) {
104         BKE_action_fix_paths_rename(
105             &tarArm->id, data->act, "pose.bones[", pchan->name, curbone->name, 0, 0, false);
106       }
107     }
108   }
109 }
110
111 /* userdata for joined_armature_fix_animdata_cb() */
112 typedef struct tJoinArmature_AdtFixData {
113   Object *srcArm;
114   Object *tarArm;
115
116   GHash *names_map;
117 } tJoinArmature_AdtFixData;
118
119 /* Callback to pass to BKE_animdata_main_cb() for fixing driver ID's to point to the new ID. */
120 /* FIXME: For now, we only care about drivers here.
121  *        When editing rigs, it's very rare to have animation on the rigs being edited already,
122  *        so it should be safe to skip these.
123  */
124 static void joined_armature_fix_animdata_cb(ID *id, FCurve *fcu, void *user_data)
125 {
126   tJoinArmature_AdtFixData *afd = (tJoinArmature_AdtFixData *)user_data;
127   ID *src_id = &afd->srcArm->id;
128   ID *dst_id = &afd->tarArm->id;
129
130   GHashIterator gh_iter;
131
132   /* Fix paths - If this is the target object, it will have some "dirty" paths */
133   if ((id == src_id) && strstr(fcu->rna_path, "pose.bones[")) {
134     GHASH_ITER (gh_iter, afd->names_map) {
135       const char *old_name = BLI_ghashIterator_getKey(&gh_iter);
136       const char *new_name = BLI_ghashIterator_getValue(&gh_iter);
137
138       /* only remap if changed; this still means there will be some
139        * waste if there aren't many drivers/keys */
140       if (!STREQ(old_name, new_name) && strstr(fcu->rna_path, old_name)) {
141         fcu->rna_path = BKE_animsys_fix_rna_path_rename(
142             id, fcu->rna_path, "pose.bones", old_name, new_name, 0, 0, false);
143
144         /* we don't want to apply a second remapping on this driver now,
145          * so stop trying names, but keep fixing drivers
146          */
147         break;
148       }
149     }
150   }
151
152   /* Driver targets */
153   if (fcu->driver) {
154     ChannelDriver *driver = fcu->driver;
155     DriverVar *dvar;
156
157     /* Fix driver references to invalid ID's */
158     for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
159       /* only change the used targets, since the others will need fixing manually anyway */
160       DRIVER_TARGETS_USED_LOOPER_BEGIN (dvar) {
161         /* change the ID's used... */
162         if (dtar->id == src_id) {
163           dtar->id = dst_id;
164
165           /* also check on the subtarget...
166            * XXX: We duplicate the logic from drivers_path_rename_fix() here, with our own
167            *      little twists so that we know that it isn't going to clobber the wrong data
168            */
169           if ((dtar->rna_path && strstr(dtar->rna_path, "pose.bones[")) || (dtar->pchan_name[0])) {
170             GHASH_ITER (gh_iter, afd->names_map) {
171               const char *old_name = BLI_ghashIterator_getKey(&gh_iter);
172               const char *new_name = BLI_ghashIterator_getValue(&gh_iter);
173
174               /* only remap if changed */
175               if (!STREQ(old_name, new_name)) {
176                 if ((dtar->rna_path) && strstr(dtar->rna_path, old_name)) {
177                   /* Fix up path */
178                   dtar->rna_path = BKE_animsys_fix_rna_path_rename(
179                       id, dtar->rna_path, "pose.bones", old_name, new_name, 0, 0, false);
180                   break; /* no need to try any more names for bone path */
181                 }
182                 else if (STREQ(dtar->pchan_name, old_name)) {
183                   /* Change target bone name */
184                   BLI_strncpy(dtar->pchan_name, new_name, sizeof(dtar->pchan_name));
185                   break; /* no need to try any more names for bone subtarget */
186                 }
187               }
188             }
189           }
190         }
191       }
192       DRIVER_TARGETS_LOOPER_END;
193     }
194   }
195 }
196
197 /* Helper function for armature joining - link fixing */
198 static void joined_armature_fix_links(
199     Main *bmain, Object *tarArm, Object *srcArm, bPoseChannel *pchan, EditBone *curbone)
200 {
201   Object *ob;
202   bPose *pose;
203   bPoseChannel *pchant;
204
205   /* let's go through all objects in database */
206   for (ob = bmain->objects.first; ob; ob = ob->id.next) {
207     /* do some object-type specific things */
208     if (ob->type == OB_ARMATURE) {
209       pose = ob->pose;
210       for (pchant = pose->chanbase.first; pchant; pchant = pchant->next) {
211         joined_armature_fix_links_constraints(
212             tarArm, srcArm, pchan, curbone, &pchant->constraints);
213       }
214     }
215
216     /* fix object-level constraints */
217     if (ob != srcArm) {
218       joined_armature_fix_links_constraints(tarArm, srcArm, pchan, curbone, &ob->constraints);
219     }
220
221     /* See if an object is parented to this armature */
222     if (ob->parent && (ob->parent == srcArm)) {
223       /* Is object parented to a bone of this src armature? */
224       if (ob->partype == PARBONE) {
225         /* bone name in object */
226         if (STREQ(ob->parsubstr, pchan->name)) {
227           BLI_strncpy(ob->parsubstr, curbone->name, sizeof(ob->parsubstr));
228         }
229       }
230
231       /* make tar armature be new parent */
232       ob->parent = tarArm;
233     }
234   }
235 }
236
237 /* join armature exec is exported for use in object->join objects operator... */
238 int join_armature_exec(bContext *C, wmOperator *op)
239 {
240   Main *bmain = CTX_data_main(C);
241   Scene *scene = CTX_data_scene(C);
242   Object *ob_active = CTX_data_active_object(C);
243   bArmature *arm = (ob_active) ? ob_active->data : NULL;
244   bPose *pose, *opose;
245   bPoseChannel *pchan, *pchann;
246   EditBone *curbone;
247   float mat[4][4], oimat[4][4];
248   bool ok = false;
249
250   /*  Ensure we're not in editmode and that the active object is an armature*/
251   if (!ob_active || ob_active->type != OB_ARMATURE)
252     return OPERATOR_CANCELLED;
253   if (!arm || arm->edbo)
254     return OPERATOR_CANCELLED;
255
256   CTX_DATA_BEGIN (C, Object *, ob_iter, selected_editable_objects) {
257     if (ob_iter == ob_active) {
258       ok = true;
259       break;
260     }
261   }
262   CTX_DATA_END;
263
264   /* that way the active object is always selected */
265   if (ok == false) {
266     BKE_report(op->reports, RPT_WARNING, "Active object is not a selected armature");
267     return OPERATOR_CANCELLED;
268   }
269
270   /* Get editbones of active armature to add editbones to */
271   ED_armature_to_edit(arm);
272
273   /* get pose of active object and move it out of posemode */
274   pose = ob_active->pose;
275   ob_active->mode &= ~OB_MODE_POSE;
276
277   CTX_DATA_BEGIN (C, Object *, ob_iter, selected_editable_objects) {
278     if ((ob_iter->type == OB_ARMATURE) && (ob_iter != ob_active)) {
279       tJoinArmature_AdtFixData afd = {NULL};
280       bArmature *curarm = ob_iter->data;
281
282       /* we assume that each armature datablock is only used in a single place */
283       BLI_assert(ob_active->data != ob_iter->data);
284
285       /* init callback data for fixing up AnimData links later */
286       afd.srcArm = ob_iter;
287       afd.tarArm = ob_active;
288       afd.names_map = BLI_ghash_str_new("join_armature_adt_fix");
289
290       /* Make a list of editbones in current armature */
291       ED_armature_to_edit(ob_iter->data);
292
293       /* Get Pose of current armature */
294       opose = ob_iter->pose;
295       ob_iter->mode &= ~OB_MODE_POSE;
296       //BASACT->flag &= ~OB_MODE_POSE;
297
298       /* Find the difference matrix */
299       invert_m4_m4(oimat, ob_active->obmat);
300       mul_m4_m4m4(mat, oimat, ob_iter->obmat);
301
302       /* Copy bones and posechannels from the object to the edit armature */
303       for (pchan = opose->chanbase.first; pchan; pchan = pchann) {
304         pchann = pchan->next;
305         curbone = ED_armature_ebone_find_name(curarm->edbo, pchan->name);
306
307         /* Get new name */
308         ED_armature_ebone_unique_name(arm->edbo, curbone->name, NULL);
309         BLI_ghash_insert(afd.names_map, BLI_strdup(pchan->name), curbone->name);
310
311         /* Transform the bone */
312         {
313           float premat[4][4];
314           float postmat[4][4];
315           float difmat[4][4];
316           float imat[4][4];
317           float temp[3][3];
318
319           /* Get the premat */
320           ED_armature_ebone_to_mat3(curbone, temp);
321
322           unit_m4(premat); /* mul_m4_m3m4 only sets 3x3 part */
323           mul_m4_m3m4(premat, temp, mat);
324
325           mul_m4_v3(mat, curbone->head);
326           mul_m4_v3(mat, curbone->tail);
327
328           /* Get the postmat */
329           ED_armature_ebone_to_mat3(curbone, temp);
330           copy_m4_m3(postmat, temp);
331
332           /* Find the roll */
333           invert_m4_m4(imat, premat);
334           mul_m4_m4m4(difmat, imat, postmat);
335
336           curbone->roll -= atan2f(difmat[2][0], difmat[2][2]);
337         }
338
339         /* Fix Constraints and Other Links to this Bone and Armature */
340         joined_armature_fix_links(bmain, ob_active, ob_iter, pchan, curbone);
341
342         /* Rename pchan */
343         BLI_strncpy(pchan->name, curbone->name, sizeof(pchan->name));
344
345         /* Jump Ship! */
346         BLI_remlink(curarm->edbo, curbone);
347         BLI_addtail(arm->edbo, curbone);
348
349         BLI_remlink(&opose->chanbase, pchan);
350         BLI_addtail(&pose->chanbase, pchan);
351         BKE_pose_channels_hash_free(opose);
352         BKE_pose_channels_hash_free(pose);
353       }
354
355       /* Fix all the drivers (and animation data) */
356       BKE_fcurves_main_cb(bmain, joined_armature_fix_animdata_cb, &afd);
357       BLI_ghash_free(afd.names_map, MEM_freeN, NULL);
358
359       /* Only copy over animdata now, after all the remapping has been done,
360        * so that we don't have to worry about ambiguities re which armature
361        * a bone came from!
362        */
363       if (ob_iter->adt) {
364         if (ob_active->adt == NULL) {
365           /* no animdata, so just use a copy of the whole thing */
366           ob_active->adt = BKE_animdata_copy(bmain, ob_iter->adt, 0);
367         }
368         else {
369           /* merge in data - we'll fix the drivers manually */
370           BKE_animdata_merge_copy(
371               bmain, &ob_active->id, &ob_iter->id, ADT_MERGECOPY_KEEP_DST, false);
372         }
373       }
374
375       if (curarm->adt) {
376         if (arm->adt == NULL) {
377           /* no animdata, so just use a copy of the whole thing */
378           arm->adt = BKE_animdata_copy(bmain, curarm->adt, 0);
379         }
380         else {
381           /* merge in data - we'll fix the drivers manually */
382           BKE_animdata_merge_copy(bmain, &arm->id, &curarm->id, ADT_MERGECOPY_KEEP_DST, false);
383         }
384       }
385
386       /* Free the old object data */
387       ED_object_base_free_and_unlink(bmain, scene, ob_iter);
388     }
389   }
390   CTX_DATA_END;
391
392   DEG_relations_tag_update(bmain); /* because we removed object(s) */
393
394   ED_armature_from_edit(bmain, arm);
395   ED_armature_edit_free(arm);
396
397   DEG_id_tag_update(&scene->id, ID_RECALC_SELECT);
398   WM_event_add_notifier(C, NC_SCENE | ND_OB_ACTIVE, scene);
399
400   return OPERATOR_FINISHED;
401 }
402
403 /* *********************************** Separate *********************************************** */
404
405 /* Helper function for armature separating - link fixing */
406 static void separated_armature_fix_links(Main *bmain, Object *origArm, Object *newArm)
407 {
408   Object *ob;
409   bPoseChannel *pchan;
410   bConstraint *con;
411   ListBase *opchans, *npchans;
412
413   /* get reference to list of bones in original and new armatures  */
414   opchans = &origArm->pose->chanbase;
415   npchans = &newArm->pose->chanbase;
416
417   /* let's go through all objects in database */
418   for (ob = bmain->objects.first; ob; ob = ob->id.next) {
419     /* do some object-type specific things */
420     if (ob->type == OB_ARMATURE) {
421       for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
422         for (con = pchan->constraints.first; con; con = con->next) {
423           const bConstraintTypeInfo *cti = BKE_constraint_typeinfo_get(con);
424           ListBase targets = {NULL, NULL};
425           bConstraintTarget *ct;
426
427           /* constraint targets */
428           if (cti && cti->get_constraint_targets) {
429             cti->get_constraint_targets(con, &targets);
430
431             for (ct = targets.first; ct; ct = ct->next) {
432               /* any targets which point to original armature are redirected to the new one only if:
433                * - the target isn't origArm/newArm itself
434                * - the target is one that can be found in newArm/origArm
435                */
436               if (ct->subtarget[0] != 0) {
437                 if (ct->tar == origArm) {
438                   if (BLI_findstring(npchans, ct->subtarget, offsetof(bPoseChannel, name))) {
439                     ct->tar = newArm;
440                   }
441                 }
442                 else if (ct->tar == newArm) {
443                   if (BLI_findstring(opchans, ct->subtarget, offsetof(bPoseChannel, name))) {
444                     ct->tar = origArm;
445                   }
446                 }
447               }
448             }
449
450             if (cti->flush_constraint_targets) {
451               cti->flush_constraint_targets(con, &targets, 0);
452             }
453           }
454         }
455       }
456     }
457
458     /* fix object-level constraints */
459     if (ob != origArm) {
460       for (con = ob->constraints.first; con; con = con->next) {
461         const bConstraintTypeInfo *cti = BKE_constraint_typeinfo_get(con);
462         ListBase targets = {NULL, NULL};
463         bConstraintTarget *ct;
464
465         /* constraint targets */
466         if (cti && cti->get_constraint_targets) {
467           cti->get_constraint_targets(con, &targets);
468
469           for (ct = targets.first; ct; ct = ct->next) {
470             /* any targets which point to original armature are redirected to the new one only if:
471              * - the target isn't origArm/newArm itself
472              * - the target is one that can be found in newArm/origArm
473              */
474             if (ct->subtarget[0] != '\0') {
475               if (ct->tar == origArm) {
476                 if (BLI_findstring(npchans, ct->subtarget, offsetof(bPoseChannel, name))) {
477                   ct->tar = newArm;
478                 }
479               }
480               else if (ct->tar == newArm) {
481                 if (BLI_findstring(opchans, ct->subtarget, offsetof(bPoseChannel, name))) {
482                   ct->tar = origArm;
483                 }
484               }
485             }
486           }
487
488           if (cti->flush_constraint_targets) {
489             cti->flush_constraint_targets(con, &targets, 0);
490           }
491         }
492       }
493     }
494
495     /* See if an object is parented to this armature */
496     if (ob->parent && (ob->parent == origArm)) {
497       /* Is object parented to a bone of this src armature? */
498       if ((ob->partype == PARBONE) && (ob->parsubstr[0] != '\0')) {
499         if (BLI_findstring(npchans, ob->parsubstr, offsetof(bPoseChannel, name))) {
500           ob->parent = newArm;
501         }
502       }
503     }
504   }
505 }
506
507 /* Helper function for armature separating - remove certain bones from the given armature
508  * sel: remove selected bones from the armature, otherwise the unselected bones are removed
509  * (ob is not in editmode)
510  */
511 static void separate_armature_bones(Main *bmain, Object *ob, short sel)
512 {
513   bArmature *arm = (bArmature *)ob->data;
514   bPoseChannel *pchan, *pchann;
515   EditBone *curbone;
516
517   /* make local set of editbones to manipulate here */
518   ED_armature_to_edit(arm);
519
520   /* go through pose-channels, checking if a bone should be removed */
521   for (pchan = ob->pose->chanbase.first; pchan; pchan = pchann) {
522     pchann = pchan->next;
523     curbone = ED_armature_ebone_find_name(arm->edbo, pchan->name);
524
525     /* check if bone needs to be removed */
526     if ((sel && (curbone->flag & BONE_SELECTED)) || (!sel && !(curbone->flag & BONE_SELECTED))) {
527       EditBone *ebo;
528       bPoseChannel *pchn;
529
530       /* clear the bone->parent var of any bone that had this as its parent  */
531       for (ebo = arm->edbo->first; ebo; ebo = ebo->next) {
532         if (ebo->parent == curbone) {
533           ebo->parent = NULL;
534           /* this is needed to prevent random crashes with in ED_armature_from_edit */
535           ebo->temp.p = NULL;
536           ebo->flag &= ~BONE_CONNECTED;
537         }
538       }
539
540       /* clear the pchan->parent var of any pchan that had this as its parent */
541       for (pchn = ob->pose->chanbase.first; pchn; pchn = pchn->next) {
542         if (pchn->parent == pchan) {
543           pchn->parent = NULL;
544         }
545         if (pchn->bbone_next == pchan) {
546           pchn->bbone_next = NULL;
547         }
548         if (pchn->bbone_prev == pchan) {
549           pchn->bbone_prev = NULL;
550         }
551       }
552
553       /* free any of the extra-data this pchan might have */
554       BKE_pose_channel_free(pchan);
555       BKE_pose_channels_hash_free(ob->pose);
556
557       /* get rid of unneeded bone */
558       bone_free(arm, curbone);
559       BLI_freelinkN(&ob->pose->chanbase, pchan);
560     }
561   }
562
563   /* exit editmode (recalculates pchans too) */
564   ED_armature_from_edit(bmain, ob->data);
565   ED_armature_edit_free(ob->data);
566 }
567
568 /* separate selected bones into their armature */
569 static int separate_armature_exec(bContext *C, wmOperator *op)
570 {
571   Main *bmain = CTX_data_main(C);
572   Scene *scene = CTX_data_scene(C);
573   ViewLayer *view_layer = CTX_data_view_layer(C);
574   bool ok = false;
575
576   /* set wait cursor in case this takes a while */
577   WM_cursor_wait(1);
578
579   uint bases_len = 0;
580   Base **bases = BKE_view_layer_array_from_bases_in_edit_mode_unique_data(
581       view_layer, CTX_wm_view3d(C), &bases_len);
582
583   CTX_DATA_BEGIN (C, Base *, base, visible_bases) {
584     ED_object_base_select(base, BA_DESELECT);
585   }
586   CTX_DATA_END;
587
588   for (uint base_index = 0; base_index < bases_len; base_index++) {
589     Base *base_iter = bases[base_index];
590     Object *obedit = base_iter->object;
591
592     Object *oldob, *newob;
593     Base *oldbase, *newbase;
594
595     /* We are going to do this as follows (unlike every other instance of separate):
596      * 1. Exit editmode +posemode for active armature/base. Take note of what this is.
597      * 2. Duplicate base - BASACT is the new one now
598      * 3. For each of the two armatures,
599      *    enter editmode -> remove appropriate bones -> exit editmode + recalc.
600      * 4. Fix constraint links
601      * 5. Make original armature active and enter editmode
602      */
603
604     /* 1) only edit-base selected */
605     ED_object_base_select(base_iter, BA_SELECT);
606
607     /* 1) store starting settings and exit editmode */
608     oldob = obedit;
609     oldbase = base_iter;
610     oldob->mode &= ~OB_MODE_POSE;
611     //oldbase->flag &= ~OB_POSEMODE;
612
613     ED_armature_from_edit(bmain, obedit->data);
614     ED_armature_edit_free(obedit->data);
615
616     /* 2) duplicate base */
617
618     /* only duplicate linked armature */
619     newbase = ED_object_add_duplicate(bmain, scene, view_layer, oldbase, USER_DUP_ARM);
620
621     DEG_relations_tag_update(bmain);
622
623     newob = newbase->object;
624     newbase->flag &= ~BASE_SELECTED;
625
626     /* 3) remove bones that shouldn't still be around on both armatures */
627     separate_armature_bones(bmain, oldob, 1);
628     separate_armature_bones(bmain, newob, 0);
629
630     /* 4) fix links before depsgraph flushes */  // err... or after?
631     separated_armature_fix_links(bmain, oldob, newob);
632
633     DEG_id_tag_update(&oldob->id, ID_RECALC_GEOMETRY); /* this is the original one */
634     DEG_id_tag_update(&newob->id, ID_RECALC_GEOMETRY); /* this is the separated one */
635
636     /* 5) restore original conditions */
637     obedit = oldob;
638
639     ED_armature_to_edit(obedit->data);
640
641     /* parents tips remain selected when connected children are removed. */
642     ED_armature_edit_deselect_all(obedit);
643
644     ok = true;
645
646     /* note, notifier might evolve */
647     WM_event_add_notifier(C, NC_OBJECT | ND_POSE, obedit);
648   }
649   MEM_freeN(bases);
650
651   /* recalc/redraw + cleanup */
652   WM_cursor_wait(0);
653
654   if (ok) {
655     BKE_report(op->reports, RPT_INFO, "Separated bones");
656   }
657
658   return OPERATOR_FINISHED;
659 }
660
661 void ARMATURE_OT_separate(wmOperatorType *ot)
662 {
663   /* identifiers */
664   ot->name = "Separate Bones";
665   ot->idname = "ARMATURE_OT_separate";
666   ot->description = "Isolate selected bones into a separate armature";
667
668   /* callbacks */
669   ot->invoke = WM_operator_confirm;
670   ot->exec = separate_armature_exec;
671   ot->poll = ED_operator_editarmature;
672
673   /* flags */
674   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
675 }
676
677 /* ********************************* Parenting ************************************************* */
678
679 /* armature parenting options */
680 #define ARM_PAR_CONNECT 1
681 #define ARM_PAR_OFFSET 2
682
683 /* check for null, before calling! */
684 static void bone_connect_to_existing_parent(EditBone *bone)
685 {
686   bone->flag |= BONE_CONNECTED;
687   copy_v3_v3(bone->head, bone->parent->tail);
688   bone->rad_head = bone->parent->rad_tail;
689 }
690
691 static void bone_connect_to_new_parent(ListBase *edbo,
692                                        EditBone *selbone,
693                                        EditBone *actbone,
694                                        short mode)
695 {
696   EditBone *ebone;
697   float offset[3];
698
699   if ((selbone->parent) && (selbone->flag & BONE_CONNECTED))
700     selbone->parent->flag &= ~(BONE_TIPSEL);
701
702   /* make actbone the parent of selbone */
703   selbone->parent = actbone;
704
705   /* in actbone tree we cannot have a loop */
706   for (ebone = actbone->parent; ebone; ebone = ebone->parent) {
707     if (ebone->parent == selbone) {
708       ebone->parent = NULL;
709       ebone->flag &= ~BONE_CONNECTED;
710     }
711   }
712
713   if (mode == ARM_PAR_CONNECT) {
714     /* Connected: Child bones will be moved to the parent tip */
715     selbone->flag |= BONE_CONNECTED;
716     sub_v3_v3v3(offset, actbone->tail, selbone->head);
717
718     copy_v3_v3(selbone->head, actbone->tail);
719     selbone->rad_head = actbone->rad_tail;
720
721     add_v3_v3(selbone->tail, offset);
722
723     /* offset for all its children */
724     for (ebone = edbo->first; ebone; ebone = ebone->next) {
725       EditBone *par;
726
727       for (par = ebone->parent; par; par = par->parent) {
728         if (par == selbone) {
729           add_v3_v3(ebone->head, offset);
730           add_v3_v3(ebone->tail, offset);
731           break;
732         }
733       }
734     }
735   }
736   else {
737     /* Offset: Child bones will retain their distance from the parent tip */
738     selbone->flag &= ~BONE_CONNECTED;
739   }
740 }
741
742 static const EnumPropertyItem prop_editarm_make_parent_types[] = {
743     {ARM_PAR_CONNECT, "CONNECTED", 0, "Connected", ""},
744     {ARM_PAR_OFFSET, "OFFSET", 0, "Keep Offset", ""},
745     {0, NULL, 0, NULL, NULL},
746 };
747
748 static int armature_parent_set_exec(bContext *C, wmOperator *op)
749 {
750   Object *ob = CTX_data_edit_object(C);
751   bArmature *arm = (bArmature *)ob->data;
752   EditBone *actbone = CTX_data_active_bone(C);
753   EditBone *actmirb = NULL;
754   short val = RNA_enum_get(op->ptr, "type");
755
756   /* there must be an active bone */
757   if (actbone == NULL) {
758     BKE_report(op->reports, RPT_ERROR, "Operation requires an active bone");
759     return OPERATOR_CANCELLED;
760   }
761   else if (arm->flag & ARM_MIRROR_EDIT) {
762     /* For X-Axis Mirror Editing option, we may need a mirror copy of actbone
763      * - if there's a mirrored copy of selbone, try to find a mirrored copy of actbone
764      *   (i.e.  selbone="child.L" and actbone="parent.L", find "child.R" and "parent.R").
765      * This is useful for arm-chains, for example parenting lower arm to upper arm
766      * - if there's no mirrored copy of actbone (i.e. actbone = "parent.C" or "parent")
767      *   then just use actbone. Useful when doing upper arm to spine.
768      */
769     actmirb = ED_armature_ebone_get_mirrored(arm->edbo, actbone);
770     if (actmirb == NULL)
771       actmirb = actbone;
772   }
773
774   /* if there is only 1 selected bone, we assume that that is the active bone,
775    * since a user will need to have clicked on a bone (thus selecting it) to make it active
776    */
777   if (CTX_DATA_COUNT(C, selected_editable_bones) <= 1) {
778     /* When only the active bone is selected, and it has a parent,
779      * connect it to the parent, as that is the only possible outcome.
780      */
781     if (actbone->parent) {
782       bone_connect_to_existing_parent(actbone);
783
784       if ((arm->flag & ARM_MIRROR_EDIT) && (actmirb->parent))
785         bone_connect_to_existing_parent(actmirb);
786     }
787   }
788   else {
789     /* Parent 'selected' bones to the active one
790      * - the context iterator contains both selected bones and their mirrored copies,
791      *   so we assume that unselected bones are mirrored copies of some selected bone
792      * - since the active one (and/or its mirror) will also be selected, we also need
793      *   to check that we are not trying to operate on them, since such an operation
794      *   would cause errors
795      */
796
797     /* parent selected bones to the active one */
798     CTX_DATA_BEGIN (C, EditBone *, ebone, selected_editable_bones) {
799       if (ELEM(ebone, actbone, actmirb) == 0) {
800         if (ebone->flag & BONE_SELECTED)
801           bone_connect_to_new_parent(arm->edbo, ebone, actbone, val);
802         else
803           bone_connect_to_new_parent(arm->edbo, ebone, actmirb, val);
804       }
805     }
806     CTX_DATA_END;
807   }
808
809   /* note, notifier might evolve */
810   WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, ob);
811
812   return OPERATOR_FINISHED;
813 }
814
815 static int armature_parent_set_invoke(bContext *C,
816                                       wmOperator *UNUSED(op),
817                                       const wmEvent *UNUSED(event))
818 {
819   EditBone *actbone = CTX_data_active_bone(C);
820   uiPopupMenu *pup = UI_popup_menu_begin(
821       C, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Make Parent"), ICON_NONE);
822   uiLayout *layout = UI_popup_menu_layout(pup);
823   int allchildbones = 0;
824
825   CTX_DATA_BEGIN (C, EditBone *, ebone, selected_editable_bones) {
826     if (ebone != actbone) {
827       if (ebone->parent != actbone)
828         allchildbones = 1;
829     }
830   }
831   CTX_DATA_END;
832
833   uiItemEnumO(layout, "ARMATURE_OT_parent_set", NULL, 0, "type", ARM_PAR_CONNECT);
834
835   /* ob becomes parent, make the associated menus */
836   if (allchildbones)
837     uiItemEnumO(layout, "ARMATURE_OT_parent_set", NULL, 0, "type", ARM_PAR_OFFSET);
838
839   UI_popup_menu_end(C, pup);
840
841   return OPERATOR_INTERFACE;
842 }
843
844 void ARMATURE_OT_parent_set(wmOperatorType *ot)
845 {
846   /* identifiers */
847   ot->name = "Make Parent";
848   ot->idname = "ARMATURE_OT_parent_set";
849   ot->description = "Set the active bone as the parent of the selected bones";
850
851   /* api callbacks */
852   ot->invoke = armature_parent_set_invoke;
853   ot->exec = armature_parent_set_exec;
854   ot->poll = ED_operator_editarmature;
855
856   /* flags */
857   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
858
859   RNA_def_enum(
860       ot->srna, "type", prop_editarm_make_parent_types, 0, "ParentType", "Type of parenting");
861 }
862
863 static const EnumPropertyItem prop_editarm_clear_parent_types[] = {
864     {1, "CLEAR", 0, "Clear Parent", ""},
865     {2, "DISCONNECT", 0, "Disconnect Bone", ""},
866     {0, NULL, 0, NULL, NULL},
867 };
868
869 static void editbone_clear_parent(EditBone *ebone, int mode)
870 {
871   if (ebone->parent) {
872     /* for nice selection */
873     ebone->parent->flag &= ~(BONE_TIPSEL);
874   }
875
876   if (mode == 1)
877     ebone->parent = NULL;
878   ebone->flag &= ~BONE_CONNECTED;
879 }
880
881 static int armature_parent_clear_exec(bContext *C, wmOperator *op)
882 {
883   ViewLayer *view_layer = CTX_data_view_layer(C);
884   const int val = RNA_enum_get(op->ptr, "type");
885
886   CTX_DATA_BEGIN (C, EditBone *, ebone, selected_editable_bones) {
887     editbone_clear_parent(ebone, val);
888   }
889   CTX_DATA_END;
890
891   uint objects_len = 0;
892   Object **objects = BKE_view_layer_array_from_objects_in_edit_mode_unique_data(
893       view_layer, CTX_wm_view3d(C), &objects_len);
894   for (uint ob_index = 0; ob_index < objects_len; ob_index++) {
895     Object *ob = objects[ob_index];
896     bArmature *arm = ob->data;
897     bool changed = false;
898
899     for (EditBone *ebone = arm->edbo->first; ebone; ebone = ebone->next) {
900       if (EBONE_EDITABLE(ebone)) {
901         changed = true;
902         break;
903       }
904     }
905
906     if (!changed) {
907       continue;
908     }
909
910     ED_armature_edit_sync_selection(arm->edbo);
911
912     /* Note, notifier might evolve. */
913     WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, ob);
914   }
915   MEM_freeN(objects);
916
917   return OPERATOR_FINISHED;
918 }
919
920 void ARMATURE_OT_parent_clear(wmOperatorType *ot)
921 {
922   /* identifiers */
923   ot->name = "Clear Parent";
924   ot->idname = "ARMATURE_OT_parent_clear";
925   ot->description =
926       "Remove the parent-child relationship between selected bones and their parents";
927
928   /* api callbacks */
929   ot->invoke = WM_menu_invoke;
930   ot->exec = armature_parent_clear_exec;
931   ot->poll = ED_operator_editarmature;
932
933   /* flags */
934   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
935
936   ot->prop = RNA_def_enum(ot->srna,
937                           "type",
938                           prop_editarm_clear_parent_types,
939                           0,
940                           "ClearType",
941                           "What way to clear parenting");
942 }