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