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