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