part 1 of merge from trunk at r30358; it compiles, but doesn't link quite yet :)
[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_animsys.h"
48 #include "BKE_action.h"
49 #include "BKE_armature.h"
50 #include "BKE_depsgraph.h"
51 #include "BKE_fcurve.h"
52 #include "BKE_object.h"
53
54 #include "BKE_global.h"
55 #include "BKE_context.h"
56 #include "BKE_report.h"
57 #include "BKE_utildefines.h"
58
59 #include "RNA_access.h"
60
61 #include "WM_api.h"
62 #include "WM_types.h"
63
64
65 #include "BIF_gl.h"
66
67 #include "ED_armature.h"
68 #include "ED_keyframing.h"
69
70 #include "armature_intern.h"
71
72 /* *********************************************** */
73 /* Contents of this File:
74  *
75  * This file contains methods shared between Pose Slide and Pose Lib;
76  * primarily the functions in question concern Animato <-> Pose 
77  * convenience functions, such as applying/getting pose values
78  * and/or inserting keyframes for these.
79  */
80 /* *********************************************** */ 
81 /* FCurves <-> PoseChannels Links */
82
83 /* helper for poseAnim_mapping_get() -> get the relevant F-Curves per PoseChannel */
84 static void fcurves_to_pchan_links_get (ListBase *pfLinks, Object *ob, bAction *act, bPoseChannel *pchan)
85 {
86         ListBase curves = {NULL, NULL};
87         int transFlags = action_get_item_transforms(act, ob, pchan, &curves);
88         
89         pchan->flag &= ~(POSE_LOC|POSE_ROT|POSE_SIZE);
90         
91         /* check if any transforms found... */
92         if (transFlags) {
93                 /* make new linkage data */
94                 tPChanFCurveLink *pfl= MEM_callocN(sizeof(tPChanFCurveLink), "tPChanFCurveLink");
95                 PointerRNA ptr;
96                 
97                 pfl->fcurves= curves;
98                 pfl->pchan= pchan;
99                 
100                 /* get the RNA path to this pchan - this needs to be freed! */
101                 RNA_pointer_create((ID *)ob, &RNA_PoseBone, pchan, &ptr);
102                 pfl->pchan_path= RNA_path_from_ID_to_struct(&ptr);
103                 
104                 /* add linkage data to operator data */
105                 BLI_addtail(pfLinks, pfl);
106                 
107                 /* set pchan's transform flags */
108                 if (transFlags & ACT_TRANS_LOC)
109                         pchan->flag |= POSE_LOC;
110                 if (transFlags & ACT_TRANS_ROT)
111                         pchan->flag |= POSE_ROT;
112                 if (transFlags & ACT_TRANS_SCALE)
113                         pchan->flag |= POSE_SIZE;
114                         
115                 /* store current transforms */
116                 // TODO: store axis-angle too?
117                 VECCOPY(pfl->oldloc, pchan->loc);
118                 VECCOPY(pfl->oldrot, pchan->eul);
119                 VECCOPY(pfl->oldscale, pchan->size);
120                 QUATCOPY(pfl->oldquat, pchan->quat);
121         }
122
123
124
125 /* get sets of F-Curves providing transforms for the bones in the Pose  */
126 // TODO: separate the inner workings out to another helper func, since we need option of whether to take selected or visible bones...
127 void poseAnim_mapping_get (bContext *C, ListBase *pfLinks, Object *ob, bAction *act)
128 {       
129         /* for each Pose-Channel which gets affected, get the F-Curves for that channel 
130          * and set the relevant transform flags...
131          */
132         CTX_DATA_BEGIN(C, bPoseChannel*, pchan, selected_pose_bones) 
133         {
134                 fcurves_to_pchan_links_get(pfLinks, ob, act, pchan);
135         }
136         CTX_DATA_END;
137 }
138
139 /* free F-Curve <-> PoseChannel links  */
140 void poseAnim_mapping_free (ListBase *pfLinks)
141 {
142         tPChanFCurveLink *pfl, *pfln=NULL;
143                 
144         /* free the temp pchan links and their data */
145         for (pfl= pfLinks->first; pfl; pfl= pfln) {
146                 pfln= pfl->next;
147                 
148                 /* free list of F-Curve reference links */
149                 BLI_freelistN(&pfl->fcurves);
150                 
151                 /* free pchan RNA Path */
152                 MEM_freeN(pfl->pchan_path);
153                 
154                 /* free link itself */
155                 BLI_freelinkN(pfLinks, pfl);
156         }
157 }
158
159 /* ------------------------- */
160
161 /* helper for apply() / reset() - refresh the data */
162 void poseAnim_mapping_refresh (bContext *C, Scene *scene, Object *ob)
163 {
164         bArmature *arm= (bArmature *)ob->data;
165         
166         /* old optimize trick... this enforces to bypass the depgraph 
167          *      - note: code copied from transform_generics.c -> recalcData()
168          */
169         // FIXME: shouldn't this use the builtin stuff?
170         if ((arm->flag & ARM_DELAYDEFORM)==0)
171                 DAG_id_flush_update(&ob->id, OB_RECALC_DATA);  /* sets recalc flags */
172         else
173                 where_is_pose(scene, ob);
174         
175         /* note, notifier might evolve */
176         WM_event_add_notifier(C, NC_OBJECT|ND_POSE, ob);
177 }
178
179 /* reset changes made to current pose */
180 void poseAnim_mapping_reset (ListBase *pfLinks)
181 {
182         tPChanFCurveLink *pfl;
183         
184         /* iterate over each pose-channel affected, restoring all channels to their original values */
185         for (pfl= pfLinks->first; pfl; pfl= pfl->next) {
186                 bPoseChannel *pchan= pfl->pchan;
187                 
188                 /* just copy all the values over regardless of whether they changed or not */
189                 // TODO; include axis-angle here too?
190                 VECCOPY(pchan->loc, pfl->oldloc);
191                 VECCOPY(pchan->eul, pfl->oldrot);
192                 VECCOPY(pchan->size, pfl->oldscale);
193                 QUATCOPY(pchan->quat, pfl->oldquat);
194         }
195 }
196
197 /* perform autokeyframing after changes were made + confirmed */
198 void poseAnim_mapping_autoKeyframe (bContext *C, Scene *scene, Object *ob, ListBase *pfLinks, float cframe)
199 {
200         static short keyingsets_need_init = 1;
201         static KeyingSet *ks_loc = NULL;
202         static KeyingSet *ks_rot = NULL;
203         static KeyingSet *ks_scale = NULL;
204         
205         /* get keyingsets the first time this is run? 
206          * NOTE: it should be safe to store these static, since they're currently builtin ones
207          * but maybe later this may change, in which case this code needs to be revised!
208          */
209         if (keyingsets_need_init) {
210                 ks_loc= ANIM_builtin_keyingset_get_named(NULL, "Location");
211                 ks_rot= ANIM_builtin_keyingset_get_named(NULL, "Rotation");
212                 ks_scale= ANIM_builtin_keyingset_get_named(NULL, "Scaling");
213                 
214                 keyingsets_need_init = 0;
215         }
216         
217         /* insert keyframes as necessary if autokeyframing */
218         if (autokeyframe_cfra_can_key(scene, &ob->id)) {
219                 tPChanFCurveLink *pfl;
220                 
221                 /* iterate over each pose-channel affected, applying the changes */
222                 for (pfl= pfLinks->first; pfl; pfl= pfl->next) {
223                         ListBase dsources = {NULL, NULL};
224                         bPoseChannel *pchan= pfl->pchan;
225                         
226                         /* add datasource override for the PoseChannel so KeyingSet will do right thing */
227                         ANIM_relative_keyingset_add_source(&dsources, &ob->id, &RNA_PoseBone, pchan); 
228                         
229                         /* insert keyframes 
230                          *      - these keyingsets here use dsources, since we need to specify exactly which keyframes get affected
231                          */
232                         if (pchan->flag & POSE_LOC)
233                                 ANIM_apply_keyingset(C, &dsources, NULL, ks_loc, MODIFYKEY_MODE_INSERT, cframe);
234                         if (pchan->flag & POSE_ROT)
235                                 ANIM_apply_keyingset(C, &dsources, NULL, ks_rot, MODIFYKEY_MODE_INSERT, cframe);
236                         if (pchan->flag & POSE_SIZE)
237                                 ANIM_apply_keyingset(C, &dsources, NULL, ks_scale, MODIFYKEY_MODE_INSERT, cframe);
238                                 
239                         /* free the temp info */
240                         BLI_freelistN(&dsources);
241                 }
242         }
243 }
244
245 /* ------------------------- */
246
247 /* find the next F-Curve for a PoseChannel with matching path... 
248  *      - path is not just the pfl rna_path, since that path doesn't have property info yet
249  */
250 LinkData *poseAnim_mapping_getNextFCurve (ListBase *fcuLinks, LinkData *prev, char *path)
251 {
252         LinkData *first= (prev)? prev->next : (fcuLinks)? fcuLinks->first : NULL;
253         LinkData *ld;
254         
255         /* check each link to see if the linked F-Curve has a matching path */
256         for (ld= first; ld; ld= ld->next) {
257                 FCurve *fcu= (FCurve *)ld->data;
258                 
259                 /* check if paths match */
260                 if (strcmp(path, fcu->rna_path) == 0)
261                         return ld;
262         }       
263         
264         /* none found */
265         return NULL;
266 }
267
268 /* *********************************************** */