4a537f8da425fea3b20bdd524ed76c3de7c019ab
[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 data-block 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",
399                                  "Include visualization of animation data related to data-blocks linked to modifiers");
400         RNA_def_property_ui_icon(prop, ICON_MODIFIER, 0);
401         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
402         
403         prop = RNA_def_property(srna, "show_meshes", PROP_BOOLEAN, PROP_NONE);
404         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMESH);
405         RNA_def_property_ui_text(prop, "Display Meshes", "Include visualization of mesh related animation data");
406         RNA_def_property_ui_icon(prop, ICON_MESH_DATA, 0);
407         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
408         
409         prop = RNA_def_property(srna, "show_lattices", PROP_BOOLEAN, PROP_NONE);
410         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLAT);
411         RNA_def_property_ui_text(prop, "Display Lattices", "Include visualization of lattice related animation data");
412         RNA_def_property_ui_icon(prop, ICON_LATTICE_DATA, 0);
413         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
414         
415         prop = RNA_def_property(srna, "show_cameras", PROP_BOOLEAN, PROP_NONE);
416         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOCAM);
417         RNA_def_property_ui_text(prop, "Display Camera", "Include visualization of camera related animation data");
418         RNA_def_property_ui_icon(prop, ICON_CAMERA_DATA, 0);
419         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
420         
421         prop = RNA_def_property(srna, "show_materials", PROP_BOOLEAN, PROP_NONE);
422         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMAT);
423         RNA_def_property_ui_text(prop, "Display Material", "Include visualization of material related animation data");
424         RNA_def_property_ui_icon(prop, ICON_MATERIAL_DATA, 0);
425         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
426         
427         prop = RNA_def_property(srna, "show_lamps", PROP_BOOLEAN, PROP_NONE);
428         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLAM);
429         RNA_def_property_ui_text(prop, "Display Lamp", "Include visualization of lamp related animation data");
430         RNA_def_property_ui_icon(prop, ICON_LAMP_DATA, 0);
431         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
432         
433         prop = RNA_def_property(srna, "show_linestyles", PROP_BOOLEAN, PROP_NONE);
434         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLINESTYLE);
435         RNA_def_property_ui_text(prop, "Display Line Style", "Include visualization of Line Style related Animation data");
436         RNA_def_property_ui_icon(prop, ICON_LINE_DATA, 0);
437         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
438         
439         prop = RNA_def_property(srna, "show_textures", PROP_BOOLEAN, PROP_NONE);
440         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOTEX);
441         RNA_def_property_ui_text(prop, "Display Texture", "Include visualization of texture related animation data");
442         RNA_def_property_ui_icon(prop, ICON_TEXTURE_DATA, 0);
443         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
444         
445         prop = RNA_def_property(srna, "show_curves", PROP_BOOLEAN, PROP_NONE);
446         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOCUR);
447         RNA_def_property_ui_text(prop, "Display Curve", "Include visualization of curve related animation data");
448         RNA_def_property_ui_icon(prop, ICON_CURVE_DATA, 0);
449         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
450         
451         prop = RNA_def_property(srna, "show_worlds", PROP_BOOLEAN, PROP_NONE);
452         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOWOR);
453         RNA_def_property_ui_text(prop, "Display World", "Include visualization of world related animation data");
454         RNA_def_property_ui_icon(prop, ICON_WORLD_DATA, 0);
455         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
456         
457         prop = RNA_def_property(srna, "show_scenes", PROP_BOOLEAN, PROP_NONE);
458         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSCE);
459         RNA_def_property_ui_text(prop, "Display Scene", "Include visualization of scene related animation data");
460         RNA_def_property_ui_icon(prop, ICON_SCENE_DATA, 0);
461         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
462         
463         prop = RNA_def_property(srna, "show_particles", PROP_BOOLEAN, PROP_NONE);
464         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOPART);
465         RNA_def_property_ui_text(prop, "Display Particle", "Include visualization of particle related animation data");
466         RNA_def_property_ui_icon(prop, ICON_PARTICLE_DATA, 0);
467         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
468         
469         prop = RNA_def_property(srna, "show_metaballs", PROP_BOOLEAN, PROP_NONE);
470         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMBA);
471         RNA_def_property_ui_text(prop, "Display Metaball", "Include visualization of metaball related animation data");
472         RNA_def_property_ui_icon(prop, ICON_META_DATA, 0);
473         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
474         
475         prop = RNA_def_property(srna, "show_armatures", PROP_BOOLEAN, PROP_NONE);
476         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOARM);
477         RNA_def_property_ui_text(prop, "Display Armature", "Include visualization of armature related animation data");
478         RNA_def_property_ui_icon(prop, ICON_ARMATURE_DATA, 0);
479         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
480         
481         prop = RNA_def_property(srna, "show_nodes", PROP_BOOLEAN, PROP_NONE);
482         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NONTREE);
483         RNA_def_property_ui_text(prop, "Display Node", "Include visualization of node related animation data");
484         RNA_def_property_ui_icon(prop, ICON_NODETREE, 0);
485         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
486
487         prop = RNA_def_property(srna, "show_speakers", PROP_BOOLEAN, PROP_NONE);
488         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSPK);
489         RNA_def_property_ui_text(prop, "Display Speaker", "Include visualization of speaker related animation data");
490         RNA_def_property_ui_icon(prop, ICON_SPEAKER, 0);
491         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
492         
493         prop = RNA_def_property(srna, "show_gpencil", PROP_BOOLEAN, PROP_NONE);
494         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOGPENCIL);
495         RNA_def_property_ui_text(prop, "Display Grease Pencil", "Include visualization of Grease Pencil related animation data and frames");
496         RNA_def_property_ui_icon(prop, ICON_GREASEPENCIL, 0);
497         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
498 }
499
500 static void rna_def_action_group(BlenderRNA *brna)
501 {
502         StructRNA *srna;
503         PropertyRNA *prop;
504         
505         srna = RNA_def_struct(brna, "ActionGroup", NULL);
506         RNA_def_struct_sdna(srna, "bActionGroup");
507         RNA_def_struct_ui_text(srna, "Action Group", "Groups of F-Curves");
508         
509         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
510         RNA_def_property_ui_text(prop, "Name", "");
511         RNA_def_struct_name_property(srna, prop);
512         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
513         
514         /* WARNING: be very careful when working with this list, since the endpoint is not
515          * defined like a standard ListBase. Adding/removing channels from this list needs
516          * extreme care, otherwise the F-Curve list running through adjacent groups does
517          * not match up with the one stored in the Action, resulting in curves which do not
518          * show up in animation editors. In extreme cases, animation may also selectively
519          * fail to play back correctly.
520          *
521          * If such changes are required, these MUST go through the API functions for manipulating
522          * these F-Curve groupings. Also, note that groups only apply in actions ONLY.
523          */
524         prop = RNA_def_property(srna, "channels", PROP_COLLECTION, PROP_NONE);
525         RNA_def_property_collection_sdna(prop, NULL, "channels", NULL);
526         RNA_def_property_struct_type(prop, "FCurve");
527         RNA_def_property_collection_funcs(prop, NULL, "rna_ActionGroup_channels_next", NULL, NULL, NULL, NULL, NULL, NULL);
528         RNA_def_property_ui_text(prop, "Channels", "F-Curves in this group");
529         
530         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
531         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_SELECTED);
532         RNA_def_property_ui_text(prop, "Select", "Action group is selected");
533         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_SELECTED, NULL);
534         
535         prop = RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
536         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_PROTECTED);
537         RNA_def_property_ui_text(prop, "Lock", "Action group is locked");
538         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
539         
540         prop = RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
541         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_EXPANDED);
542         RNA_def_property_ui_text(prop, "Expanded", "Action group is expanded");
543         RNA_def_property_update(prop, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
544         
545         /* color set */
546         rna_def_actionbone_group_common(srna, NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
547 }
548
549 /* fcurve.keyframe_points */
550 static void rna_def_action_groups(BlenderRNA *brna, PropertyRNA *cprop)
551 {
552         StructRNA *srna;
553
554         FunctionRNA *func;
555         PropertyRNA *parm;
556
557         RNA_def_property_srna(cprop, "ActionGroups");
558         srna = RNA_def_struct(brna, "ActionGroups", NULL);
559         RNA_def_struct_sdna(srna, "bAction");
560         RNA_def_struct_ui_text(srna, "Action Groups", "Collection of action groups");
561
562         func = RNA_def_function(srna, "new", "rna_Action_groups_new");
563         RNA_def_function_ui_description(func, "Create a new action group and add it to the action");
564         parm = RNA_def_string(func, "name", "Group", 0, "", "New name for the action group");
565         RNA_def_property_flag(parm, PROP_REQUIRED);
566
567         parm = RNA_def_pointer(func, "action_group", "ActionGroup", "", "Newly created action group");
568         RNA_def_function_return(func, parm);
569
570
571         func = RNA_def_function(srna, "remove", "rna_Action_groups_remove");
572         RNA_def_function_ui_description(func, "Remove action group");
573         RNA_def_function_flag(func, FUNC_USE_REPORTS);
574         parm = RNA_def_pointer(func, "action_group", "ActionGroup", "", "Action group to remove");
575         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
576         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
577 }
578
579 static void rna_def_action_fcurves(BlenderRNA *brna, PropertyRNA *cprop)
580 {
581         StructRNA *srna;
582
583         FunctionRNA *func;
584         PropertyRNA *parm;
585
586         RNA_def_property_srna(cprop, "ActionFCurves");
587         srna = RNA_def_struct(brna, "ActionFCurves", NULL);
588         RNA_def_struct_sdna(srna, "bAction");
589         RNA_def_struct_ui_text(srna, "Action F-Curves", "Collection of action F-Curves");
590
591         /* Action.fcurves.new(...) */
592         func = RNA_def_function(srna, "new", "rna_Action_fcurve_new");
593         RNA_def_function_ui_description(func, "Add an F-Curve to the action");
594         RNA_def_function_flag(func, FUNC_USE_REPORTS);
595         parm = RNA_def_string(func, "data_path", NULL, 0, "Data Path", "F-Curve data path to use");
596         RNA_def_property_flag(parm, PROP_REQUIRED);
597         RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "Array index", 0, INT_MAX);
598         RNA_def_string(func, "action_group", NULL, 0, "Action Group", "Acton group to add this F-Curve into");
599
600         parm = RNA_def_pointer(func, "fcurve", "FCurve", "", "Newly created F-Curve");
601         RNA_def_function_return(func, parm);
602
603         /* Action.fcurves.find(...) */
604         func = RNA_def_function(srna, "find", "rna_Action_fcurve_find");
605         RNA_def_function_ui_description(func, "Find an F-Curve. Note that this function performs a linear scan "
606                                         "of all F-Curves in the action.");
607         RNA_def_function_flag(func, FUNC_USE_REPORTS);
608         parm = RNA_def_string(func, "data_path", NULL, 0, "Data Path", "F-Curve data path");
609         RNA_def_property_flag(parm, PROP_REQUIRED);
610         RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "Array index", 0, INT_MAX);
611
612         parm = RNA_def_pointer(func, "fcurve", "FCurve", "", "The found F-Curve, or None if it doesn't exist");
613         RNA_def_function_return(func, parm);
614
615         /* Action.fcurves.remove(...) */
616         func = RNA_def_function(srna, "remove", "rna_Action_fcurve_remove");
617         RNA_def_function_ui_description(func, "Remove action group");
618         RNA_def_function_flag(func, FUNC_USE_REPORTS);
619         parm = RNA_def_pointer(func, "fcurve", "FCurve", "", "F-Curve to remove");
620         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
621         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
622 }
623
624 static void rna_def_action_pose_markers(BlenderRNA *brna, PropertyRNA *cprop)
625 {
626         StructRNA *srna;
627         PropertyRNA *prop;
628
629         FunctionRNA *func;
630         PropertyRNA *parm;
631
632         RNA_def_property_srna(cprop, "ActionPoseMarkers");
633         srna = RNA_def_struct(brna, "ActionPoseMarkers", NULL);
634         RNA_def_struct_sdna(srna, "bAction");
635         RNA_def_struct_ui_text(srna, "Action Pose Markers", "Collection of timeline markers");
636
637         func = RNA_def_function(srna, "new", "rna_Action_pose_markers_new");
638         RNA_def_function_ui_description(func, "Add a pose marker to the action");
639         parm = RNA_def_string(func, "name", "Marker", 0, NULL, "New name for the marker (not unique)");
640         RNA_def_property_flag(parm, PROP_REQUIRED);
641
642         parm = RNA_def_pointer(func, "marker", "TimelineMarker", "", "Newly created marker");
643         RNA_def_function_return(func, parm);
644
645         func = RNA_def_function(srna, "remove", "rna_Action_pose_markers_remove");
646         RNA_def_function_ui_description(func, "Remove a timeline marker");
647         RNA_def_function_flag(func, FUNC_USE_REPORTS);
648         parm = RNA_def_pointer(func, "marker", "TimelineMarker", "", "Timeline marker to remove");
649         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
650         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
651         
652         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
653         RNA_def_property_struct_type(prop, "TimelineMarker");
654         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_LIB_EXCEPTION);
655         RNA_def_property_pointer_funcs(prop, "rna_Action_active_pose_marker_get",
656                                        "rna_Action_active_pose_marker_set", NULL, NULL);
657         RNA_def_property_ui_text(prop, "Active Pose Marker", "Active pose marker for this action");
658         
659         prop = RNA_def_property(srna, "active_index", PROP_INT, PROP_UNSIGNED);
660         RNA_def_property_int_sdna(prop, NULL, "active_marker");
661         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
662         RNA_def_property_int_funcs(prop, "rna_Action_active_pose_marker_index_get",
663                                    "rna_Action_active_pose_marker_index_set", "rna_Action_active_pose_marker_index_range");
664         RNA_def_property_ui_text(prop, "Active Pose Marker Index", "Index of active pose marker");
665 }
666
667 static void rna_def_action(BlenderRNA *brna)
668 {
669         StructRNA *srna;
670         PropertyRNA *prop;
671         
672         srna = RNA_def_struct(brna, "Action", "ID");
673         RNA_def_struct_sdna(srna, "bAction");
674         RNA_def_struct_ui_text(srna, "Action", "A collection of F-Curves for animation");
675         RNA_def_struct_ui_icon(srna, ICON_ACTION);
676         
677         /* collections */
678         prop = RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
679         RNA_def_property_collection_sdna(prop, NULL, "curves", NULL);
680         RNA_def_property_struct_type(prop, "FCurve");
681         RNA_def_property_ui_text(prop, "F-Curves", "The individual F-Curves that make up the action");
682         rna_def_action_fcurves(brna, prop);
683         
684         prop = RNA_def_property(srna, "groups", PROP_COLLECTION, PROP_NONE);
685         RNA_def_property_collection_sdna(prop, NULL, "groups", NULL);
686         RNA_def_property_struct_type(prop, "ActionGroup");
687         RNA_def_property_ui_text(prop, "Groups", "Convenient groupings of F-Curves");
688         rna_def_action_groups(brna, prop);
689         
690         prop = RNA_def_property(srna, "pose_markers", PROP_COLLECTION, PROP_NONE);
691         RNA_def_property_collection_sdna(prop, NULL, "markers", NULL);
692         RNA_def_property_struct_type(prop, "TimelineMarker");
693         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION); /* T45689 - so that the list isn't greyed out; adding/removing is still banned though */
694         RNA_def_property_ui_text(prop, "Pose Markers", "Markers specific to this action, for labeling poses");
695         rna_def_action_pose_markers(brna, prop);
696         
697         /* properties */
698         prop = RNA_def_float_vector(srna, "frame_range", 2, NULL, 0, 0, "Frame Range",
699                                     "The final frame range of all F-Curves within this action", 0, 0);
700         RNA_def_property_float_funcs(prop, "rna_Action_frame_range_get", NULL, NULL);
701         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
702         
703         /* special "type" limiter - should not really be edited in general,
704          * but is still available/editable in 'emergencies' */
705         prop = RNA_def_property(srna, "id_root", PROP_ENUM, PROP_NONE);
706         RNA_def_property_enum_sdna(prop, NULL, "idroot");
707         RNA_def_property_enum_items(prop, id_type_items);
708         RNA_def_property_ui_text(prop, "ID Root Type",
709                                  "Type of ID block that action can be used on - "
710                                  "DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING");
711         
712         /* API calls */
713         RNA_api_action(srna);
714 }
715
716 /* --------- */
717
718 void RNA_def_action(BlenderRNA *brna)
719 {
720         rna_def_action(brna);
721         rna_def_action_group(brna);
722         rna_def_dopesheet(brna);
723 }
724
725
726 #endif