ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / intern / action.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  */
19
20 /** \file
21  * \ingroup bke
22  */
23
24 #include <string.h>
25 #include <math.h>
26 #include <stdlib.h>
27 #include <stddef.h>
28
29 #include "MEM_guardedalloc.h"
30
31 #include "DNA_anim_types.h"
32 #include "DNA_armature_types.h"
33 #include "DNA_constraint_types.h"
34 #include "DNA_scene_types.h"
35 #include "DNA_object_types.h"
36
37 #include "BLI_blenlib.h"
38 #include "BLI_math.h"
39 #include "BLI_string_utils.h"
40 #include "BLI_utildefines.h"
41 #include "BLI_ghash.h"
42
43 #include "BLT_translation.h"
44
45 #include "BKE_action.h"
46 #include "BKE_anim.h"
47 #include "BKE_animsys.h"
48 #include "BKE_constraint.h"
49 #include "BKE_deform.h"
50 #include "BKE_fcurve.h"
51 #include "BKE_idprop.h"
52 #include "BKE_library.h"
53 #include "BKE_main.h"
54 #include "BKE_object.h"
55
56 #include "DEG_depsgraph_build.h"
57
58 #include "BIK_api.h"
59
60 #include "RNA_access.h"
61
62 #include "CLG_log.h"
63
64 static CLG_LogRef LOG = {"bke.action"};
65
66 /* *********************** NOTE ON POSE AND ACTION **********************
67  *
68  * - Pose is the local (object level) component of armature. The current
69  *   object pose is saved in files, and (will be) is presorted for dependency
70  * - Actions have fewer (or other) channels, and write data to a Pose
71  * - Currently ob->pose data is controlled in BKE_pose_where_is only. The (recalc)
72  *   event system takes care of calling that
73  * - The NLA system (here too) uses Poses as interpolation format for Actions
74  * - Therefore we assume poses to be static, and duplicates of poses have channels in
75  *   same order, for quick interpolation reasons
76  *
77  * ****************************** (ton) ************************************ */
78
79 /* ***************** Library data level operations on action ************** */
80
81 bAction *BKE_action_add(Main *bmain, const char name[])
82 {
83   bAction *act;
84
85   act = BKE_libblock_alloc(bmain, ID_AC, name, 0);
86
87   return act;
88 }
89
90 /* .................................. */
91
92 // does copy_fcurve...
93 void BKE_action_make_local(Main *bmain, bAction *act, const bool lib_local)
94 {
95   BKE_id_make_local_generic(bmain, &act->id, true, lib_local);
96 }
97
98 /* .................................. */
99
100 /** Free (or release) any data used by this action (does not free the action itself). */
101 void BKE_action_free(bAction *act)
102 {
103   /* No animdata here. */
104
105   /* Free F-Curves */
106   free_fcurves(&act->curves);
107
108   /* Free groups */
109   BLI_freelistN(&act->groups);
110
111   /* Free pose-references (aka local markers) */
112   BLI_freelistN(&act->markers);
113 }
114
115 /* .................................. */
116
117 /**
118  * Only copy internal data of Action ID from source to already allocated/initialized destination.
119  * You probably never want to use that directly, use BKE_id_copy or BKE_id_copy_ex for typical needs.
120  *
121  * WARNING! This function will not handle ID user count!
122  *
123  * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
124  */
125 void BKE_action_copy_data(Main *UNUSED(bmain),
126                           bAction *act_dst,
127                           const bAction *act_src,
128                           const int UNUSED(flag))
129 {
130   bActionGroup *grp_dst, *grp_src;
131   FCurve *fcu_dst, *fcu_src;
132
133   /* duplicate the lists of groups and markers */
134   BLI_duplicatelist(&act_dst->groups, &act_src->groups);
135   BLI_duplicatelist(&act_dst->markers, &act_src->markers);
136
137   /* copy F-Curves, fixing up the links as we go */
138   BLI_listbase_clear(&act_dst->curves);
139
140   for (fcu_src = act_src->curves.first; fcu_src; fcu_src = fcu_src->next) {
141     /* duplicate F-Curve */
142     fcu_dst = copy_fcurve(
143         fcu_src); /* XXX TODO pass subdata flag? But surprisingly does not seem to be doing any ID refcounting... */
144     BLI_addtail(&act_dst->curves, fcu_dst);
145
146     /* fix group links (kindof bad list-in-list search, but this is the most reliable way) */
147     for (grp_dst = act_dst->groups.first, grp_src = act_src->groups.first; grp_dst && grp_src;
148          grp_dst = grp_dst->next, grp_src = grp_src->next) {
149       if (fcu_src->grp == grp_src) {
150         fcu_dst->grp = grp_dst;
151
152         if (grp_dst->channels.first == fcu_src) {
153           grp_dst->channels.first = fcu_dst;
154         }
155         if (grp_dst->channels.last == fcu_src) {
156           grp_dst->channels.last = fcu_dst;
157         }
158         break;
159       }
160     }
161   }
162 }
163
164 bAction *BKE_action_copy(Main *bmain, const bAction *act_src)
165 {
166   bAction *act_copy;
167   BKE_id_copy(bmain, &act_src->id, (ID **)&act_copy);
168   return act_copy;
169 }
170
171 /* *************** Action Groups *************** */
172
173 /* Get the active action-group for an Action */
174 bActionGroup *get_active_actiongroup(bAction *act)
175 {
176   bActionGroup *agrp = NULL;
177
178   if (act && act->groups.first) {
179     for (agrp = act->groups.first; agrp; agrp = agrp->next) {
180       if (agrp->flag & AGRP_ACTIVE)
181         break;
182     }
183   }
184
185   return agrp;
186 }
187
188 /* Make the given Action-Group the active one */
189 void set_active_action_group(bAction *act, bActionGroup *agrp, short select)
190 {
191   bActionGroup *grp;
192
193   /* sanity checks */
194   if (act == NULL)
195     return;
196
197   /* Deactivate all others */
198   for (grp = act->groups.first; grp; grp = grp->next) {
199     if ((grp == agrp) && (select))
200       grp->flag |= AGRP_ACTIVE;
201     else
202       grp->flag &= ~AGRP_ACTIVE;
203   }
204 }
205
206 /* Sync colors used for action/bone group with theme settings */
207 void action_group_colors_sync(bActionGroup *grp, const bActionGroup *ref_grp)
208 {
209   /* only do color copying if using a custom color (i.e. not default color)  */
210   if (grp->customCol) {
211     if (grp->customCol > 0) {
212       /* copy theme colors on-to group's custom color in case user tries to edit color */
213       bTheme *btheme = U.themes.first;
214       ThemeWireColor *col_set = &btheme->tarm[(grp->customCol - 1)];
215
216       memcpy(&grp->cs, col_set, sizeof(ThemeWireColor));
217     }
218     else {
219       /* if a reference group is provided, use the custom color from there... */
220       if (ref_grp) {
221         /* assumption: reference group has a color set */
222         memcpy(&grp->cs, &ref_grp->cs, sizeof(ThemeWireColor));
223       }
224       /* otherwise, init custom color with a generic/placeholder color set if
225        * no previous theme color was used that we can just keep using
226        */
227       else if (grp->cs.solid[0] == 0) {
228         /* define for setting colors in theme below */
229         rgba_char_args_set(grp->cs.solid, 0xff, 0x00, 0x00, 255);
230         rgba_char_args_set(grp->cs.select, 0x81, 0xe6, 0x14, 255);
231         rgba_char_args_set(grp->cs.active, 0x18, 0xb6, 0xe0, 255);
232       }
233     }
234   }
235 }
236
237 /* Add a new action group with the given name to the action */
238 bActionGroup *action_groups_add_new(bAction *act, const char name[])
239 {
240   bActionGroup *agrp;
241
242   /* sanity check: must have action and name */
243   if (ELEM(NULL, act, name))
244     return NULL;
245
246   /* allocate a new one */
247   agrp = MEM_callocN(sizeof(bActionGroup), "bActionGroup");
248
249   /* make it selected, with default name */
250   agrp->flag = AGRP_SELECTED;
251   BLI_strncpy(agrp->name, name[0] ? name : DATA_("Group"), sizeof(agrp->name));
252
253   /* add to action, and validate */
254   BLI_addtail(&act->groups, agrp);
255   BLI_uniquename(
256       &act->groups, agrp, DATA_("Group"), '.', offsetof(bActionGroup, name), sizeof(agrp->name));
257
258   /* return the new group */
259   return agrp;
260 }
261
262 /* Add given channel into (active) group
263  * - assumes that channel is not linked to anything anymore
264  * - always adds at the end of the group
265  */
266 void action_groups_add_channel(bAction *act, bActionGroup *agrp, FCurve *fcurve)
267 {
268   /* sanity checks */
269   if (ELEM(NULL, act, agrp, fcurve))
270     return;
271
272   /* if no channels anywhere, just add to two lists at the same time */
273   if (BLI_listbase_is_empty(&act->curves)) {
274     fcurve->next = fcurve->prev = NULL;
275
276     agrp->channels.first = agrp->channels.last = fcurve;
277     act->curves.first = act->curves.last = fcurve;
278   }
279
280   /* if the group already has channels, the F-Curve can simply be added to the list
281    * (i.e. as the last channel in the group)
282    */
283   else if (agrp->channels.first) {
284     /* if the group's last F-Curve is the action's last F-Curve too,
285      * then set the F-Curve as the last for the action first so that
286      * the lists will be in sync after linking
287      */
288     if (agrp->channels.last == act->curves.last)
289       act->curves.last = fcurve;
290
291     /* link in the given F-Curve after the last F-Curve in the group,
292      * which means that it should be able to fit in with the rest of the
293      * list seamlessly
294      */
295     BLI_insertlinkafter(&agrp->channels, agrp->channels.last, fcurve);
296   }
297
298   /* otherwise, need to find the nearest F-Curve in group before/after current to link with */
299   else {
300     bActionGroup *grp;
301
302     /* firstly, link this F-Curve to the group */
303     agrp->channels.first = agrp->channels.last = fcurve;
304
305     /* step through the groups preceding this one, finding the F-Curve there to attach this one after */
306     for (grp = agrp->prev; grp; grp = grp->prev) {
307       /* if this group has F-Curves, we want weave the given one in right after the last channel there,
308        * but via the Action's list not this group's list
309        * - this is so that the F-Curve is in the right place in the Action,
310        *   but won't be included in the previous group
311        */
312       if (grp->channels.last) {
313         /* once we've added, break here since we don't need to search any further... */
314         BLI_insertlinkafter(&act->curves, grp->channels.last, fcurve);
315         break;
316       }
317     }
318
319     /* if grp is NULL, that means we fell through, and this F-Curve should be added as the new first
320      * since group is (effectively) the first group. Thus, the existing first F-Curve becomes the
321      * second in the chain, etc. etc.
322      */
323     if (grp == NULL)
324       BLI_insertlinkbefore(&act->curves, act->curves.first, fcurve);
325   }
326
327   /* set the F-Curve's new group */
328   fcurve->grp = agrp;
329 }
330
331 /* Remove the given channel from all groups */
332 void action_groups_remove_channel(bAction *act, FCurve *fcu)
333 {
334   /* sanity checks */
335   if (ELEM(NULL, act, fcu))
336     return;
337
338   /* check if any group used this directly */
339   if (fcu->grp) {
340     bActionGroup *agrp = fcu->grp;
341
342     if (agrp->channels.first == agrp->channels.last) {
343       if (agrp->channels.first == fcu) {
344         BLI_listbase_clear(&agrp->channels);
345       }
346     }
347     else if (agrp->channels.first == fcu) {
348       if ((fcu->next) && (fcu->next->grp == agrp))
349         agrp->channels.first = fcu->next;
350       else
351         agrp->channels.first = NULL;
352     }
353     else if (agrp->channels.last == fcu) {
354       if ((fcu->prev) && (fcu->prev->grp == agrp))
355         agrp->channels.last = fcu->prev;
356       else
357         agrp->channels.last = NULL;
358     }
359
360     fcu->grp = NULL;
361   }
362
363   /* now just remove from list */
364   BLI_remlink(&act->curves, fcu);
365 }
366
367 /* Find a group with the given name */
368 bActionGroup *BKE_action_group_find_name(bAction *act, const char name[])
369 {
370   /* sanity checks */
371   if (ELEM(NULL, act, act->groups.first, name) || (name[0] == 0))
372     return NULL;
373
374   /* do string comparisons */
375   return BLI_findstring(&act->groups, name, offsetof(bActionGroup, name));
376 }
377
378 /* Clear all 'temp' flags on all groups */
379 void action_groups_clear_tempflags(bAction *act)
380 {
381   bActionGroup *agrp;
382
383   /* sanity checks */
384   if (ELEM(NULL, act, act->groups.first))
385     return;
386
387   /* flag clearing loop */
388   for (agrp = act->groups.first; agrp; agrp = agrp->next)
389     agrp->flag &= ~AGRP_TEMP;
390 }
391
392 /* *************** Pose channels *************** */
393
394 /**
395  * Return a pointer to the pose channel of the given name
396  * from this pose.
397  */
398 bPoseChannel *BKE_pose_channel_find_name(const bPose *pose, const char *name)
399 {
400   if (ELEM(NULL, pose, name) || (name[0] == '\0'))
401     return NULL;
402
403   if (pose->chanhash)
404     return BLI_ghash_lookup(pose->chanhash, (const void *)name);
405
406   return BLI_findstring(&((const bPose *)pose)->chanbase, name, offsetof(bPoseChannel, name));
407 }
408
409 /**
410  * Looks to see if the channel with the given name
411  * already exists in this pose - if not a new one is
412  * allocated and initialized.
413  *
414  * \note Use with care, not on Armature poses but for temporal ones.
415  * \note (currently used for action constraints and in rebuild_pose).
416  */
417 bPoseChannel *BKE_pose_channel_verify(bPose *pose, const char *name)
418 {
419   bPoseChannel *chan;
420
421   if (pose == NULL)
422     return NULL;
423
424   /* See if this channel exists */
425   chan = BKE_pose_channel_find_name(pose, name);
426   if (chan) {
427     return chan;
428   }
429
430   /* If not, create it and add it */
431   chan = MEM_callocN(sizeof(bPoseChannel), "verifyPoseChannel");
432
433   BLI_strncpy(chan->name, name, sizeof(chan->name));
434
435   chan->custom_scale = 1.0f;
436
437   /* init vars to prevent math errors */
438   unit_qt(chan->quat);
439   unit_axis_angle(chan->rotAxis, &chan->rotAngle);
440   chan->size[0] = chan->size[1] = chan->size[2] = 1.0f;
441
442   chan->scaleIn = chan->scaleOut = 1.0f;
443
444   chan->limitmin[0] = chan->limitmin[1] = chan->limitmin[2] = -M_PI;
445   chan->limitmax[0] = chan->limitmax[1] = chan->limitmax[2] = M_PI;
446   chan->stiffness[0] = chan->stiffness[1] = chan->stiffness[2] = 0.0f;
447   chan->ikrotweight = chan->iklinweight = 0.0f;
448   unit_m4(chan->constinv);
449
450   chan->protectflag = OB_LOCK_ROT4D; /* lock by components by default */
451
452   BLI_addtail(&pose->chanbase, chan);
453   if (pose->chanhash) {
454     BLI_ghash_insert(pose->chanhash, chan->name, chan);
455   }
456
457   return chan;
458 }
459
460 #ifndef NDEBUG
461 bool BKE_pose_channels_is_valid(const bPose *pose)
462 {
463   if (pose->chanhash) {
464     bPoseChannel *pchan;
465     for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
466       if (BLI_ghash_lookup(pose->chanhash, pchan->name) != pchan) {
467         return false;
468       }
469     }
470   }
471
472   return true;
473 }
474
475 #endif
476
477 /**
478  * Find the active posechannel for an object (we can't just use pose, as layer info is in armature)
479  *
480  * \note: Object, not bPose is used here, as we need layer info from Armature)
481  */
482 bPoseChannel *BKE_pose_channel_active(Object *ob)
483 {
484   bArmature *arm = (ob) ? ob->data : NULL;
485   bPoseChannel *pchan;
486
487   if (ELEM(NULL, ob, ob->pose, arm)) {
488     return NULL;
489   }
490
491   /* find active */
492   for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
493     if ((pchan->bone) && (pchan->bone == arm->act_bone) && (pchan->bone->layer & arm->layer))
494       return pchan;
495   }
496
497   return NULL;
498 }
499
500 /**
501  * \see #ED_armature_ebone_get_mirrored (edit-mode, matching function)
502  */
503 bPoseChannel *BKE_pose_channel_get_mirrored(const bPose *pose, const char *name)
504 {
505   char name_flip[MAXBONENAME];
506
507   BLI_string_flip_side_name(name_flip, name, false, sizeof(name_flip));
508
509   if (!STREQ(name_flip, name)) {
510     return BKE_pose_channel_find_name(pose, name_flip);
511   }
512
513   return NULL;
514 }
515
516 const char *BKE_pose_ikparam_get_name(bPose *pose)
517 {
518   if (pose) {
519     switch (pose->iksolver) {
520       case IKSOLVER_STANDARD:
521         return NULL;
522       case IKSOLVER_ITASC:
523         return "bItasc";
524     }
525   }
526   return NULL;
527 }
528
529 /**
530  * Allocate a new pose on the heap, and copy the src pose and it's channels
531  * into the new pose. *dst is set to the newly allocated structure, and assumed to be NULL.
532  *
533  * \param dst: Should be freed already, makes entire duplicate.
534  */
535 void BKE_pose_copy_data_ex(bPose **dst,
536                            const bPose *src,
537                            const int flag,
538                            const bool copy_constraints)
539 {
540   bPose *outPose;
541   bPoseChannel *pchan;
542   ListBase listb;
543
544   if (!src) {
545     *dst = NULL;
546     return;
547   }
548
549   outPose = MEM_callocN(sizeof(bPose), "pose");
550
551   BLI_duplicatelist(&outPose->chanbase, &src->chanbase);
552
553   /* Rebuild ghash here too, so that name lookups below won't be too bad...
554    * BUT this will have the penalty that the ghash will be built twice
555    * if BKE_pose_rebuild() gets called after this...
556    */
557   if (outPose->chanbase.first != outPose->chanbase.last) {
558     outPose->chanhash = NULL;
559     BKE_pose_channels_hash_make(outPose);
560   }
561
562   outPose->iksolver = src->iksolver;
563   outPose->ikdata = NULL;
564   outPose->ikparam = MEM_dupallocN(src->ikparam);
565   outPose->avs = src->avs;
566
567   for (pchan = outPose->chanbase.first; pchan; pchan = pchan->next) {
568     if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
569       id_us_plus((ID *)pchan->custom);
570     }
571
572     /* warning, O(n2) here, if done without the hash, but these are rarely used features. */
573     if (pchan->custom_tx) {
574       pchan->custom_tx = BKE_pose_channel_find_name(outPose, pchan->custom_tx->name);
575     }
576     if (pchan->bbone_prev) {
577       pchan->bbone_prev = BKE_pose_channel_find_name(outPose, pchan->bbone_prev->name);
578     }
579     if (pchan->bbone_next) {
580       pchan->bbone_next = BKE_pose_channel_find_name(outPose, pchan->bbone_next->name);
581     }
582
583     if (copy_constraints) {
584       BKE_constraints_copy_ex(
585           &listb, &pchan->constraints, flag, true);  // BKE_constraints_copy NULLs listb
586       pchan->constraints = listb;
587
588       /* XXX: This is needed for motionpath drawing to work. Dunno why it was setting to null before... */
589       pchan->mpath = animviz_copy_motionpath(pchan->mpath);
590     }
591
592     if (pchan->prop) {
593       pchan->prop = IDP_CopyProperty_ex(pchan->prop, flag);
594     }
595
596     pchan->draw_data = NULL; /* Drawing cache, no need to copy. */
597
598     /* Runtime data, no need to copy. */
599     memset(&pchan->runtime, 0, sizeof(pchan->runtime));
600   }
601
602   /* for now, duplicate Bone Groups too when doing this */
603   if (copy_constraints) {
604     BLI_duplicatelist(&outPose->agroups, &src->agroups);
605   }
606
607   *dst = outPose;
608 }
609
610 void BKE_pose_copy_data(bPose **dst, const bPose *src, const bool copy_constraints)
611 {
612   BKE_pose_copy_data_ex(dst, src, 0, copy_constraints);
613 }
614
615 void BKE_pose_itasc_init(bItasc *itasc)
616 {
617   if (itasc) {
618     itasc->iksolver = IKSOLVER_ITASC;
619     itasc->minstep = 0.01f;
620     itasc->maxstep = 0.06f;
621     itasc->numiter = 100;
622     itasc->numstep = 4;
623     itasc->precision = 0.005f;
624     itasc->flag = ITASC_AUTO_STEP | ITASC_INITIAL_REITERATION;
625     itasc->feedback = 20.0f;
626     itasc->maxvel = 50.0f;
627     itasc->solver = ITASC_SOLVER_SDLS;
628     itasc->dampmax = 0.5;
629     itasc->dampeps = 0.15;
630   }
631 }
632 void BKE_pose_ikparam_init(bPose *pose)
633 {
634   bItasc *itasc;
635   switch (pose->iksolver) {
636     case IKSOLVER_ITASC:
637       itasc = MEM_callocN(sizeof(bItasc), "itasc");
638       BKE_pose_itasc_init(itasc);
639       pose->ikparam = itasc;
640       break;
641     case IKSOLVER_STANDARD:
642     default:
643       pose->ikparam = NULL;
644       break;
645   }
646 }
647
648 /* only for real IK, not for auto-IK */
649 static bool pose_channel_in_IK_chain(Object *ob, bPoseChannel *pchan, int level)
650 {
651   bConstraint *con;
652   Bone *bone;
653
654   /* No need to check if constraint is active (has influence),
655    * since all constraints with CONSTRAINT_IK_AUTO are active */
656   for (con = pchan->constraints.first; con; con = con->next) {
657     if (con->type == CONSTRAINT_TYPE_KINEMATIC) {
658       bKinematicConstraint *data = con->data;
659       if ((data->rootbone == 0) || (data->rootbone > level)) {
660         if ((data->flag & CONSTRAINT_IK_AUTO) == 0)
661           return true;
662       }
663     }
664   }
665   for (bone = pchan->bone->childbase.first; bone; bone = bone->next) {
666     pchan = BKE_pose_channel_find_name(ob->pose, bone->name);
667     if (pchan && pose_channel_in_IK_chain(ob, pchan, level + 1))
668       return true;
669   }
670   return false;
671 }
672
673 bool BKE_pose_channel_in_IK_chain(Object *ob, bPoseChannel *pchan)
674 {
675   return pose_channel_in_IK_chain(ob, pchan, 0);
676 }
677
678 /**
679  * Removes the hash for quick lookup of channels, must
680  * be done when adding/removing channels.
681  */
682 void BKE_pose_channels_hash_make(bPose *pose)
683 {
684   if (!pose->chanhash) {
685     bPoseChannel *pchan;
686
687     pose->chanhash = BLI_ghash_str_new("make_pose_chan gh");
688     for (pchan = pose->chanbase.first; pchan; pchan = pchan->next)
689       BLI_ghash_insert(pose->chanhash, pchan->name, pchan);
690   }
691 }
692
693 void BKE_pose_channels_hash_free(bPose *pose)
694 {
695   if (pose->chanhash) {
696     BLI_ghash_free(pose->chanhash, NULL, NULL);
697     pose->chanhash = NULL;
698   }
699 }
700
701 /**
702  * Selectively remove pose channels.
703  */
704 void BKE_pose_channels_remove(Object *ob,
705                               bool (*filter_fn)(const char *bone_name, void *user_data),
706                               void *user_data)
707 {
708   /* Erase any associated pose channel, along with any references to them */
709   if (ob->pose) {
710     bPoseChannel *pchan, *pchan_next;
711     bConstraint *con;
712
713     for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan_next) {
714       pchan_next = pchan->next;
715
716       if (filter_fn(pchan->name, user_data)) {
717         /* Bone itself is being removed */
718         BKE_pose_channel_free(pchan);
719         if (ob->pose->chanhash) {
720           BLI_ghash_remove(ob->pose->chanhash, pchan->name, NULL, NULL);
721         }
722         BLI_freelinkN(&ob->pose->chanbase, pchan);
723       }
724       else {
725         /* Maybe something the bone references is being removed instead? */
726         for (con = pchan->constraints.first; con; con = con->next) {
727           const bConstraintTypeInfo *cti = BKE_constraint_typeinfo_get(con);
728           ListBase targets = {NULL, NULL};
729           bConstraintTarget *ct;
730
731           if (cti && cti->get_constraint_targets) {
732             cti->get_constraint_targets(con, &targets);
733
734             for (ct = targets.first; ct; ct = ct->next) {
735               if (ct->tar == ob) {
736                 if (ct->subtarget[0]) {
737                   if (filter_fn(ct->subtarget, user_data)) {
738                     con->flag |= CONSTRAINT_DISABLE;
739                     ct->subtarget[0] = 0;
740                   }
741                 }
742               }
743             }
744
745             if (cti->flush_constraint_targets)
746               cti->flush_constraint_targets(con, &targets, 0);
747           }
748         }
749
750         if (pchan->bbone_prev) {
751           if (filter_fn(pchan->bbone_prev->name, user_data))
752             pchan->bbone_prev = NULL;
753         }
754         if (pchan->bbone_next) {
755           if (filter_fn(pchan->bbone_next->name, user_data))
756             pchan->bbone_next = NULL;
757         }
758
759         if (pchan->custom_tx) {
760           if (filter_fn(pchan->custom_tx->name, user_data))
761             pchan->custom_tx = NULL;
762         }
763       }
764     }
765   }
766 }
767
768 /**
769  * Deallocates a pose channel.
770  * Does not free the pose channel itself.
771  */
772 void BKE_pose_channel_free_ex(bPoseChannel *pchan, bool do_id_user)
773 {
774   if (pchan->custom) {
775     if (do_id_user) {
776       id_us_min(&pchan->custom->id);
777     }
778     pchan->custom = NULL;
779   }
780
781   if (pchan->mpath) {
782     animviz_free_motionpath(pchan->mpath);
783     pchan->mpath = NULL;
784   }
785
786   BKE_constraints_free_ex(&pchan->constraints, do_id_user);
787
788   if (pchan->prop) {
789     IDP_FreeProperty(pchan->prop);
790     MEM_freeN(pchan->prop);
791   }
792
793   /* Cached data, for new draw manager rendering code. */
794   MEM_SAFE_FREE(pchan->draw_data);
795
796   /* Cached B-Bone shape data. */
797   BKE_pose_channel_free_bbone_cache(pchan);
798 }
799
800 /** Deallocates runtime cache of a pose channel's B-Bone shape. */
801 void BKE_pose_channel_free_bbone_cache(bPoseChannel *pchan)
802 {
803   bPoseChannel_Runtime *runtime = &pchan->runtime;
804
805   runtime->bbone_segments = 0;
806   MEM_SAFE_FREE(runtime->bbone_rest_mats);
807   MEM_SAFE_FREE(runtime->bbone_pose_mats);
808   MEM_SAFE_FREE(runtime->bbone_deform_mats);
809   MEM_SAFE_FREE(runtime->bbone_dual_quats);
810 }
811
812 void BKE_pose_channel_free(bPoseChannel *pchan)
813 {
814   BKE_pose_channel_free_ex(pchan, true);
815 }
816
817 /**
818  * Removes and deallocates all channels from a pose.
819  * Does not free the pose itself.
820  */
821 void BKE_pose_channels_free_ex(bPose *pose, bool do_id_user)
822 {
823   bPoseChannel *pchan;
824
825   if (pose->chanbase.first) {
826     for (pchan = pose->chanbase.first; pchan; pchan = pchan->next)
827       BKE_pose_channel_free_ex(pchan, do_id_user);
828
829     BLI_freelistN(&pose->chanbase);
830   }
831
832   BKE_pose_channels_hash_free(pose);
833
834   MEM_SAFE_FREE(pose->chan_array);
835 }
836
837 void BKE_pose_channels_free(bPose *pose)
838 {
839   BKE_pose_channels_free_ex(pose, true);
840 }
841
842 void BKE_pose_free_data_ex(bPose *pose, bool do_id_user)
843 {
844   /* free pose-channels */
845   BKE_pose_channels_free_ex(pose, do_id_user);
846
847   /* free pose-groups */
848   if (pose->agroups.first)
849     BLI_freelistN(&pose->agroups);
850
851   /* free IK solver state */
852   BIK_clear_data(pose);
853
854   /* free IK solver param */
855   if (pose->ikparam)
856     MEM_freeN(pose->ikparam);
857 }
858
859 void BKE_pose_free_data(bPose *pose)
860 {
861   BKE_pose_free_data_ex(pose, true);
862 }
863
864 /**
865  * Removes and deallocates all data from a pose, and also frees the pose.
866  */
867 void BKE_pose_free_ex(bPose *pose, bool do_id_user)
868 {
869   if (pose) {
870     BKE_pose_free_data_ex(pose, do_id_user);
871     /* free pose */
872     MEM_freeN(pose);
873   }
874 }
875
876 void BKE_pose_free(bPose *pose)
877 {
878   BKE_pose_free_ex(pose, true);
879 }
880
881 /**
882  * Copy the internal members of each pose channel including constraints
883  * and ID-Props, used when duplicating bones in editmode.
884  * (unlike copy_pose_channel_data which only does posing-related stuff).
885  *
886  * \note use when copying bones in editmode (on returned value from #BKE_pose_channel_verify)
887  */
888 void BKE_pose_channel_copy_data(bPoseChannel *pchan, const bPoseChannel *pchan_from)
889 {
890   /* copy transform locks */
891   pchan->protectflag = pchan_from->protectflag;
892
893   /* copy rotation mode */
894   pchan->rotmode = pchan_from->rotmode;
895
896   /* copy bone group */
897   pchan->agrp_index = pchan_from->agrp_index;
898
899   /* ik (dof) settings */
900   pchan->ikflag = pchan_from->ikflag;
901   copy_v3_v3(pchan->limitmin, pchan_from->limitmin);
902   copy_v3_v3(pchan->limitmax, pchan_from->limitmax);
903   copy_v3_v3(pchan->stiffness, pchan_from->stiffness);
904   pchan->ikstretch = pchan_from->ikstretch;
905   pchan->ikrotweight = pchan_from->ikrotweight;
906   pchan->iklinweight = pchan_from->iklinweight;
907
908   /* bbone settings (typically not animated) */
909   pchan->bbone_next = pchan_from->bbone_next;
910   pchan->bbone_prev = pchan_from->bbone_prev;
911
912   /* constraints */
913   BKE_constraints_copy(&pchan->constraints, &pchan_from->constraints, true);
914
915   /* id-properties */
916   if (pchan->prop) {
917     /* unlikely but possible it exists */
918     IDP_FreeProperty(pchan->prop);
919     MEM_freeN(pchan->prop);
920     pchan->prop = NULL;
921   }
922   if (pchan_from->prop) {
923     pchan->prop = IDP_CopyProperty(pchan_from->prop);
924   }
925
926   /* custom shape */
927   pchan->custom = pchan_from->custom;
928   if (pchan->custom) {
929     id_us_plus(&pchan->custom->id);
930   }
931
932   pchan->custom_scale = pchan_from->custom_scale;
933 }
934
935 /* checks for IK constraint, Spline IK, and also for Follow-Path constraint.
936  * can do more constraints flags later
937  */
938 /* pose should be entirely OK */
939 void BKE_pose_update_constraint_flags(bPose *pose)
940 {
941   bPoseChannel *pchan, *parchan;
942   bConstraint *con;
943
944   /* clear */
945   for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
946     pchan->constflag = 0;
947   }
948   pose->flag &= ~POSE_CONSTRAINTS_TIMEDEPEND;
949
950   /* detect */
951   for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
952     for (con = pchan->constraints.first; con; con = con->next) {
953       if (con->type == CONSTRAINT_TYPE_KINEMATIC) {
954         bKinematicConstraint *data = (bKinematicConstraint *)con->data;
955
956         pchan->constflag |= PCHAN_HAS_IK;
957
958         if (data->tar == NULL || (data->tar->type == OB_ARMATURE && data->subtarget[0] == 0))
959           pchan->constflag |= PCHAN_HAS_TARGET;
960
961         /* negative rootbone = recalc rootbone index. used in do_versions */
962         if (data->rootbone < 0) {
963           data->rootbone = 0;
964
965           if (data->flag & CONSTRAINT_IK_TIP)
966             parchan = pchan;
967           else
968             parchan = pchan->parent;
969
970           while (parchan) {
971             data->rootbone++;
972             if ((parchan->bone->flag & BONE_CONNECTED) == 0)
973               break;
974             parchan = parchan->parent;
975           }
976         }
977       }
978       else if (con->type == CONSTRAINT_TYPE_FOLLOWPATH) {
979         bFollowPathConstraint *data = (bFollowPathConstraint *)con->data;
980
981         /* for drawing constraint colors when color set allows this */
982         pchan->constflag |= PCHAN_HAS_CONST;
983
984         /* if we have a valid target, make sure that this will get updated on frame-change
985          * (needed for when there is no anim-data for this pose)
986          */
987         if ((data->tar) && (data->tar->type == OB_CURVE))
988           pose->flag |= POSE_CONSTRAINTS_TIMEDEPEND;
989       }
990       else if (con->type == CONSTRAINT_TYPE_SPLINEIK)
991         pchan->constflag |= PCHAN_HAS_SPLINEIK;
992       else
993         pchan->constflag |= PCHAN_HAS_CONST;
994     }
995   }
996   pose->flag &= ~POSE_CONSTRAINTS_NEED_UPDATE_FLAGS;
997 }
998
999 void BKE_pose_tag_update_constraint_flags(bPose *pose)
1000 {
1001   pose->flag |= POSE_CONSTRAINTS_NEED_UPDATE_FLAGS;
1002 }
1003
1004 /* Clears all BONE_UNKEYED flags for every pose channel in every pose
1005  * This should only be called on frame changing, when it is acceptable to
1006  * do this. Otherwise, these flags should not get cleared as poses may get lost.
1007  */
1008 void framechange_poses_clear_unkeyed(Main *bmain)
1009 {
1010   Object *ob;
1011   bPose *pose;
1012   bPoseChannel *pchan;
1013
1014   /* This needs to be done for each object that has a pose */
1015   /* TODO: proxies may/may not be correctly handled here... (this needs checking) */
1016   for (ob = bmain->objects.first; ob; ob = ob->id.next) {
1017     /* we only need to do this on objects with a pose */
1018     if ((pose = ob->pose)) {
1019       for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
1020         if (pchan->bone)
1021           pchan->bone->flag &= ~BONE_UNKEYED;
1022       }
1023     }
1024   }
1025 }
1026
1027 /* ************************** Bone Groups ************************** */
1028
1029 /* Adds a new bone-group (name may be NULL) */
1030 bActionGroup *BKE_pose_add_group(bPose *pose, const char *name)
1031 {
1032   bActionGroup *grp;
1033
1034   if (!name) {
1035     name = DATA_("Group");
1036   }
1037
1038   grp = MEM_callocN(sizeof(bActionGroup), "PoseGroup");
1039   BLI_strncpy(grp->name, name, sizeof(grp->name));
1040   BLI_addtail(&pose->agroups, grp);
1041   BLI_uniquename(&pose->agroups, grp, name, '.', offsetof(bActionGroup, name), sizeof(grp->name));
1042
1043   pose->active_group = BLI_listbase_count(&pose->agroups);
1044
1045   return grp;
1046 }
1047
1048 /* Remove the given bone-group (expects 'virtual' index (+1 one, used by active_group etc.))
1049  * index might be invalid ( < 1), in which case it will be find from grp. */
1050 void BKE_pose_remove_group(bPose *pose, bActionGroup *grp, const int index)
1051 {
1052   bPoseChannel *pchan;
1053   int idx = index;
1054
1055   if (idx < 1) {
1056     idx = BLI_findindex(&pose->agroups, grp) + 1;
1057   }
1058
1059   BLI_assert(idx > 0);
1060
1061   /* adjust group references (the trouble of using indices!):
1062    * - firstly, make sure nothing references it
1063    * - also, make sure that those after this item get corrected
1064    */
1065   for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
1066     if (pchan->agrp_index == idx)
1067       pchan->agrp_index = 0;
1068     else if (pchan->agrp_index > idx)
1069       pchan->agrp_index--;
1070   }
1071
1072   /* now, remove it from the pose */
1073   BLI_freelinkN(&pose->agroups, grp);
1074   if (pose->active_group >= idx) {
1075     const bool has_groups = !BLI_listbase_is_empty(&pose->agroups);
1076     pose->active_group--;
1077     if (pose->active_group == 0 && has_groups) {
1078       pose->active_group = 1;
1079     }
1080     else if (pose->active_group < 0 || !has_groups) {
1081       pose->active_group = 0;
1082     }
1083   }
1084 }
1085
1086 /* Remove the indexed bone-group (expects 'virtual' index (+1 one, used by active_group etc.)) */
1087 void BKE_pose_remove_group_index(bPose *pose, const int index)
1088 {
1089   bActionGroup *grp = NULL;
1090
1091   /* get group to remove */
1092   grp = BLI_findlink(&pose->agroups, index - 1);
1093   if (grp) {
1094     BKE_pose_remove_group(pose, grp, index);
1095   }
1096 }
1097
1098 /* ************** F-Curve Utilities for Actions ****************** */
1099
1100 /* Check if the given action has any keyframes */
1101 bool action_has_motion(const bAction *act)
1102 {
1103   FCurve *fcu;
1104
1105   /* return on the first F-Curve that has some keyframes/samples defined */
1106   if (act) {
1107     for (fcu = act->curves.first; fcu; fcu = fcu->next) {
1108       if (fcu->totvert)
1109         return true;
1110     }
1111   }
1112
1113   /* nothing found */
1114   return false;
1115 }
1116
1117 /* Calculate the extents of given action */
1118 void calc_action_range(const bAction *act, float *start, float *end, short incl_modifiers)
1119 {
1120   FCurve *fcu;
1121   float min = 999999999.0f, max = -999999999.0f;
1122   short foundvert = 0, foundmod = 0;
1123
1124   if (act) {
1125     for (fcu = act->curves.first; fcu; fcu = fcu->next) {
1126       /* if curve has keyframes, consider them first */
1127       if (fcu->totvert) {
1128         float nmin, nmax;
1129
1130         /* get extents for this curve
1131          * - no "selected only", since this is often used in the backend
1132          * - no "minimum length" (we will apply this later), otherwise
1133          *   single-keyframe curves will increase the overall length by
1134          *   a phantom frame (T50354)
1135          */
1136         calc_fcurve_range(fcu, &nmin, &nmax, false, false);
1137
1138         /* compare to the running tally */
1139         min = min_ff(min, nmin);
1140         max = max_ff(max, nmax);
1141
1142         foundvert = 1;
1143       }
1144
1145       /* if incl_modifiers is enabled, need to consider modifiers too
1146        * - only really care about the last modifier
1147        */
1148       if ((incl_modifiers) && (fcu->modifiers.last)) {
1149         FModifier *fcm = fcu->modifiers.last;
1150
1151         /* only use the maximum sensible limits of the modifiers if they are more extreme */
1152         switch (fcm->type) {
1153           case FMODIFIER_TYPE_LIMITS: /* Limits F-Modifier */
1154           {
1155             FMod_Limits *fmd = (FMod_Limits *)fcm->data;
1156
1157             if (fmd->flag & FCM_LIMIT_XMIN) {
1158               min = min_ff(min, fmd->rect.xmin);
1159             }
1160             if (fmd->flag & FCM_LIMIT_XMAX) {
1161               max = max_ff(max, fmd->rect.xmax);
1162             }
1163             break;
1164           }
1165           case FMODIFIER_TYPE_CYCLES: /* Cycles F-Modifier */
1166           {
1167             FMod_Cycles *fmd = (FMod_Cycles *)fcm->data;
1168
1169             if (fmd->before_mode != FCM_EXTRAPOLATE_NONE)
1170               min = MINAFRAMEF;
1171             if (fmd->after_mode != FCM_EXTRAPOLATE_NONE)
1172               max = MAXFRAMEF;
1173             break;
1174           }
1175             /* TODO: function modifier may need some special limits */
1176
1177           default: /* all other standard modifiers are on the infinite range... */
1178             min = MINAFRAMEF;
1179             max = MAXFRAMEF;
1180             break;
1181         }
1182
1183         foundmod = 1;
1184       }
1185     }
1186   }
1187
1188   if (foundvert || foundmod) {
1189     /* ensure that action is at least 1 frame long (for NLA strips to have a valid length) */
1190     if (min == max)
1191       max += 1.0f;
1192
1193     *start = min;
1194     *end = max;
1195   }
1196   else {
1197     *start = 0.0f;
1198     *end = 1.0f;
1199   }
1200 }
1201
1202 /* Return flags indicating which transforms the given object/posechannel has
1203  * - if 'curves' is provided, a list of links to these curves are also returned
1204  */
1205 short action_get_item_transforms(bAction *act, Object *ob, bPoseChannel *pchan, ListBase *curves)
1206 {
1207   PointerRNA ptr;
1208   FCurve *fcu;
1209   char *basePath = NULL;
1210   short flags = 0;
1211
1212   /* build PointerRNA from provided data to obtain the paths to use */
1213   if (pchan)
1214     RNA_pointer_create((ID *)ob, &RNA_PoseBone, pchan, &ptr);
1215   else if (ob)
1216     RNA_id_pointer_create((ID *)ob, &ptr);
1217   else
1218     return 0;
1219
1220   /* get the basic path to the properties of interest */
1221   basePath = RNA_path_from_ID_to_struct(&ptr);
1222   if (basePath == NULL)
1223     return 0;
1224
1225   /* search F-Curves for the given properties
1226    * - we cannot use the groups, since they may not be grouped in that way...
1227    */
1228   for (fcu = act->curves.first; fcu; fcu = fcu->next) {
1229     const char *bPtr = NULL, *pPtr = NULL;
1230
1231     /* if enough flags have been found, we can stop checking unless we're also getting the curves */
1232     if ((flags == ACT_TRANS_ALL) && (curves == NULL))
1233       break;
1234
1235     /* just in case... */
1236     if (fcu->rna_path == NULL)
1237       continue;
1238
1239     /* step 1: check for matching base path */
1240     bPtr = strstr(fcu->rna_path, basePath);
1241
1242     if (bPtr) {
1243       /* we must add len(basePath) bytes to the match so that we are at the end of the
1244        * base path so that we don't get false positives with these strings in the names
1245        */
1246       bPtr += strlen(basePath);
1247
1248       /* step 2: check for some property with transforms
1249        * - to speed things up, only check for the ones not yet found
1250        *   unless we're getting the curves too
1251        * - if we're getting the curves, the BLI_genericNodeN() creates a LinkData
1252        *   node wrapping the F-Curve, which then gets added to the list
1253        * - once a match has been found, the curve cannot possibly be any other one
1254        */
1255       if ((curves) || (flags & ACT_TRANS_LOC) == 0) {
1256         pPtr = strstr(bPtr, "location");
1257         if (pPtr) {
1258           flags |= ACT_TRANS_LOC;
1259
1260           if (curves)
1261             BLI_addtail(curves, BLI_genericNodeN(fcu));
1262           continue;
1263         }
1264       }
1265
1266       if ((curves) || (flags & ACT_TRANS_SCALE) == 0) {
1267         pPtr = strstr(bPtr, "scale");
1268         if (pPtr) {
1269           flags |= ACT_TRANS_SCALE;
1270
1271           if (curves)
1272             BLI_addtail(curves, BLI_genericNodeN(fcu));
1273           continue;
1274         }
1275       }
1276
1277       if ((curves) || (flags & ACT_TRANS_ROT) == 0) {
1278         pPtr = strstr(bPtr, "rotation");
1279         if (pPtr) {
1280           flags |= ACT_TRANS_ROT;
1281
1282           if (curves)
1283             BLI_addtail(curves, BLI_genericNodeN(fcu));
1284           continue;
1285         }
1286       }
1287
1288       if ((curves) || (flags & ACT_TRANS_BBONE) == 0) {
1289         /* bbone shape properties */
1290         pPtr = strstr(bPtr, "bbone_");
1291         if (pPtr) {
1292           flags |= ACT_TRANS_BBONE;
1293
1294           if (curves)
1295             BLI_addtail(curves, BLI_genericNodeN(fcu));
1296           continue;
1297         }
1298       }
1299
1300       if ((curves) || (flags & ACT_TRANS_PROP) == 0) {
1301         /* custom properties only */
1302         pPtr = strstr(
1303             bPtr,
1304             "[\""); /* extra '"' comment here to keep my texteditor functionlist working :) */
1305         if (pPtr) {
1306           flags |= ACT_TRANS_PROP;
1307
1308           if (curves)
1309             BLI_addtail(curves, BLI_genericNodeN(fcu));
1310           continue;
1311         }
1312       }
1313     }
1314   }
1315
1316   /* free basePath */
1317   MEM_freeN(basePath);
1318
1319   /* return flags found */
1320   return flags;
1321 }
1322
1323 /* ************** Pose Management Tools ****************** */
1324
1325 /* for do_all_pose_actions, clears the pose. Now also exported for proxy and tools */
1326 void BKE_pose_rest(bPose *pose)
1327 {
1328   bPoseChannel *pchan;
1329
1330   if (!pose)
1331     return;
1332
1333   memset(pose->stride_offset, 0, sizeof(pose->stride_offset));
1334   memset(pose->cyclic_offset, 0, sizeof(pose->cyclic_offset));
1335
1336   for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
1337     zero_v3(pchan->loc);
1338     zero_v3(pchan->eul);
1339     unit_qt(pchan->quat);
1340     unit_axis_angle(pchan->rotAxis, &pchan->rotAngle);
1341     pchan->size[0] = pchan->size[1] = pchan->size[2] = 1.0f;
1342
1343     pchan->roll1 = pchan->roll2 = 0.0f;
1344     pchan->curveInX = pchan->curveInY = 0.0f;
1345     pchan->curveOutX = pchan->curveOutY = 0.0f;
1346     pchan->ease1 = pchan->ease2 = 0.0f;
1347     pchan->scaleIn = pchan->scaleOut = 1.0f;
1348
1349     pchan->flag &= ~(POSE_LOC | POSE_ROT | POSE_SIZE | POSE_BBONE_SHAPE);
1350   }
1351 }
1352
1353 void BKE_pose_copyesult_pchan_result(bPoseChannel *pchanto, const bPoseChannel *pchanfrom)
1354 {
1355   copy_m4_m4(pchanto->pose_mat, pchanfrom->pose_mat);
1356   copy_m4_m4(pchanto->chan_mat, pchanfrom->chan_mat);
1357
1358   /* used for local constraints */
1359   copy_v3_v3(pchanto->loc, pchanfrom->loc);
1360   copy_qt_qt(pchanto->quat, pchanfrom->quat);
1361   copy_v3_v3(pchanto->eul, pchanfrom->eul);
1362   copy_v3_v3(pchanto->size, pchanfrom->size);
1363
1364   copy_v3_v3(pchanto->pose_head, pchanfrom->pose_head);
1365   copy_v3_v3(pchanto->pose_tail, pchanfrom->pose_tail);
1366
1367   pchanto->roll1 = pchanfrom->roll1;
1368   pchanto->roll2 = pchanfrom->roll2;
1369   pchanto->curveInX = pchanfrom->curveInX;
1370   pchanto->curveInY = pchanfrom->curveInY;
1371   pchanto->curveOutX = pchanfrom->curveOutX;
1372   pchanto->curveOutY = pchanfrom->curveOutY;
1373   pchanto->ease1 = pchanfrom->ease1;
1374   pchanto->ease2 = pchanfrom->ease2;
1375   pchanto->scaleIn = pchanfrom->scaleIn;
1376   pchanto->scaleOut = pchanfrom->scaleOut;
1377
1378   pchanto->rotmode = pchanfrom->rotmode;
1379   pchanto->flag = pchanfrom->flag;
1380   pchanto->protectflag = pchanfrom->protectflag;
1381 }
1382
1383 /* both poses should be in sync */
1384 bool BKE_pose_copy_result(bPose *to, bPose *from)
1385 {
1386   bPoseChannel *pchanto, *pchanfrom;
1387
1388   if (to == NULL || from == NULL) {
1389     CLOG_ERROR(
1390         &LOG, "Pose copy error, pose to:%p from:%p", (void *)to, (void *)from); /* debug temp */
1391     return false;
1392   }
1393
1394   if (to == from) {
1395     CLOG_ERROR(&LOG, "source and target are the same");
1396     return false;
1397   }
1398
1399   for (pchanfrom = from->chanbase.first; pchanfrom; pchanfrom = pchanfrom->next) {
1400     pchanto = BKE_pose_channel_find_name(to, pchanfrom->name);
1401     if (pchanto != NULL) {
1402       BKE_pose_copyesult_pchan_result(pchanto, pchanfrom);
1403     }
1404   }
1405   return true;
1406 }
1407
1408 /* Tag pose for recalc. Also tag all related data to be recalc. */
1409 void BKE_pose_tag_recalc(Main *bmain, bPose *pose)
1410 {
1411   pose->flag |= POSE_RECALC;
1412   /* Depsgraph components depends on actual pose state,
1413    * if pose was changed depsgraph is to be updated as well.
1414    */
1415   DEG_relations_tag_update(bmain);
1416 }
1417
1418 /* For the calculation of the effects of an Action at the given frame on an object
1419  * This is currently only used for the Action Constraint
1420  */
1421 void what_does_obaction(
1422     Object *ob, Object *workob, bPose *pose, bAction *act, char groupname[], float cframe)
1423 {
1424   bActionGroup *agrp = BKE_action_group_find_name(act, groupname);
1425
1426   /* clear workob */
1427   BKE_object_workob_clear(workob);
1428
1429   /* init workob */
1430   copy_m4_m4(workob->obmat, ob->obmat);
1431   copy_m4_m4(workob->parentinv, ob->parentinv);
1432   copy_m4_m4(workob->constinv, ob->constinv);
1433   workob->parent = ob->parent;
1434
1435   workob->rotmode = ob->rotmode;
1436
1437   workob->trackflag = ob->trackflag;
1438   workob->upflag = ob->upflag;
1439
1440   workob->partype = ob->partype;
1441   workob->par1 = ob->par1;
1442   workob->par2 = ob->par2;
1443   workob->par3 = ob->par3;
1444
1445   workob->constraints.first = ob->constraints.first;
1446   workob->constraints.last = ob->constraints.last;
1447
1448   workob->pose =
1449       pose; /* need to set pose too, since this is used for both types of Action Constraint */
1450   if (pose) {
1451     /* This function is most likely to be used with a temporary pose with a single bone in there.
1452      * For such cases it makes no sense to create hash since it'll only waste CPU ticks on memory
1453      * allocation and also will make lookup slower.
1454      */
1455     if (pose->chanbase.first != pose->chanbase.last) {
1456       BKE_pose_channels_hash_make(pose);
1457     }
1458     if (pose->flag & POSE_CONSTRAINTS_NEED_UPDATE_FLAGS) {
1459       BKE_pose_update_constraint_flags(pose);
1460     }
1461   }
1462
1463   BLI_strncpy(workob->parsubstr, ob->parsubstr, sizeof(workob->parsubstr));
1464   BLI_strncpy(
1465       workob->id.name,
1466       "OB<ConstrWorkOb>",
1467       sizeof(
1468           workob->id
1469               .name)); /* we don't use real object name, otherwise RNA screws with the real thing */
1470
1471   /* if we're given a group to use, it's likely to be more efficient (though a bit more dangerous) */
1472   if (agrp) {
1473     /* specifically evaluate this group only */
1474     PointerRNA id_ptr;
1475
1476     /* get RNA-pointer for the workob's ID */
1477     RNA_id_pointer_create(&workob->id, &id_ptr);
1478
1479     /* execute action for this group only */
1480     animsys_evaluate_action_group(&id_ptr, act, agrp, cframe);
1481   }
1482   else {
1483     AnimData adt = {NULL};
1484
1485     /* init animdata, and attach to workob */
1486     workob->adt = &adt;
1487
1488     adt.action = act;
1489
1490     /* execute effects of Action on to workob (or it's PoseChannels) */
1491     BKE_animsys_evaluate_animdata(NULL, NULL, &workob->id, &adt, cframe, ADT_RECALC_ANIM);
1492   }
1493 }