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