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