synched with trunk at revision 34793
[blender-staging.git] / source / blender / editors / armature / poseUtils.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009, Blender Foundation, Joshua Leung
21  * This is a new part of Blender
22  *
23  * Contributor(s): Joshua Leung
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <stddef.h>
31 #include <string.h>
32 #include <math.h>
33 #include <float.h>
34
35 #include "MEM_guardedalloc.h"
36
37 #include "BLI_math.h"
38 #include "BLI_blenlib.h"
39 #include "BLI_dynstr.h"
40 #include "BLI_dlrbTree.h"
41
42 #include "DNA_anim_types.h"
43 #include "DNA_armature_types.h"
44 #include "DNA_object_types.h"
45 #include "DNA_scene_types.h"
46
47 #include "BKE_action.h"
48 #include "BKE_armature.h"
49 #include "BKE_depsgraph.h"
50
51 #include "BKE_context.h"
52
53 #include "RNA_access.h"
54
55 #include "WM_api.h"
56 #include "WM_types.h"
57
58
59
60 #include "ED_armature.h"
61 #include "ED_keyframing.h"
62
63 #include "armature_intern.h"
64
65 /* *********************************************** */
66 /* Contents of this File:
67  *
68  * This file contains methods shared between Pose Slide and Pose Lib;
69  * primarily the functions in question concern Animato <-> Pose 
70  * convenience functions, such as applying/getting pose values
71  * and/or inserting keyframes for these.
72  */
73 /* *********************************************** */ 
74 /* FCurves <-> PoseChannels Links */
75
76 /* helper for poseAnim_mapping_get() -> get the relevant F-Curves per PoseChannel */
77 static void fcurves_to_pchan_links_get (ListBase *pfLinks, Object *ob, bAction *act, bPoseChannel *pchan)
78 {
79         ListBase curves = {NULL, NULL};
80         int transFlags = action_get_item_transforms(act, ob, pchan, &curves);
81         
82         pchan->flag &= ~(POSE_LOC|POSE_ROT|POSE_SIZE);
83         
84         /* check if any transforms found... */
85         if (transFlags) {
86                 /* make new linkage data */
87                 tPChanFCurveLink *pfl= MEM_callocN(sizeof(tPChanFCurveLink), "tPChanFCurveLink");
88                 PointerRNA ptr;
89                 
90                 pfl->fcurves= curves;
91                 pfl->pchan= pchan;
92                 
93                 /* get the RNA path to this pchan - this needs to be freed! */
94                 RNA_pointer_create((ID *)ob, &RNA_PoseBone, pchan, &ptr);
95                 pfl->pchan_path= RNA_path_from_ID_to_struct(&ptr);
96                 
97                 /* add linkage data to operator data */
98                 BLI_addtail(pfLinks, pfl);
99                 
100                 /* set pchan's transform flags */
101                 if (transFlags & ACT_TRANS_LOC)
102                         pchan->flag |= POSE_LOC;
103                 if (transFlags & ACT_TRANS_ROT)
104                         pchan->flag |= POSE_ROT;
105                 if (transFlags & ACT_TRANS_SCALE)
106                         pchan->flag |= POSE_SIZE;
107                         
108                 /* store current transforms */
109                 // TODO: store axis-angle too?
110                 VECCOPY(pfl->oldloc, pchan->loc);
111                 VECCOPY(pfl->oldrot, pchan->eul);
112                 VECCOPY(pfl->oldscale, pchan->size);
113                 QUATCOPY(pfl->oldquat, pchan->quat);
114         }
115
116
117
118 /* get sets of F-Curves providing transforms for the bones in the Pose  */
119 // TODO: separate the inner workings out to another helper func, since we need option of whether to take selected or visible bones...
120 void poseAnim_mapping_get (bContext *C, ListBase *pfLinks, Object *ob, bAction *act)
121 {       
122         /* for each Pose-Channel which gets affected, get the F-Curves for that channel 
123          * and set the relevant transform flags...
124          */
125         CTX_DATA_BEGIN(C, bPoseChannel*, pchan, selected_pose_bones) 
126         {
127                 fcurves_to_pchan_links_get(pfLinks, ob, act, pchan);
128         }
129         CTX_DATA_END;
130 }
131
132 /* free F-Curve <-> PoseChannel links  */
133 void poseAnim_mapping_free (ListBase *pfLinks)
134 {
135         tPChanFCurveLink *pfl, *pfln=NULL;
136                 
137         /* free the temp pchan links and their data */
138         for (pfl= pfLinks->first; pfl; pfl= pfln) {
139                 pfln= pfl->next;
140                 
141                 /* free list of F-Curve reference links */
142                 BLI_freelistN(&pfl->fcurves);
143                 
144                 /* free pchan RNA Path */
145                 MEM_freeN(pfl->pchan_path);
146                 
147                 /* free link itself */
148                 BLI_freelinkN(pfLinks, pfl);
149         }
150 }
151
152 /* ------------------------- */
153
154 /* helper for apply() / reset() - refresh the data */
155 void poseAnim_mapping_refresh (bContext *C, Scene *scene, Object *ob)
156 {
157         bArmature *arm= (bArmature *)ob->data;
158         
159         /* old optimize trick... this enforces to bypass the depgraph 
160          *      - note: code copied from transform_generics.c -> recalcData()
161          */
162         // FIXME: shouldn't this use the builtin stuff?
163         if ((arm->flag & ARM_DELAYDEFORM)==0)
164                 DAG_id_flush_update(&ob->id, OB_RECALC_DATA);  /* sets recalc flags */
165         else
166                 where_is_pose(scene, ob);
167         
168         /* note, notifier might evolve */
169         WM_event_add_notifier(C, NC_OBJECT|ND_POSE, ob);
170 }
171
172 /* reset changes made to current pose */
173 void poseAnim_mapping_reset (ListBase *pfLinks)
174 {
175         tPChanFCurveLink *pfl;
176         
177         /* iterate over each pose-channel affected, restoring all channels to their original values */
178         for (pfl= pfLinks->first; pfl; pfl= pfl->next) {
179                 bPoseChannel *pchan= pfl->pchan;
180                 
181                 /* just copy all the values over regardless of whether they changed or not */
182                 // TODO; include axis-angle here too?
183                 VECCOPY(pchan->loc, pfl->oldloc);
184                 VECCOPY(pchan->eul, pfl->oldrot);
185                 VECCOPY(pchan->size, pfl->oldscale);
186                 QUATCOPY(pchan->quat, pfl->oldquat);
187         }
188 }
189
190 /* perform autokeyframing after changes were made + confirmed */
191 void poseAnim_mapping_autoKeyframe (bContext *C, Scene *scene, Object *ob, ListBase *pfLinks, float cframe)
192 {
193         static short keyingsets_need_init = 1;
194         static KeyingSet *ks_loc = NULL;
195         static KeyingSet *ks_rot = NULL;
196         static KeyingSet *ks_scale = NULL;
197         
198         /* get keyingsets the first time this is run? 
199          * NOTE: it should be safe to store these static, since they're currently builtin ones
200          * but maybe later this may change, in which case this code needs to be revised!
201          */
202         if (keyingsets_need_init) {
203                 ks_loc= ANIM_builtin_keyingset_get_named(NULL, "Location");
204                 ks_rot= ANIM_builtin_keyingset_get_named(NULL, "Rotation");
205                 ks_scale= ANIM_builtin_keyingset_get_named(NULL, "Scaling");
206                 
207                 keyingsets_need_init = 0;
208         }
209         
210         /* insert keyframes as necessary if autokeyframing */
211         if (autokeyframe_cfra_can_key(scene, &ob->id)) {
212                 tPChanFCurveLink *pfl;
213                 
214                 /* iterate over each pose-channel affected, applying the changes */
215                 for (pfl= pfLinks->first; pfl; pfl= pfl->next) {
216                         ListBase dsources = {NULL, NULL};
217                         bPoseChannel *pchan= pfl->pchan;
218                         
219                         /* add datasource override for the PoseChannel so KeyingSet will do right thing */
220                         ANIM_relative_keyingset_add_source(&dsources, &ob->id, &RNA_PoseBone, pchan); 
221                         
222                         /* insert keyframes 
223                          *      - these keyingsets here use dsources, since we need to specify exactly which keyframes get affected
224                          */
225                         if (pchan->flag & POSE_LOC)
226                                 ANIM_apply_keyingset(C, &dsources, NULL, ks_loc, MODIFYKEY_MODE_INSERT, cframe);
227                         if (pchan->flag & POSE_ROT)
228                                 ANIM_apply_keyingset(C, &dsources, NULL, ks_rot, MODIFYKEY_MODE_INSERT, cframe);
229                         if (pchan->flag & POSE_SIZE)
230                                 ANIM_apply_keyingset(C, &dsources, NULL, ks_scale, MODIFYKEY_MODE_INSERT, cframe);
231                                 
232                         /* free the temp info */
233                         BLI_freelistN(&dsources);
234                 }
235         }
236 }
237
238 /* ------------------------- */
239
240 /* find the next F-Curve for a PoseChannel with matching path... 
241  *      - path is not just the pfl rna_path, since that path doesn't have property info yet
242  */
243 LinkData *poseAnim_mapping_getNextFCurve (ListBase *fcuLinks, LinkData *prev, char *path)
244 {
245         LinkData *first= (prev)? prev->next : (fcuLinks)? fcuLinks->first : NULL;
246         LinkData *ld;
247         
248         /* check each link to see if the linked F-Curve has a matching path */
249         for (ld= first; ld; ld= ld->next) {
250                 FCurve *fcu= (FCurve *)ld->data;
251                 
252                 /* check if paths match */
253                 if (strcmp(path, fcu->rna_path) == 0)
254                         return ld;
255         }       
256         
257         /* none found */
258         return NULL;
259 }
260
261 /* *********************************************** */