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