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