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