Merged changes in the trunk up to revision 34193.
[blender.git] / source / blender / makesrna / intern / rna_action.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2008), Roland Hess, Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28
29 #include "rna_internal.h"
30
31 #include "DNA_anim_types.h"
32 #include "DNA_action_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "MEM_guardedalloc.h"
36
37 #include "BKE_action.h"
38
39 #include "WM_types.h"
40
41
42 #ifdef RNA_RUNTIME
43
44 #include "ED_keyframing.h"
45 #include "BKE_fcurve.h"
46
47 static void rna_ActionGroup_channels_next(CollectionPropertyIterator *iter)
48 {
49         ListBaseIterator *internal= iter->internal;
50         FCurve *fcu= (FCurve*)internal->link;
51         bActionGroup *grp= fcu->grp;
52         
53         /* only continue if the next F-Curve (if existant) belongs in the same group */
54         if ((fcu->next) && (fcu->next->grp == grp))
55                 internal->link= (Link*)fcu->next;
56         else
57                 internal->link= NULL;
58                 
59         iter->valid= (internal->link != NULL);
60 }
61
62 static bActionGroup *rna_Action_groups_new(bAction *act, const char name[])
63 {
64         return action_groups_add_new(act, name);
65 }
66
67 static void rna_Action_groups_remove(bAction *act, ReportList *reports, bActionGroup *agrp)
68 {
69         FCurve *fcu, *fcn;
70         
71         /* try to remove the F-Curve from the action */
72         if (!BLI_remlink_safe(&act->groups, agrp)) {
73                 BKE_reportf(reports, RPT_ERROR, "ActionGroup '%s' not found in action '%s'", agrp->name, act->id.name+2);
74                 return;
75         }
76
77         /* move every one one of the group's F-Curves out into the Action again */
78         for (fcu= agrp->channels.first; (fcu) && (fcu->grp==agrp); fcu=fcn) {
79                 fcn= fcu->next;
80                 
81                 /* remove from group */
82                 action_groups_remove_channel(act, fcu);
83                 
84                 /* tack onto the end */
85                 BLI_addtail(&act->curves, fcu);
86         }
87         
88         /* XXX, invalidates PyObject */
89         MEM_freeN(agrp); 
90 }
91
92 static FCurve *rna_Action_fcurve_new(bAction *act, ReportList *reports, const char *data_path, int index, const char *group)
93 {
94         if(group && group[0]=='\0') group= NULL;
95
96         if(data_path[0] == '\0') {
97                 BKE_report(reports, RPT_ERROR, "FCurve data path empty, invalid argument");
98                 return NULL;
99         }
100
101         /* annoying, check if this exists */
102         if(verify_fcurve(act, group, data_path, index, 0)) {
103                 BKE_reportf(reports, RPT_ERROR, "FCurve '%s[%d]' already exists in action '%s'", data_path, index, act->id.name+2);
104                 return NULL;
105         }
106         return verify_fcurve(act, group, data_path, index, 1);
107 }
108
109 static void rna_Action_fcurve_remove(bAction *act, ReportList *reports, FCurve *fcu)
110 {
111         if (fcu->grp) {
112                 if (BLI_findindex(&act->groups, fcu->grp) == -1) {
113                         BKE_reportf(reports, RPT_ERROR, "FCurve's ActionGroup '%s' not found in action '%s'", fcu->grp->name, act->id.name+2);
114                         return;
115                 }
116                 
117                 action_groups_remove_channel(act, fcu);
118                 free_fcurve(fcu);
119         }
120         else {
121                 if (BLI_findindex(&act->curves, fcu) == -1) {
122                         BKE_reportf(reports, RPT_ERROR, "FCurve not found in action '%s'", act->id.name+2);
123                         return;
124                 }
125                 
126                 BLI_remlink(&act->curves, fcu);
127                 free_fcurve(fcu);
128         }
129 }
130
131 static TimeMarker *rna_Action_pose_markers_new(bAction *act, ReportList *reports, const char name[])
132 {
133         TimeMarker *marker = MEM_callocN(sizeof(TimeMarker), "TimeMarker");
134         marker->flag= 1;
135         marker->frame= 1;
136         BLI_strncpy(marker->name, name, sizeof(marker->name));
137         BLI_addtail(&act->markers, marker);
138         return marker;
139 }
140
141 static void rna_Action_pose_markers_remove(bAction *act, ReportList *reports, TimeMarker *marker)
142 {
143         if (!BLI_remlink_safe(&act->markers, marker)) {
144                 BKE_reportf(reports, RPT_ERROR, "TimelineMarker '%s' not found in action '%s'", marker->name, act->id.name+2);
145                 return;
146         }
147
148         /* XXX, invalidates PyObject */
149         MEM_freeN(marker);
150 }
151
152 static void rna_Action_frame_range_get(PointerRNA *ptr,float *values)
153 {
154         calc_action_range(ptr->id.data, values, values+1, 1);
155 }
156
157 #else
158
159 static void rna_def_dopesheet(BlenderRNA *brna)
160 {
161         StructRNA *srna;
162         PropertyRNA *prop;
163
164         srna= RNA_def_struct(brna, "DopeSheet", NULL);
165         RNA_def_struct_sdna(srna, "bDopeSheet");
166         RNA_def_struct_ui_text(srna, "DopeSheet", "Settings for filtering the channels shown in Animation Editors");
167         
168         /* Source of DopeSheet data */
169         prop= RNA_def_property(srna, "source", PROP_POINTER, PROP_NONE);
170         RNA_def_property_struct_type(prop, "ID");
171         RNA_def_property_ui_text(prop, "Source", "ID-Block representing source data, currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil)");
172         
173         /* General Filtering Settings */
174         prop= RNA_def_property(srna, "show_only_selected", PROP_BOOLEAN, PROP_NONE);
175         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_ONLYSEL);
176         RNA_def_property_ui_text(prop, "Only Selected", "Only include channels relating to selected objects and data");
177         RNA_def_property_ui_icon(prop, ICON_RESTRICT_SELECT_OFF, 0);
178         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
179         
180         prop= RNA_def_property(srna, "show_hidden", PROP_BOOLEAN, PROP_NONE);
181         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_INCL_HIDDEN);
182         RNA_def_property_ui_text(prop, "Display Hidden", "Include channels from objects/bone that aren't visible");
183         RNA_def_property_ui_icon(prop, ICON_GHOST_ENABLED, 0);
184         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
185         
186         /* Object Group Filtering Settings */
187         prop= RNA_def_property(srna, "show_only_group_objects", PROP_BOOLEAN, PROP_NONE);
188         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_ONLYOBGROUP);
189         RNA_def_property_ui_text(prop, "Only Objects in Group", "Only include channels from Objects in the specified Group");
190         RNA_def_property_ui_icon(prop, ICON_GROUP, 0);
191         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
192         
193         prop= RNA_def_property(srna, "filter_group", PROP_POINTER, PROP_NONE);
194         RNA_def_property_pointer_sdna(prop, NULL, "filter_grp");
195         RNA_def_property_flag(prop, PROP_EDITABLE);
196         RNA_def_property_ui_text(prop, "Filtering Group", "Group that included Object should be a member of");
197         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
198         
199         /* NLA Specific Settings */
200         prop= RNA_def_property(srna, "show_missing_nla", PROP_BOOLEAN, PROP_NONE);
201         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NLA_NOACT);
202         RNA_def_property_ui_text(prop, "Include Missing NLA", "Include Animation Data blocks with no NLA data. (NLA Editor only)");
203         RNA_def_property_ui_icon(prop, ICON_ACTION, 0);
204         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
205         
206         /* Summary Settings (DopeSheet editors only) */
207         prop= RNA_def_property(srna, "show_summary", PROP_BOOLEAN, PROP_NONE);
208         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_SUMMARY);
209         RNA_def_property_ui_text(prop, "Display Summary", "Display an additional 'summary' line. (DopeSheet Editors only)");
210         RNA_def_property_ui_icon(prop, ICON_BORDERMOVE, 0);
211         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
212         
213         prop= RNA_def_property(srna, "show_expanded_summary", PROP_BOOLEAN, PROP_NONE);
214         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADS_FLAG_SUMMARY_COLLAPSED);
215         RNA_def_property_ui_text(prop, "Collapse Summary", "Collapse summary when shown, so all other channels get hidden. (DopeSheet Editors Only)");
216         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
217         
218         
219         /* General DataType Filtering Settings */
220         prop= RNA_def_property(srna, "show_transforms", PROP_BOOLEAN, PROP_NONE);
221         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOOBJ);
222         RNA_def_property_ui_text(prop, "Display Transforms", "Include visualization of Object-level Animation data (mostly Transforms)");
223         RNA_def_property_ui_icon(prop, ICON_MANIPUL, 0); // XXX?
224         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
225         
226         prop= RNA_def_property(srna, "show_shapekeys", PROP_BOOLEAN, PROP_NONE);
227         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSHAPEKEYS);
228         RNA_def_property_ui_text(prop, "Display Shapekeys", "Include visualization of ShapeKey related Animation data");
229         RNA_def_property_ui_icon(prop, ICON_SHAPEKEY_DATA, 0);
230         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
231         
232         prop= RNA_def_property(srna, "show_meshes", PROP_BOOLEAN, PROP_NONE);
233         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMESH);
234         RNA_def_property_ui_text(prop, "Display Meshes", "Include visualization of Mesh related Animation data");
235         RNA_def_property_ui_icon(prop, ICON_MESH_DATA, 0);
236         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
237         
238         prop= RNA_def_property(srna, "show_lattices", PROP_BOOLEAN, PROP_NONE);
239         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLAT);
240         RNA_def_property_ui_text(prop, "Display Lattices", "Include visualization of Lattice related Animation data");
241         RNA_def_property_ui_icon(prop, ICON_LATTICE_DATA, 0);
242         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
243         
244         prop= RNA_def_property(srna, "show_cameras", PROP_BOOLEAN, PROP_NONE);
245         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOCAM);
246         RNA_def_property_ui_text(prop, "Display Camera", "Include visualization of Camera related Animation data");
247         RNA_def_property_ui_icon(prop, ICON_CAMERA_DATA, 0);
248         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
249         
250         prop= RNA_def_property(srna, "show_materials", PROP_BOOLEAN, PROP_NONE);
251         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMAT);
252         RNA_def_property_ui_text(prop, "Display Material", "Include visualization of Material related Animation data");
253         RNA_def_property_ui_icon(prop, ICON_MATERIAL_DATA, 0);
254         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
255         
256         prop= RNA_def_property(srna, "show_lamps", PROP_BOOLEAN, PROP_NONE);
257         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLAM);
258         RNA_def_property_ui_text(prop, "Display Lamp", "Include visualization of Lamp related Animation data");
259         RNA_def_property_ui_icon(prop, ICON_LAMP_DATA, 0);
260         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
261         
262         prop= RNA_def_property(srna, "show_linestyles", PROP_BOOLEAN, PROP_NONE);
263         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLINESTYLE);
264         RNA_def_property_ui_text(prop, "Display Line Style", "Include visualization of Line Style related Animation data");
265         RNA_def_property_ui_icon(prop, ICON_BRUSH_DATA, 0); /* FIXME */
266         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
267         
268         prop= RNA_def_property(srna, "show_textures", PROP_BOOLEAN, PROP_NONE);
269         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOTEX);
270         RNA_def_property_ui_text(prop, "Display Texture", "Include visualization of Texture related Animation data");
271         RNA_def_property_ui_icon(prop, ICON_TEXTURE_DATA, 0);
272         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
273         
274         prop= RNA_def_property(srna, "show_curves", PROP_BOOLEAN, PROP_NONE);
275         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOCUR);
276         RNA_def_property_ui_text(prop, "Display Curve", "Include visualization of Curve related Animation data");
277         RNA_def_property_ui_icon(prop, ICON_CURVE_DATA, 0);
278         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
279         
280         prop= RNA_def_property(srna, "show_worlds", PROP_BOOLEAN, PROP_NONE);
281         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOWOR);
282         RNA_def_property_ui_text(prop, "Display World", "Include visualization of World related Animation data");
283         RNA_def_property_ui_icon(prop, ICON_WORLD_DATA, 0);
284         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
285         
286         prop= RNA_def_property(srna, "show_scenes", PROP_BOOLEAN, PROP_NONE);
287         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSCE);
288         RNA_def_property_ui_text(prop, "Display Scene", "Include visualization of Scene related Animation data");
289         RNA_def_property_ui_icon(prop, ICON_SCENE_DATA, 0);
290         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
291         
292         prop= RNA_def_property(srna, "show_particles", PROP_BOOLEAN, PROP_NONE);
293         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOPART);
294         RNA_def_property_ui_text(prop, "Display Particle", "Include visualization of Particle related Animation data");
295         RNA_def_property_ui_icon(prop, ICON_PARTICLE_DATA, 0);
296         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
297         
298         prop= RNA_def_property(srna, "show_metaballs", PROP_BOOLEAN, PROP_NONE);
299         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMBA);
300         RNA_def_property_ui_text(prop, "Display Metaball", "Include visualization of Metaball related Animation data");
301         RNA_def_property_ui_icon(prop, ICON_META_DATA, 0);
302         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
303         
304         prop= RNA_def_property(srna, "show_armatures", PROP_BOOLEAN, PROP_NONE);
305         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOARM);
306         RNA_def_property_ui_text(prop, "Display Armature", "Include visualization of Armature related Animation data");
307         RNA_def_property_ui_icon(prop, ICON_ARMATURE_DATA, 0);
308         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
309         
310         prop= RNA_def_property(srna, "show_nodes", PROP_BOOLEAN, PROP_NONE);
311         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NONTREE);
312         RNA_def_property_ui_text(prop, "Display Node", "Include visualization of Node related Animation data");
313         RNA_def_property_ui_icon(prop, ICON_NODETREE, 0);
314         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
315 }
316
317 static void rna_def_action_group(BlenderRNA *brna)
318 {
319         StructRNA *srna;
320         PropertyRNA *prop;
321         
322         srna= RNA_def_struct(brna, "ActionGroup", NULL);
323         RNA_def_struct_sdna(srna, "bActionGroup");
324         RNA_def_struct_ui_text(srna, "Action Group", "Groups of F-Curves");
325         
326         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
327         RNA_def_property_ui_text(prop, "Name", "");
328         RNA_def_struct_name_property(srna, prop);
329         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
330         
331         /* WARNING: be very careful when working with this list, since the endpoint is not
332          * defined like a standard ListBase. Adding/removing channels from this list needs
333          * extreme care, otherwise the F-Curve list running through adjacent groups does
334          * not match up with the one stored in the Action, resulting in curves which do not
335          * show up in animation editors. In extreme cases, animation may also selectively 
336          * fail to play back correctly. 
337          *
338          * If such changes are required, these MUST go through the API functions for manipulating
339          * these F-Curve groupings. Also, note that groups only apply in actions ONLY.
340          */
341         prop= RNA_def_property(srna, "channels", PROP_COLLECTION, PROP_NONE);
342         RNA_def_property_collection_sdna(prop, NULL, "channels", NULL);
343         RNA_def_property_struct_type(prop, "FCurve");
344         RNA_def_property_collection_funcs(prop, 0, "rna_ActionGroup_channels_next", 0, 0, 0, 0, 0);
345         RNA_def_property_ui_text(prop, "Channels", "F-Curves in this group");
346         
347         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
348         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_SELECTED);
349         RNA_def_property_ui_text(prop, "Select", "Action Group is selected");
350         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_SELECTED, NULL);
351         
352         prop= RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
353         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_PROTECTED);
354         RNA_def_property_ui_text(prop, "Lock", "Action Group is locked");
355         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
356         
357         prop= RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
358         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_EXPANDED);
359         RNA_def_property_ui_text(prop, "Expanded", "Action Group is expanded");
360         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
361         
362         prop= RNA_def_property(srna, "custom_color", PROP_INT, PROP_NONE);
363         RNA_def_property_int_sdna(prop, NULL, "customCol");
364         RNA_def_property_ui_text(prop, "Custom Color", "Index of custom color set");
365         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
366 }
367
368 /* fcurve.keyframe_points */
369 static void rna_def_action_groups(BlenderRNA *brna, PropertyRNA *cprop)
370 {
371         StructRNA *srna;
372
373         FunctionRNA *func;
374         PropertyRNA *parm;
375
376         RNA_def_property_srna(cprop, "ActionGroups");
377         srna= RNA_def_struct(brna, "ActionGroups", NULL);
378         RNA_def_struct_sdna(srna, "bAction");
379         RNA_def_struct_ui_text(srna, "Action Groups", "Collection of action groups");
380
381         func= RNA_def_function(srna, "new", "rna_Action_groups_new");
382         RNA_def_function_ui_description(func, "Add a keyframe to the curve.");
383         parm= RNA_def_string(func, "name", "Group", 0, "", "New name for the action group.");
384         RNA_def_property_flag(parm, PROP_REQUIRED);
385
386         parm= RNA_def_pointer(func, "action_group", "ActionGroup", "", "Newly created action group");
387         RNA_def_function_return(func, parm);
388
389
390         func= RNA_def_function(srna, "remove", "rna_Action_groups_remove");
391         RNA_def_function_ui_description(func, "Remove action group.");
392         RNA_def_function_flag(func, FUNC_USE_REPORTS);
393         parm= RNA_def_pointer(func, "action_group", "ActionGroup", "", "Action group to remove.");
394         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
395 }
396
397 static void rna_def_action_fcurves(BlenderRNA *brna, PropertyRNA *cprop)
398 {
399         StructRNA *srna;
400
401         FunctionRNA *func;
402         PropertyRNA *parm;
403
404         RNA_def_property_srna(cprop, "ActionFCurves");
405         srna= RNA_def_struct(brna, "ActionFCurves", NULL);
406         RNA_def_struct_sdna(srna, "bAction");
407         RNA_def_struct_ui_text(srna, "Action FCurves", "Collection of action fcurves");
408
409         func= RNA_def_function(srna, "new", "rna_Action_fcurve_new");
410         RNA_def_function_ui_description(func, "Add a keyframe to the curve.");
411         RNA_def_function_flag(func, FUNC_USE_REPORTS);
412         parm= RNA_def_string(func, "data_path", "", 0, "Data Path", "FCurve data path to use.");
413         RNA_def_property_flag(parm, PROP_REQUIRED);
414         parm= RNA_def_int(func, "array_index", 0, 0, INT_MAX, "Index", "Array index.", 0, INT_MAX);
415         parm= RNA_def_string(func, "action_group", "", 0, "Action Group", "Acton group to add this fcurve into.");
416
417         parm= RNA_def_pointer(func, "fcurve", "FCurve", "", "Newly created fcurve");
418         RNA_def_function_return(func, parm);
419
420
421         func= RNA_def_function(srna, "remove", "rna_Action_fcurve_remove");
422         RNA_def_function_ui_description(func, "Remove action group.");
423         RNA_def_function_flag(func, FUNC_USE_REPORTS);
424         parm= RNA_def_pointer(func, "fcurve", "FCurve", "", "FCurve to remove.");
425         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
426 }
427
428 static void rna_def_action_pose_markers(BlenderRNA *brna, PropertyRNA *cprop)
429 {
430         StructRNA *srna;
431
432         FunctionRNA *func;
433         PropertyRNA *parm;
434
435         RNA_def_property_srna(cprop, "ActionPoseMarkers");
436         srna= RNA_def_struct(brna, "ActionPoseMarkers", NULL);
437         RNA_def_struct_sdna(srna, "bAction");
438         RNA_def_struct_ui_text(srna, "Action Pose Markers", "Collection of timeline markers");
439
440         func= RNA_def_function(srna, "new", "rna_Action_pose_markers_new");
441         RNA_def_function_ui_description(func, "Add a pose marker to the action.");
442         RNA_def_function_flag(func, FUNC_USE_REPORTS);
443         parm= RNA_def_string(func, "name", "Marker", 0, "", "New name for the marker (not unique).");
444         RNA_def_property_flag(parm, PROP_REQUIRED);
445
446         parm= RNA_def_pointer(func, "marker", "TimelineMarker", "", "Newly created marker");
447         RNA_def_function_return(func, parm);
448
449         func= RNA_def_function(srna, "remove", "rna_Action_pose_markers_remove");
450         RNA_def_function_ui_description(func, "Remove a timeline marker.");
451         RNA_def_function_flag(func, FUNC_USE_REPORTS);
452         parm= RNA_def_pointer(func, "marker", "TimelineMarker", "", "Timeline marker to remove.");
453         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
454 }
455
456 static void rna_def_action(BlenderRNA *brna)
457 {
458         StructRNA *srna;
459         PropertyRNA *prop;
460
461         srna= RNA_def_struct(brna, "Action", "ID");
462         RNA_def_struct_sdna(srna, "bAction");
463         RNA_def_struct_ui_text(srna, "Action", "A collection of F-Curves for animation");
464         RNA_def_struct_ui_icon(srna, ICON_ACTION);
465
466         prop= RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
467         RNA_def_property_collection_sdna(prop, NULL, "curves", NULL);
468         RNA_def_property_struct_type(prop, "FCurve");
469         RNA_def_property_ui_text(prop, "F-Curves", "The individual F-Curves that make up the Action");
470         rna_def_action_fcurves(brna, prop);
471
472         prop= RNA_def_property(srna, "groups", PROP_COLLECTION, PROP_NONE);
473         RNA_def_property_collection_sdna(prop, NULL, "groups", NULL);
474         RNA_def_property_struct_type(prop, "ActionGroup");
475         RNA_def_property_ui_text(prop, "Groups", "Convenient groupings of F-Curves");
476         rna_def_action_groups(brna, prop);
477
478         prop= RNA_def_property(srna, "pose_markers", PROP_COLLECTION, PROP_NONE);
479         RNA_def_property_collection_sdna(prop, NULL, "markers", NULL);
480         RNA_def_property_struct_type(prop, "TimelineMarker");
481         RNA_def_property_ui_text(prop, "Pose Markers", "Markers specific to this Action, for labeling poses");
482         rna_def_action_pose_markers(brna, prop);
483
484         prop= RNA_def_float_vector(srna, "frame_range" , 2 , NULL , 0, 0, "Frame Range" , "The final frame range of all fcurves within this action" , 0 , 0);
485         RNA_def_property_float_funcs(prop, "rna_Action_frame_range_get" , NULL, NULL);
486         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
487
488         RNA_api_action(srna);
489 }
490
491 /* --------- */
492
493 void RNA_def_action(BlenderRNA *brna)
494 {
495         rna_def_action(brna);
496         rna_def_action_group(brna);
497         rna_def_dopesheet(brna);
498 }
499
500
501 #endif