7de1f84acddd75929c64bc99b8ee018cb6ad5453
[blender.git] / source / blender / makesrna / intern / rna_action.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008), Roland Hess, Joshua Leung
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_action.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_access.h"
31 #include "RNA_define.h"
32 #include "RNA_enum_types.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_anim_types.h"
37 #include "DNA_action_types.h"
38 #include "DNA_scene_types.h"
39
40 #include "MEM_guardedalloc.h"
41
42 #include "BLI_utildefines.h"
43
44 #include "BKE_action.h"
45
46 #include "WM_types.h"
47
48
49 #ifdef RNA_RUNTIME
50
51 #include "BLI_math_base.h"
52
53 #include "BKE_fcurve.h"
54
55 #include "ED_keyframing.h"
56
57
58 static void rna_ActionGroup_channels_next(CollectionPropertyIterator *iter)
59 {
60         ListBaseIterator *internal = iter->internal;
61         FCurve *fcu = (FCurve *)internal->link;
62         bActionGroup *grp = fcu->grp;
63         
64         /* only continue if the next F-Curve (if existant) belongs in the same group */
65         if ((fcu->next) && (fcu->next->grp == grp))
66                 internal->link = (Link *)fcu->next;
67         else
68                 internal->link = NULL;
69                 
70         iter->valid = (internal->link != NULL);
71 }
72
73 static bActionGroup *rna_Action_groups_new(bAction *act, const char name[])
74 {
75         return action_groups_add_new(act, name);
76 }
77
78 static void rna_Action_groups_remove(bAction *act, ReportList *reports, PointerRNA *agrp_ptr)
79 {
80         bActionGroup *agrp = agrp_ptr->data;
81         FCurve *fcu, *fcn;
82         
83         /* try to remove the F-Curve from the action */
84         if (BLI_remlink_safe(&act->groups, agrp) == FALSE) {
85                 BKE_reportf(reports, RPT_ERROR, "Action group '%s' not found in action '%s'", agrp->name, act->id.name + 2);
86                 return;
87         }
88
89         /* move every one one of the group's F-Curves out into the Action again */
90         for (fcu = agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu = fcn) {
91                 fcn = fcu->next;
92
93                 /* remove from group */
94                 action_groups_remove_channel(act, fcu);
95
96                 /* tack onto the end */
97                 BLI_addtail(&act->curves, fcu);
98         }
99
100         MEM_freeN(agrp);
101         RNA_POINTER_INVALIDATE(agrp_ptr);
102 }
103
104 static FCurve *rna_Action_fcurve_new(bAction *act, ReportList *reports, const char *data_path,
105                                      int index, const char *group)
106 {
107         if (group && group[0] == '\0') group = NULL;
108
109         if (data_path[0] == '\0') {
110                 BKE_report(reports, RPT_ERROR, "F-Curve data path empty, invalid argument");
111                 return NULL;
112         }
113
114         /* annoying, check if this exists */
115         if (verify_fcurve(act, group, NULL, data_path, index, 0)) {
116                 BKE_reportf(reports, RPT_ERROR, "F-Curve '%s[%d]' already exists in action '%s'", data_path,
117                             index, act->id.name + 2);
118                 return NULL;
119         }
120         return verify_fcurve(act, group, NULL, data_path, index, 1);
121 }
122
123 static void rna_Action_fcurve_remove(bAction *act, ReportList *reports, PointerRNA *fcu_ptr)
124 {
125         FCurve *fcu = fcu_ptr->data;
126         if (fcu->grp) {
127                 if (BLI_findindex(&act->groups, fcu->grp) == -1) {
128                         BKE_reportf(reports, RPT_ERROR, "F-Curve's action group '%s' not found in action '%s'",
129                                     fcu->grp->name, act->id.name + 2);
130                         return;
131                 }
132                 
133                 action_groups_remove_channel(act, fcu);
134                 free_fcurve(fcu);
135                 RNA_POINTER_INVALIDATE(fcu_ptr);
136         }
137         else {
138                 if (BLI_findindex(&act->curves, fcu) == -1) {
139                         BKE_reportf(reports, RPT_ERROR, "F-Curve not found in action '%s'", act->id.name + 2);
140                         return;
141                 }
142                 
143                 BLI_remlink(&act->curves, fcu);
144                 free_fcurve(fcu);
145                 RNA_POINTER_INVALIDATE(fcu_ptr);
146         }
147 }
148
149 static TimeMarker *rna_Action_pose_markers_new(bAction *act, const char name[])
150 {
151         TimeMarker *marker = MEM_callocN(sizeof(TimeMarker), "TimeMarker");
152         marker->flag = 1;
153         marker->frame = 1;
154         BLI_strncpy_utf8(marker->name, name, sizeof(marker->name));
155         BLI_addtail(&act->markers, marker);
156         return marker;
157 }
158
159 static void rna_Action_pose_markers_remove(bAction *act, ReportList *reports, PointerRNA *marker_ptr)
160 {
161         TimeMarker *marker = marker_ptr->data;
162         if (!BLI_remlink_safe(&act->markers, marker)) {
163                 BKE_reportf(reports, RPT_ERROR, "Timeline marker '%s' not found in action '%s'", marker->name, act->id.name + 2);
164                 return;
165         }
166
167         MEM_freeN(marker);
168         RNA_POINTER_INVALIDATE(marker_ptr);
169 }
170
171 static PointerRNA rna_Action_active_pose_marker_get(PointerRNA *ptr)
172 {
173         bAction *act = (bAction *)ptr->data;
174         return rna_pointer_inherit_refine(ptr, &RNA_TimelineMarker, BLI_findlink(&act->markers, act->active_marker - 1));
175 }
176
177 static void rna_Action_active_pose_marker_set(PointerRNA *ptr, PointerRNA value)
178 {
179         bAction *act = (bAction *)ptr->data;
180         act->active_marker = BLI_findindex(&act->markers, value.data) + 1;
181 }
182
183 static int rna_Action_active_pose_marker_index_get(PointerRNA *ptr)
184 {
185         bAction *act = (bAction *)ptr->data;
186         return MAX2(act->active_marker - 1, 0);
187 }
188
189 static void rna_Action_active_pose_marker_index_set(PointerRNA *ptr, int value)
190 {
191         bAction *act = (bAction *)ptr->data;
192         act->active_marker = value + 1;
193 }
194
195 static void rna_Action_active_pose_marker_index_range(PointerRNA *ptr, int *min, int *max, int *softmin, int *softmax)
196 {
197         bAction *act = (bAction *)ptr->data;
198
199         *min = 0;
200         *max = max_ii(0, BLI_countlist(&act->markers) - 1);
201 }
202
203
204
205 static void rna_Action_frame_range_get(PointerRNA *ptr, float *values)
206 {   /* don't include modifiers because they too easily can have very large
207          * ranges: MINAFRAMEF to MAXFRAMEF. */
208         calc_action_range(ptr->id.data, values, values + 1, FALSE);
209 }
210
211
212 /* used to check if an action (value pointer) is suitable to be assigned to the ID-block that is ptr */
213 int rna_Action_id_poll(PointerRNA *ptr, PointerRNA value)
214 {
215         ID *srcId = (ID *)ptr->id.data;
216         bAction *act = (bAction *)value.id.data;
217         
218         if (act) {
219                 /* there can still be actions that will have undefined id-root
220                  * (i.e. floating "action-library" members) which we will not
221                  * be able to resolve an idroot for automatically, so let these through
222                  */
223                 if (act->idroot == 0)
224                         return 1;
225                 else if (srcId)
226                         return GS(srcId->name) == act->idroot;
227         }
228         
229         return 0;
230 }
231
232 /* used to check if an action (value pointer) can be assigned to Action Editor given current mode */
233 int rna_Action_actedit_assign_poll(PointerRNA *ptr, PointerRNA value)
234 {
235         SpaceAction *saction = (SpaceAction *)ptr->data;
236         bAction *act = (bAction *)value.id.data;
237         
238         if (act) {
239                 /* there can still be actions that will have undefined id-root
240                  * (i.e. floating "action-library" members) which we will not
241                  * be able to resolve an idroot for automatically, so let these through
242                  */
243                 if (act->idroot == 0)
244                         return 1;
245                 
246                 if (saction) {
247                         if (saction->mode == SACTCONT_ACTION) {
248                                 /* this is only Object-level for now... */
249                                 return act->idroot == ID_OB;
250                         }
251                         else if (saction->mode == SACTCONT_SHAPEKEY) {
252                                 /* obviously shapekeys only */
253                                 return act->idroot == ID_KE;
254                         }
255                 }
256         }
257         
258         return 0;
259 }
260
261 #else
262
263 static void rna_def_dopesheet(BlenderRNA *brna)
264 {
265         StructRNA *srna;
266         PropertyRNA *prop;
267
268         srna = RNA_def_struct(brna, "DopeSheet", NULL);
269         RNA_def_struct_sdna(srna, "bDopeSheet");
270         RNA_def_struct_ui_text(srna, "DopeSheet", "Settings for filtering the channels shown in animation editors");
271         
272         /* Source of DopeSheet data */
273         /* XXX: make this obsolete? */
274         prop = RNA_def_property(srna, "source", PROP_POINTER, PROP_NONE);
275         RNA_def_property_struct_type(prop, "ID");
276         RNA_def_property_ui_text(prop, "Source",
277                                  "ID-Block representing source data, usually ID_SCE (i.e. Scene)");
278         
279         /* Show datablock filters */
280         prop = RNA_def_property(srna, "show_datablock_filters", PROP_BOOLEAN, PROP_NONE);
281         RNA_def_property_boolean_sdna(prop, NULL, "flag", ADS_FLAG_SHOW_DBFILTERS);
282         RNA_def_property_ui_text(prop, "Show Datablock Filters",
283                                  "Show options for whether channels related to certain types of data are included");
284         RNA_def_property_ui_icon(prop, ICON_DISCLOSURE_TRI_RIGHT, -1);
285         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN, NULL);
286         
287         /* General Filtering Settings */
288         prop = RNA_def_property(srna, "show_only_selected", PROP_BOOLEAN, PROP_NONE);
289         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_ONLYSEL);
290         RNA_def_property_ui_text(prop, "Only Selected", "Only include channels relating to selected objects and data");
291         RNA_def_property_ui_icon(prop, ICON_RESTRICT_SELECT_OFF, 0);
292         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
293         
294         prop = RNA_def_property(srna, "show_hidden", PROP_BOOLEAN, PROP_NONE);
295         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_INCL_HIDDEN);
296         RNA_def_property_ui_text(prop, "Display Hidden", "Include channels from objects/bone that are not visible");
297         RNA_def_property_ui_icon(prop, ICON_GHOST_ENABLED, 0);
298         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
299         
300         /* Debug Filtering Settings */
301         prop = RNA_def_property(srna, "show_only_errors", PROP_BOOLEAN, PROP_NONE);
302         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_ONLY_ERRORS);
303         RNA_def_property_ui_text(prop, "Show Errors", "Only include F-Curves and drivers that are disabled or have errors");
304         RNA_def_property_ui_icon(prop, ICON_HELP, 0); /* XXX: this doesn't quite fit */
305         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
306         
307         /* Object Group Filtering Settings */
308         prop = RNA_def_property(srna, "show_only_group_objects", PROP_BOOLEAN, PROP_NONE);
309         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_ONLYOBGROUP);
310         RNA_def_property_ui_text(prop, "Only Objects in Group",
311                                  "Only include channels from objects in the specified group");
312         RNA_def_property_ui_icon(prop, ICON_GROUP, 0);
313         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
314         
315         prop = RNA_def_property(srna, "filter_group", PROP_POINTER, PROP_NONE);
316         RNA_def_property_pointer_sdna(prop, NULL, "filter_grp");
317         RNA_def_property_flag(prop, PROP_EDITABLE);
318         RNA_def_property_ui_text(prop, "Filtering Group", "Group that included object should be a member of");
319         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
320         
321         /* FCurve Display Name Search Settings */
322         prop = RNA_def_property(srna, "show_only_matching_fcurves", PROP_BOOLEAN, PROP_NONE);
323         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_BY_FCU_NAME);
324         RNA_def_property_ui_text(prop, "Only Matching F-Curves",
325                                  "Only include F-Curves with names containing search text");
326         RNA_def_property_ui_icon(prop, ICON_VIEWZOOM, 0);
327         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
328         
329         prop = RNA_def_property(srna, "filter_fcurve_name", PROP_STRING, PROP_NONE);
330         RNA_def_property_string_sdna(prop, NULL, "searchstr");
331         RNA_def_property_ui_text(prop, "F-Curve Name Filter", "F-Curve live filtering string");
332         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
333         
334         /* NLA Specific Settings */
335         prop = RNA_def_property(srna, "show_missing_nla", PROP_BOOLEAN, PROP_NONE);
336         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NLA_NOACT);
337         RNA_def_property_ui_text(prop, "Include Missing NLA",
338                                  "Include animation data blocks with no NLA data (NLA editor only)");
339         RNA_def_property_ui_icon(prop, ICON_ACTION, 0);
340         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
341         
342         /* Summary Settings (DopeSheet editors only) */
343         prop = RNA_def_property(srna, "show_summary", PROP_BOOLEAN, PROP_NONE);
344         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_SUMMARY);
345         RNA_def_property_ui_text(prop, "Display Summary", "Display an additional 'summary' line (DopeSheet editors only)");
346         RNA_def_property_ui_icon(prop, ICON_BORDERMOVE, 0);
347         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
348         
349         prop = RNA_def_property(srna, "show_expanded_summary", PROP_BOOLEAN, PROP_NONE);
350         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADS_FLAG_SUMMARY_COLLAPSED);
351         RNA_def_property_ui_text(prop, "Collapse Summary",
352                                  "Collapse summary when shown, so all other channels get hidden (DopeSheet editors only)");
353         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
354         
355         
356         /* General DataType Filtering Settings */
357         prop = RNA_def_property(srna, "show_transforms", PROP_BOOLEAN, PROP_NONE);
358         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOOBJ);
359         RNA_def_property_ui_text(prop, "Display Transforms",
360                                  "Include visualization of object-level animation data (mostly transforms)");
361         RNA_def_property_ui_icon(prop, ICON_MANIPUL, 0); /* XXX? */
362         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
363         
364         prop = RNA_def_property(srna, "show_shapekeys", PROP_BOOLEAN, PROP_NONE);
365         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSHAPEKEYS);
366         RNA_def_property_ui_text(prop, "Display Shapekeys", "Include visualization of shape key related animation data");
367         RNA_def_property_ui_icon(prop, ICON_SHAPEKEY_DATA, 0);
368         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
369         
370         prop = RNA_def_property(srna, "show_meshes", PROP_BOOLEAN, PROP_NONE);
371         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMESH);
372         RNA_def_property_ui_text(prop, "Display Meshes", "Include visualization of mesh related animation data");
373         RNA_def_property_ui_icon(prop, ICON_MESH_DATA, 0);
374         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
375         
376         prop = RNA_def_property(srna, "show_lattices", PROP_BOOLEAN, PROP_NONE);
377         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLAT);
378         RNA_def_property_ui_text(prop, "Display Lattices", "Include visualization of lattice related animation data");
379         RNA_def_property_ui_icon(prop, ICON_LATTICE_DATA, 0);
380         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
381         
382         prop = RNA_def_property(srna, "show_cameras", PROP_BOOLEAN, PROP_NONE);
383         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOCAM);
384         RNA_def_property_ui_text(prop, "Display Camera", "Include visualization of camera related animation data");
385         RNA_def_property_ui_icon(prop, ICON_CAMERA_DATA, 0);
386         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
387         
388         prop = RNA_def_property(srna, "show_materials", PROP_BOOLEAN, PROP_NONE);
389         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMAT);
390         RNA_def_property_ui_text(prop, "Display Material", "Include visualization of material related animation data");
391         RNA_def_property_ui_icon(prop, ICON_MATERIAL_DATA, 0);
392         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
393         
394         prop = RNA_def_property(srna, "show_lamps", PROP_BOOLEAN, PROP_NONE);
395         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLAM);
396         RNA_def_property_ui_text(prop, "Display Lamp", "Include visualization of lamp related animation data");
397         RNA_def_property_ui_icon(prop, ICON_LAMP_DATA, 0);
398         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
399         
400         prop = RNA_def_property(srna, "show_textures", PROP_BOOLEAN, PROP_NONE);
401         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOTEX);
402         RNA_def_property_ui_text(prop, "Display Texture", "Include visualization of texture related animation data");
403         RNA_def_property_ui_icon(prop, ICON_TEXTURE_DATA, 0);
404         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
405         
406         prop = RNA_def_property(srna, "show_curves", PROP_BOOLEAN, PROP_NONE);
407         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOCUR);
408         RNA_def_property_ui_text(prop, "Display Curve", "Include visualization of curve related animation data");
409         RNA_def_property_ui_icon(prop, ICON_CURVE_DATA, 0);
410         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
411         
412         prop = RNA_def_property(srna, "show_worlds", PROP_BOOLEAN, PROP_NONE);
413         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOWOR);
414         RNA_def_property_ui_text(prop, "Display World", "Include visualization of world related animation data");
415         RNA_def_property_ui_icon(prop, ICON_WORLD_DATA, 0);
416         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
417         
418         prop = RNA_def_property(srna, "show_scenes", PROP_BOOLEAN, PROP_NONE);
419         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSCE);
420         RNA_def_property_ui_text(prop, "Display Scene", "Include visualization of scene related animation data");
421         RNA_def_property_ui_icon(prop, ICON_SCENE_DATA, 0);
422         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
423         
424         prop = RNA_def_property(srna, "show_particles", PROP_BOOLEAN, PROP_NONE);
425         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOPART);
426         RNA_def_property_ui_text(prop, "Display Particle", "Include visualization of particle related animation data");
427         RNA_def_property_ui_icon(prop, ICON_PARTICLE_DATA, 0);
428         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
429         
430         prop = RNA_def_property(srna, "show_metaballs", PROP_BOOLEAN, PROP_NONE);
431         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMBA);
432         RNA_def_property_ui_text(prop, "Display Metaball", "Include visualization of metaball related animation data");
433         RNA_def_property_ui_icon(prop, ICON_META_DATA, 0);
434         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
435         
436         prop = RNA_def_property(srna, "show_armatures", PROP_BOOLEAN, PROP_NONE);
437         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOARM);
438         RNA_def_property_ui_text(prop, "Display Armature", "Include visualization of armature related animation data");
439         RNA_def_property_ui_icon(prop, ICON_ARMATURE_DATA, 0);
440         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
441         
442         prop = RNA_def_property(srna, "show_nodes", PROP_BOOLEAN, PROP_NONE);
443         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NONTREE);
444         RNA_def_property_ui_text(prop, "Display Node", "Include visualization of node related animation data");
445         RNA_def_property_ui_icon(prop, ICON_NODETREE, 0);
446         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
447
448         prop = RNA_def_property(srna, "show_speakers", PROP_BOOLEAN, PROP_NONE);
449         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSPK);
450         RNA_def_property_ui_text(prop, "Display Speaker", "Include visualization of speaker related animation data");
451         RNA_def_property_ui_icon(prop, ICON_SPEAKER, 0);
452         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
453 }
454
455 static void rna_def_action_group(BlenderRNA *brna)
456 {
457         StructRNA *srna;
458         PropertyRNA *prop;
459         
460         srna = RNA_def_struct(brna, "ActionGroup", NULL);
461         RNA_def_struct_sdna(srna, "bActionGroup");
462         RNA_def_struct_ui_text(srna, "Action Group", "Groups of F-Curves");
463         
464         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
465         RNA_def_property_ui_text(prop, "Name", "");
466         RNA_def_struct_name_property(srna, prop);
467         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
468         
469         /* WARNING: be very careful when working with this list, since the endpoint is not
470          * defined like a standard ListBase. Adding/removing channels from this list needs
471          * extreme care, otherwise the F-Curve list running through adjacent groups does
472          * not match up with the one stored in the Action, resulting in curves which do not
473          * show up in animation editors. In extreme cases, animation may also selectively
474          * fail to play back correctly.
475          *
476          * If such changes are required, these MUST go through the API functions for manipulating
477          * these F-Curve groupings. Also, note that groups only apply in actions ONLY.
478          */
479         prop = RNA_def_property(srna, "channels", PROP_COLLECTION, PROP_NONE);
480         RNA_def_property_collection_sdna(prop, NULL, "channels", NULL);
481         RNA_def_property_struct_type(prop, "FCurve");
482         RNA_def_property_collection_funcs(prop, 0, "rna_ActionGroup_channels_next", NULL, NULL, NULL, NULL, NULL, NULL);
483         RNA_def_property_ui_text(prop, "Channels", "F-Curves in this group");
484         
485         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
486         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_SELECTED);
487         RNA_def_property_ui_text(prop, "Select", "Action group is selected");
488         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_SELECTED, NULL);
489         
490         prop = RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
491         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_PROTECTED);
492         RNA_def_property_ui_text(prop, "Lock", "Action group is locked");
493         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
494         
495         prop = RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
496         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_EXPANDED);
497         RNA_def_property_ui_text(prop, "Expanded", "Action group is expanded");
498         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
499         
500         /* color set */
501         rna_def_actionbone_group_common(srna, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
502 }
503
504 /* fcurve.keyframe_points */
505 static void rna_def_action_groups(BlenderRNA *brna, PropertyRNA *cprop)
506 {
507         StructRNA *srna;
508
509         FunctionRNA *func;
510         PropertyRNA *parm;
511
512         RNA_def_property_srna(cprop, "ActionGroups");
513         srna = RNA_def_struct(brna, "ActionGroups", NULL);
514         RNA_def_struct_sdna(srna, "bAction");
515         RNA_def_struct_ui_text(srna, "Action Groups", "Collection of action groups");
516
517         func = RNA_def_function(srna, "new", "rna_Action_groups_new");
518         RNA_def_function_ui_description(func, "Add a keyframe to the curve");
519         parm = RNA_def_string(func, "name", "Group", 0, "", "New name for the action group");
520         RNA_def_property_flag(parm, PROP_REQUIRED);
521
522         parm = RNA_def_pointer(func, "action_group", "ActionGroup", "", "Newly created action group");
523         RNA_def_function_return(func, parm);
524
525
526         func = RNA_def_function(srna, "remove", "rna_Action_groups_remove");
527         RNA_def_function_ui_description(func, "Remove action group");
528         RNA_def_function_flag(func, FUNC_USE_REPORTS);
529         parm = RNA_def_pointer(func, "action_group", "ActionGroup", "", "Action group to remove");
530         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
531         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
532 }
533
534 static void rna_def_action_fcurves(BlenderRNA *brna, PropertyRNA *cprop)
535 {
536         StructRNA *srna;
537
538         FunctionRNA *func;
539         PropertyRNA *parm;
540
541         RNA_def_property_srna(cprop, "ActionFCurves");
542         srna = RNA_def_struct(brna, "ActionFCurves", NULL);
543         RNA_def_struct_sdna(srna, "bAction");
544         RNA_def_struct_ui_text(srna, "Action F-Curves", "Collection of action F-Curves");
545
546         func = RNA_def_function(srna, "new", "rna_Action_fcurve_new");
547         RNA_def_function_ui_description(func, "Add a keyframe to the F-Curve");
548         RNA_def_function_flag(func, FUNC_USE_REPORTS);
549         parm = RNA_def_string(func, "data_path", "", 0, "Data Path", "F-Curve data path to use");
550         RNA_def_property_flag(parm, PROP_REQUIRED);
551         RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "Array index", 0, INT_MAX);
552         RNA_def_string(func, "action_group", "", 0, "Action Group", "Acton group to add this F-Curve into");
553
554         parm = RNA_def_pointer(func, "fcurve", "FCurve", "", "Newly created F-Curve");
555         RNA_def_function_return(func, parm);
556
557
558         func = RNA_def_function(srna, "remove", "rna_Action_fcurve_remove");
559         RNA_def_function_ui_description(func, "Remove action group");
560         RNA_def_function_flag(func, FUNC_USE_REPORTS);
561         parm = RNA_def_pointer(func, "fcurve", "FCurve", "", "F-Curve to remove");
562         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
563         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
564 }
565
566 static void rna_def_action_pose_markers(BlenderRNA *brna, PropertyRNA *cprop)
567 {
568         StructRNA *srna;
569         PropertyRNA *prop;
570
571         FunctionRNA *func;
572         PropertyRNA *parm;
573
574         RNA_def_property_srna(cprop, "ActionPoseMarkers");
575         srna = RNA_def_struct(brna, "ActionPoseMarkers", NULL);
576         RNA_def_struct_sdna(srna, "bAction");
577         RNA_def_struct_ui_text(srna, "Action Pose Markers", "Collection of timeline markers");
578
579         func = RNA_def_function(srna, "new", "rna_Action_pose_markers_new");
580         RNA_def_function_ui_description(func, "Add a pose marker to the action");
581         parm = RNA_def_string(func, "name", "Marker", 0, "", "New name for the marker (not unique)");
582         RNA_def_property_flag(parm, PROP_REQUIRED);
583
584         parm = RNA_def_pointer(func, "marker", "TimelineMarker", "", "Newly created marker");
585         RNA_def_function_return(func, parm);
586
587         func = RNA_def_function(srna, "remove", "rna_Action_pose_markers_remove");
588         RNA_def_function_ui_description(func, "Remove a timeline marker");
589         RNA_def_function_flag(func, FUNC_USE_REPORTS);
590         parm = RNA_def_pointer(func, "marker", "TimelineMarker", "", "Timeline marker to remove");
591         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
592         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
593         
594         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
595         RNA_def_property_struct_type(prop, "TimelineMarker");
596         RNA_def_property_flag(prop, PROP_EDITABLE);
597         RNA_def_property_pointer_funcs(prop, "rna_Action_active_pose_marker_get",
598                                        "rna_Action_active_pose_marker_set", NULL, NULL);
599         RNA_def_property_ui_text(prop, "Active Pose Marker", "Active pose marker for this action");
600         
601         prop = RNA_def_property(srna, "active_index", PROP_INT, PROP_UNSIGNED);
602         RNA_def_property_int_sdna(prop, NULL, "active_marker");
603         RNA_def_property_int_funcs(prop, "rna_Action_active_pose_marker_index_get",
604                                    "rna_Action_active_pose_marker_index_set", "rna_Action_active_pose_marker_index_range");
605         RNA_def_property_ui_text(prop, "Active Pose Marker Index", "Index of active pose marker");
606 }
607
608 static void rna_def_action(BlenderRNA *brna)
609 {
610         StructRNA *srna;
611         PropertyRNA *prop;
612         
613         srna = RNA_def_struct(brna, "Action", "ID");
614         RNA_def_struct_sdna(srna, "bAction");
615         RNA_def_struct_ui_text(srna, "Action", "A collection of F-Curves for animation");
616         RNA_def_struct_ui_icon(srna, ICON_ACTION);
617         
618         /* collections */
619         prop = RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
620         RNA_def_property_collection_sdna(prop, NULL, "curves", NULL);
621         RNA_def_property_struct_type(prop, "FCurve");
622         RNA_def_property_ui_text(prop, "F-Curves", "The individual F-Curves that make up the action");
623         rna_def_action_fcurves(brna, prop);
624         
625         prop = RNA_def_property(srna, "groups", PROP_COLLECTION, PROP_NONE);
626         RNA_def_property_collection_sdna(prop, NULL, "groups", NULL);
627         RNA_def_property_struct_type(prop, "ActionGroup");
628         RNA_def_property_ui_text(prop, "Groups", "Convenient groupings of F-Curves");
629         rna_def_action_groups(brna, prop);
630         
631         prop = RNA_def_property(srna, "pose_markers", PROP_COLLECTION, PROP_NONE);
632         RNA_def_property_collection_sdna(prop, NULL, "markers", NULL);
633         RNA_def_property_struct_type(prop, "TimelineMarker");
634         RNA_def_property_ui_text(prop, "Pose Markers", "Markers specific to this action, for labeling poses");
635         rna_def_action_pose_markers(brna, prop);
636         
637         /* properties */
638         prop = RNA_def_float_vector(srna, "frame_range", 2, NULL, 0, 0, "Frame Range",
639                                     "The final frame range of all F-Curves within this action", 0, 0);
640         RNA_def_property_float_funcs(prop, "rna_Action_frame_range_get", NULL, NULL);
641         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
642         
643         /* special "type" limiter - should not really be edited in general,
644          * but is still available/editable in 'emergencies' */
645         prop = RNA_def_property(srna, "id_root", PROP_ENUM, PROP_NONE);
646         RNA_def_property_enum_sdna(prop, NULL, "idroot");
647         RNA_def_property_enum_items(prop, id_type_items);
648         RNA_def_property_ui_text(prop, "ID Root Type",
649                                  "Type of ID block that action can be used on - "
650                                  "DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING");
651         
652         /* API calls */
653         RNA_api_action(srna);
654 }
655
656 /* --------- */
657
658 void RNA_def_action(BlenderRNA *brna)
659 {
660         rna_def_action(brna);
661         rna_def_action_group(brna);
662         rna_def_dopesheet(brna);
663 }
664
665
666 #endif