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