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