be4110c68b9ef48d3208374afaff7a722878296c
[blender.git] / source / blender / editors / animation / anim_deps.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) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation, Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <string.h>
30
31 #include "MEM_guardedalloc.h"
32
33 #include "DNA_anim_types.h"
34 #include "DNA_armature_types.h"
35 #include "DNA_object_types.h"
36 #include "DNA_node_types.h"
37 #include "DNA_scene_types.h"
38 #include "DNA_sequence_types.h"
39
40 #include "BLI_blenlib.h"
41 #include "BLI_utildefines.h"
42
43 #include "BKE_animsys.h"
44 #include "BKE_action.h"
45 #include "BKE_context.h"
46 #include "BKE_depsgraph.h"
47 #include "BKE_global.h"
48 #include "BKE_node.h"
49 #include "BKE_sequencer.h"
50 #include "BKE_utildefines.h"
51
52 #include "RNA_access.h"
53
54 #include "ED_anim_api.h"
55
56 /* **************************** depsgraph tagging ******************************** */
57
58 /* tags the given anim list element for refreshes (if applicable)
59  * due to Animation Editor editing 
60  */
61 void ANIM_list_elem_update(Scene *scene, bAnimListElem *ale)
62 {
63         ID *id;
64         FCurve *fcu;
65         AnimData *adt;
66
67         id= ale->id;
68         if (!id)
69                 return;
70         
71         /* tag AnimData for refresh so that other views will update in realtime with these changes */
72         adt= BKE_animdata_from_id(id);
73         if (adt)
74                 adt->recalc |= ADT_RECALC_ANIM;
75
76         /* update data */
77         fcu= (ale->datatype == ALE_FCURVE)? ale->key_data: NULL;
78                 
79         if (fcu && fcu->rna_path) {
80                 /* if we have an fcurve, call the update for the property we
81                    are editing, this is then expected to do the proper redraws
82                    and depsgraph updates  */
83                 PointerRNA id_ptr, ptr;
84                 PropertyRNA *prop;
85                 
86                 RNA_id_pointer_create(id, &id_ptr);
87                         
88                 if(RNA_path_resolve(&id_ptr, fcu->rna_path, &ptr, &prop))
89                         RNA_property_update_main(G.main, scene, &ptr, prop);
90         }
91         else {
92                 /* in other case we do standard depsgaph update, ideally
93                    we'd be calling property update functions here too ... */
94                 DAG_id_tag_update(id, OB_RECALC_OB|OB_RECALC_DATA|OB_RECALC_TIME); // XXX or do we want something more restrictive?
95         }
96 }
97
98 /* tags the given ID block for refreshes (if applicable) due to 
99  * Animation Editor editing */
100 void ANIM_id_update(Scene *UNUSED(scene), ID *id)
101 {
102         if (id) {
103                 AnimData *adt= BKE_animdata_from_id(id);
104                 
105                 /* tag AnimData for refresh so that other views will update in realtime with these changes */
106                 if (adt)
107                         adt->recalc |= ADT_RECALC_ANIM;
108                         
109                 /* set recalc flags */
110                 DAG_id_tag_update(id, OB_RECALC_OB|OB_RECALC_DATA|OB_RECALC_TIME); // XXX or do we want something more restrictive?
111         }
112 }
113
114 /* **************************** animation data <-> data syncing ******************************** */
115 /* This code here is used to synchronise the 
116  *      - selection (to find selected data easier)
117  *      - ... (insert other relevant items here later) 
118  * status in relevant Blender data with the status stored in animation channels.
119  *
120  * This should be called in the refresh() callbacks for various editors in 
121  * response to appropriate notifiers.
122  */
123
124 /* perform syncing updates for Action Groups */
125 static void animchan_sync_group (bAnimContext *UNUSED(ac), bAnimListElem *ale)
126 {
127         bActionGroup *agrp= (bActionGroup *)ale->data;
128         ID *owner_id= ale->id;
129         
130         /* major priority is selection status
131          * so we need both a group and an owner
132          */
133         if (ELEM(NULL, agrp, owner_id))
134                 return;
135                 
136         /* for standard Objects, check if group is the name of some bone */
137         if (GS(owner_id->name) == ID_OB) {
138                 Object *ob= (Object *)owner_id;
139                 
140                 /* check if there are bones, and whether the name matches any 
141                  * NOTE: this feature will only really work if groups by default contain the F-Curves for a single bone
142                  */
143                 if (ob->pose) {
144                         bPoseChannel *pchan= get_pose_channel(ob->pose, agrp->name);
145                         
146                         /* if one matches, sync the selection status */
147                         if (pchan) {
148                                 if (pchan->bone->flag & BONE_SELECTED)
149                                         agrp->flag |= AGRP_SELECTED;
150                                 else
151                                         agrp->flag &= ~AGRP_SELECTED;
152                         }
153                 }
154         }
155 }
156  
157 /* perform syncing updates for F-Curves */
158 static void animchan_sync_fcurve (bAnimContext *UNUSED(ac), bAnimListElem *ale)
159 {
160         FCurve *fcu= (FCurve *)ale->data;
161         ID *owner_id= ale->id;
162         
163         /* major priority is selection status, so refer to the checks done in anim_filter.c 
164          * skip_fcurve_selected_data() for reference about what's going on here...
165          */
166         if (ELEM3(NULL, fcu, fcu->rna_path, owner_id))
167                 return;
168                 
169         if (GS(owner_id->name) == ID_OB) {
170                 Object *ob= (Object *)owner_id;
171                 
172                 /* only affect if F-Curve involves pose.bones */
173                 if ((fcu->rna_path) && strstr(fcu->rna_path, "pose.bones")) {
174                         bPoseChannel *pchan;
175                         char *bone_name;
176                         
177                         /* get bone-name, and check if this bone is selected */
178                         bone_name= BLI_getQuotedStr(fcu->rna_path, "pose.bones[");
179                         pchan= get_pose_channel(ob->pose, bone_name);
180                         if (bone_name) MEM_freeN(bone_name);
181                         
182                         /* F-Curve selection depends on whether the bone is selected */
183                         if ((pchan) && (pchan->bone)) {
184                                 if (pchan->bone->flag & BONE_SELECTED)
185                                         fcu->flag |= FCURVE_SELECTED;
186                                 else
187                                         fcu->flag &= ~FCURVE_SELECTED;
188                         }
189                 }
190         }
191         else if (GS(owner_id->name) == ID_SCE) {
192                 Scene *scene = (Scene *)owner_id;
193                 
194                 /* only affect if F-Curve involves sequence_editor.sequences */
195                 if ((fcu->rna_path) && strstr(fcu->rna_path, "sequences_all")) {
196                         Editing *ed= seq_give_editing(scene, FALSE);
197                         Sequence *seq;
198                         char *seq_name;
199                         
200                         /* get strip name, and check if this strip is selected */
201                         seq_name= BLI_getQuotedStr(fcu->rna_path, "sequences_all[");
202                         seq = get_seq_by_name(ed->seqbasep, seq_name, FALSE);
203                         if (seq_name) MEM_freeN(seq_name);
204                         
205                         /* can only add this F-Curve if it is selected */
206                         if (seq) {
207                                 if (seq->flag & SELECT)
208                                         fcu->flag |= FCURVE_SELECTED;
209                                 else
210                                         fcu->flag &= ~FCURVE_SELECTED;
211                         }
212                 }
213         }
214         else if (GS(owner_id->name) == ID_NT) {
215                 bNodeTree *ntree = (bNodeTree *)owner_id;
216                 
217                 /* check for selected nodes */
218                 if ((fcu->rna_path) && strstr(fcu->rna_path, "nodes")) {
219                         bNode *node;
220                         char *node_name;
221                         
222                         /* get strip name, and check if this strip is selected */
223                         node_name= BLI_getQuotedStr(fcu->rna_path, "nodes[");
224                         node = nodeFindNodebyName(ntree, node_name);
225                         if (node_name) MEM_freeN(node_name);
226                         
227                         /* can only add this F-Curve if it is selected */
228                         if (node) {
229                                 if (node->flag & NODE_SELECT)
230                                         fcu->flag |= FCURVE_SELECTED;
231                                 else
232                                         fcu->flag &= ~FCURVE_SELECTED;
233                         }
234                 }
235         }
236 }
237
238 /* ---------------- */
239  
240 /* Main call to be exported to animation editors */
241 void ANIM_sync_animchannels_to_data (const bContext *C)
242 {
243         bAnimContext ac;
244         ListBase anim_data = {NULL, NULL};
245         bAnimListElem *ale;
246         int filter;
247         
248         /* get animation context info for filtering the channels */
249         // TODO: check on whether we need to set the area specially instead, since active area might not be ok?
250         if (ANIM_animdata_get_context(C, &ac) == 0)
251                 return;
252         
253         /* filter data */
254                 /* NOTE: we want all channels, since we want to be able to set selection status on some of them even when collapsed */
255         filter= ANIMFILTER_CHANNELS;
256         ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
257         
258         /* flush settings as appropriate depending on the types of the channels */
259         for (ale= anim_data.first; ale; ale= ale->next) {
260                 switch (ale->type) {
261                         case ANIMTYPE_GROUP:
262                                 animchan_sync_group(&ac, ale);
263                                 break;
264                         
265                         case ANIMTYPE_FCURVE:
266                                 animchan_sync_fcurve(&ac, ale);
267                                 break;
268                 }
269         }
270         
271         BLI_freelistN(&anim_data);
272 }