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