Merging trunk up to r38932.
[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         // XXX: make this obsolete?
262         prop= RNA_def_property(srna, "source", PROP_POINTER, PROP_NONE);
263         RNA_def_property_struct_type(prop, "ID");
264         RNA_def_property_ui_text(prop, "Source", "ID-Block representing source data, currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil)");
265         
266         /* Show datablock filters */
267         prop= RNA_def_property(srna, "show_datablock_filters", PROP_BOOLEAN, PROP_NONE);
268         RNA_def_property_boolean_sdna(prop, NULL, "flag", ADS_FLAG_SHOW_DBFILTERS);
269         RNA_def_property_ui_text(prop, "Show Datablock Filters", "Show options for whether channels related to certain types of data are included");
270         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN, NULL);
271         
272         /* General Filtering Settings */
273         prop= RNA_def_property(srna, "show_only_selected", PROP_BOOLEAN, PROP_NONE);
274         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_ONLYSEL);
275         RNA_def_property_ui_text(prop, "Only Selected", "Only include channels relating to selected objects and data");
276         RNA_def_property_ui_icon(prop, ICON_RESTRICT_SELECT_OFF, 0);
277         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
278         
279         prop= RNA_def_property(srna, "show_hidden", PROP_BOOLEAN, PROP_NONE);
280         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_INCL_HIDDEN);
281         RNA_def_property_ui_text(prop, "Display Hidden", "Include channels from objects/bone that aren't visible");
282         RNA_def_property_ui_icon(prop, ICON_GHOST_ENABLED, 0);
283         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
284         
285         /* Object Group Filtering Settings */
286         prop= RNA_def_property(srna, "show_only_group_objects", PROP_BOOLEAN, PROP_NONE);
287         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_ONLYOBGROUP);
288         RNA_def_property_ui_text(prop, "Only Objects in Group", "Only include channels from Objects in the specified Group");
289         RNA_def_property_ui_icon(prop, ICON_GROUP, 0);
290         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
291         
292         prop= RNA_def_property(srna, "filter_group", PROP_POINTER, PROP_NONE);
293         RNA_def_property_pointer_sdna(prop, NULL, "filter_grp");
294         RNA_def_property_flag(prop, PROP_EDITABLE);
295         RNA_def_property_ui_text(prop, "Filtering Group", "Group that included Object should be a member of");
296         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
297         
298         /* FCurve Display Name Search Settings */
299         prop= RNA_def_property(srna, "show_only_matching_fcurves", PROP_BOOLEAN, PROP_NONE);
300         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_BY_FCU_NAME);
301         RNA_def_property_ui_text(prop, "Only Matching F-Curves", "Only include F-Curves with names containing search text");
302         RNA_def_property_ui_icon(prop, ICON_VIEWZOOM, 0);
303         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
304         
305         prop= RNA_def_property(srna, "filter_fcurve_name", PROP_STRING, PROP_NONE);
306         RNA_def_property_string_sdna(prop, NULL, "searchstr");
307         RNA_def_property_ui_text(prop, "F-Curve Name Filter", "F-Curve live filtering string");
308         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
309         
310         /* NLA Specific Settings */
311         prop= RNA_def_property(srna, "show_missing_nla", PROP_BOOLEAN, PROP_NONE);
312         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NLA_NOACT);
313         RNA_def_property_ui_text(prop, "Include Missing NLA", "Include Animation Data blocks with no NLA data. (NLA Editor only)");
314         RNA_def_property_ui_icon(prop, ICON_ACTION, 0);
315         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
316         
317         /* Summary Settings (DopeSheet editors only) */
318         prop= RNA_def_property(srna, "show_summary", PROP_BOOLEAN, PROP_NONE);
319         RNA_def_property_boolean_sdna(prop, NULL, "filterflag", ADS_FILTER_SUMMARY);
320         RNA_def_property_ui_text(prop, "Display Summary", "Display an additional 'summary' line. (DopeSheet Editors only)");
321         RNA_def_property_ui_icon(prop, ICON_BORDERMOVE, 0);
322         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
323         
324         prop= RNA_def_property(srna, "show_expanded_summary", PROP_BOOLEAN, PROP_NONE);
325         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADS_FLAG_SUMMARY_COLLAPSED);
326         RNA_def_property_ui_text(prop, "Collapse Summary", "Collapse summary when shown, so all other channels get hidden. (DopeSheet Editors Only)");
327         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
328         
329         
330         /* General DataType Filtering Settings */
331         prop= RNA_def_property(srna, "show_transforms", PROP_BOOLEAN, PROP_NONE);
332         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOOBJ);
333         RNA_def_property_ui_text(prop, "Display Transforms", "Include visualization of Object-level Animation data (mostly Transforms)");
334         RNA_def_property_ui_icon(prop, ICON_MANIPUL, 0); // XXX?
335         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
336         
337         prop= RNA_def_property(srna, "show_shapekeys", PROP_BOOLEAN, PROP_NONE);
338         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSHAPEKEYS);
339         RNA_def_property_ui_text(prop, "Display Shapekeys", "Include visualization of ShapeKey related Animation data");
340         RNA_def_property_ui_icon(prop, ICON_SHAPEKEY_DATA, 0);
341         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
342         
343         prop= RNA_def_property(srna, "show_meshes", PROP_BOOLEAN, PROP_NONE);
344         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMESH);
345         RNA_def_property_ui_text(prop, "Display Meshes", "Include visualization of Mesh related Animation data");
346         RNA_def_property_ui_icon(prop, ICON_MESH_DATA, 0);
347         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
348         
349         prop= RNA_def_property(srna, "show_lattices", PROP_BOOLEAN, PROP_NONE);
350         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLAT);
351         RNA_def_property_ui_text(prop, "Display Lattices", "Include visualization of Lattice related Animation data");
352         RNA_def_property_ui_icon(prop, ICON_LATTICE_DATA, 0);
353         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
354         
355         prop= RNA_def_property(srna, "show_cameras", PROP_BOOLEAN, PROP_NONE);
356         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOCAM);
357         RNA_def_property_ui_text(prop, "Display Camera", "Include visualization of Camera related Animation data");
358         RNA_def_property_ui_icon(prop, ICON_CAMERA_DATA, 0);
359         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
360         
361         prop= RNA_def_property(srna, "show_materials", PROP_BOOLEAN, PROP_NONE);
362         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMAT);
363         RNA_def_property_ui_text(prop, "Display Material", "Include visualization of Material related Animation data");
364         RNA_def_property_ui_icon(prop, ICON_MATERIAL_DATA, 0);
365         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
366         
367         prop= RNA_def_property(srna, "show_lamps", PROP_BOOLEAN, PROP_NONE);
368         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOLAM);
369         RNA_def_property_ui_text(prop, "Display Lamp", "Include visualization of Lamp related Animation data");
370         RNA_def_property_ui_icon(prop, ICON_LAMP_DATA, 0);
371         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
372         
373         prop= RNA_def_property(srna, "show_textures", PROP_BOOLEAN, PROP_NONE);
374         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOTEX);
375         RNA_def_property_ui_text(prop, "Display Texture", "Include visualization of Texture related Animation data");
376         RNA_def_property_ui_icon(prop, ICON_TEXTURE_DATA, 0);
377         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
378         
379         prop= RNA_def_property(srna, "show_curves", PROP_BOOLEAN, PROP_NONE);
380         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOCUR);
381         RNA_def_property_ui_text(prop, "Display Curve", "Include visualization of Curve related Animation data");
382         RNA_def_property_ui_icon(prop, ICON_CURVE_DATA, 0);
383         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
384         
385         prop= RNA_def_property(srna, "show_worlds", PROP_BOOLEAN, PROP_NONE);
386         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOWOR);
387         RNA_def_property_ui_text(prop, "Display World", "Include visualization of World related Animation data");
388         RNA_def_property_ui_icon(prop, ICON_WORLD_DATA, 0);
389         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
390         
391         prop= RNA_def_property(srna, "show_scenes", PROP_BOOLEAN, PROP_NONE);
392         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSCE);
393         RNA_def_property_ui_text(prop, "Display Scene", "Include visualization of Scene related Animation data");
394         RNA_def_property_ui_icon(prop, ICON_SCENE_DATA, 0);
395         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
396         
397         prop= RNA_def_property(srna, "show_particles", PROP_BOOLEAN, PROP_NONE);
398         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOPART);
399         RNA_def_property_ui_text(prop, "Display Particle", "Include visualization of Particle related Animation data");
400         RNA_def_property_ui_icon(prop, ICON_PARTICLE_DATA, 0);
401         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
402         
403         prop= RNA_def_property(srna, "show_metaballs", PROP_BOOLEAN, PROP_NONE);
404         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOMBA);
405         RNA_def_property_ui_text(prop, "Display Metaball", "Include visualization of Metaball related Animation data");
406         RNA_def_property_ui_icon(prop, ICON_META_DATA, 0);
407         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
408         
409         prop= RNA_def_property(srna, "show_armatures", PROP_BOOLEAN, PROP_NONE);
410         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOARM);
411         RNA_def_property_ui_text(prop, "Display Armature", "Include visualization of Armature related Animation data");
412         RNA_def_property_ui_icon(prop, ICON_ARMATURE_DATA, 0);
413         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
414         
415         prop= RNA_def_property(srna, "show_nodes", PROP_BOOLEAN, PROP_NONE);
416         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NONTREE);
417         RNA_def_property_ui_text(prop, "Display Node", "Include visualization of Node related Animation data");
418         RNA_def_property_ui_icon(prop, ICON_NODETREE, 0);
419         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
420
421         prop= RNA_def_property(srna, "show_speakers", PROP_BOOLEAN, PROP_NONE);
422         RNA_def_property_boolean_negative_sdna(prop, NULL, "filterflag", ADS_FILTER_NOSPK);
423         RNA_def_property_ui_text(prop, "Display Speaker", "Include visualization of Speaker related Animation data");
424         RNA_def_property_ui_icon(prop, ICON_SPEAKER, 0);
425         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
426 }
427
428 static void rna_def_action_group(BlenderRNA *brna)
429 {
430         StructRNA *srna;
431         PropertyRNA *prop;
432         
433         srna= RNA_def_struct(brna, "ActionGroup", NULL);
434         RNA_def_struct_sdna(srna, "bActionGroup");
435         RNA_def_struct_ui_text(srna, "Action Group", "Groups of F-Curves");
436         
437         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
438         RNA_def_property_ui_text(prop, "Name", "");
439         RNA_def_struct_name_property(srna, prop);
440         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
441         
442         /* WARNING: be very careful when working with this list, since the endpoint is not
443          * defined like a standard ListBase. Adding/removing channels from this list needs
444          * extreme care, otherwise the F-Curve list running through adjacent groups does
445          * not match up with the one stored in the Action, resulting in curves which do not
446          * show up in animation editors. In extreme cases, animation may also selectively 
447          * fail to play back correctly. 
448          *
449          * If such changes are required, these MUST go through the API functions for manipulating
450          * these F-Curve groupings. Also, note that groups only apply in actions ONLY.
451          */
452         prop= RNA_def_property(srna, "channels", PROP_COLLECTION, PROP_NONE);
453         RNA_def_property_collection_sdna(prop, NULL, "channels", NULL);
454         RNA_def_property_struct_type(prop, "FCurve");
455         RNA_def_property_collection_funcs(prop, 0, "rna_ActionGroup_channels_next", 0, 0, 0, 0, 0);
456         RNA_def_property_ui_text(prop, "Channels", "F-Curves in this group");
457         
458         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
459         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_SELECTED);
460         RNA_def_property_ui_text(prop, "Select", "Action Group is selected");
461         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_SELECTED, NULL);
462         
463         prop= RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
464         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_PROTECTED);
465         RNA_def_property_ui_text(prop, "Lock", "Action Group is locked");
466         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
467         
468         prop= RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
469         RNA_def_property_boolean_sdna(prop, NULL, "flag", AGRP_EXPANDED);
470         RNA_def_property_ui_text(prop, "Expanded", "Action Group is expanded");
471         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
472         
473         prop= RNA_def_property(srna, "custom_color", PROP_INT, PROP_NONE);
474         RNA_def_property_int_sdna(prop, NULL, "customCol");
475         RNA_def_property_ui_text(prop, "Custom Color", "Index of custom color set");
476         RNA_def_property_update(prop, NC_ANIMATION|ND_ANIMCHAN|NA_EDITED, NULL);
477 }
478
479 /* fcurve.keyframe_points */
480 static void rna_def_action_groups(BlenderRNA *brna, PropertyRNA *cprop)
481 {
482         StructRNA *srna;
483
484         FunctionRNA *func;
485         PropertyRNA *parm;
486
487         RNA_def_property_srna(cprop, "ActionGroups");
488         srna= RNA_def_struct(brna, "ActionGroups", NULL);
489         RNA_def_struct_sdna(srna, "bAction");
490         RNA_def_struct_ui_text(srna, "Action Groups", "Collection of action groups");
491
492         func= RNA_def_function(srna, "new", "rna_Action_groups_new");
493         RNA_def_function_ui_description(func, "Add a keyframe to the curve.");
494         parm= RNA_def_string(func, "name", "Group", 0, "", "New name for the action group.");
495         RNA_def_property_flag(parm, PROP_REQUIRED);
496
497         parm= RNA_def_pointer(func, "action_group", "ActionGroup", "", "Newly created action group");
498         RNA_def_function_return(func, parm);
499
500
501         func= RNA_def_function(srna, "remove", "rna_Action_groups_remove");
502         RNA_def_function_ui_description(func, "Remove action group.");
503         RNA_def_function_flag(func, FUNC_USE_REPORTS);
504         parm= RNA_def_pointer(func, "action_group", "ActionGroup", "", "Action group to remove.");
505         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
506 }
507
508 static void rna_def_action_fcurves(BlenderRNA *brna, PropertyRNA *cprop)
509 {
510         StructRNA *srna;
511
512         FunctionRNA *func;
513         PropertyRNA *parm;
514
515         RNA_def_property_srna(cprop, "ActionFCurves");
516         srna= RNA_def_struct(brna, "ActionFCurves", NULL);
517         RNA_def_struct_sdna(srna, "bAction");
518         RNA_def_struct_ui_text(srna, "Action FCurves", "Collection of action fcurves");
519
520         func= RNA_def_function(srna, "new", "rna_Action_fcurve_new");
521         RNA_def_function_ui_description(func, "Add a keyframe to the curve.");
522         RNA_def_function_flag(func, FUNC_USE_REPORTS);
523         parm= RNA_def_string(func, "data_path", "", 0, "Data Path", "FCurve data path to use.");
524         RNA_def_property_flag(parm, PROP_REQUIRED);
525         RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "Array index.", 0, INT_MAX);
526         RNA_def_string(func, "action_group", "", 0, "Action Group", "Acton group to add this fcurve into.");
527
528         parm= RNA_def_pointer(func, "fcurve", "FCurve", "", "Newly created fcurve");
529         RNA_def_function_return(func, parm);
530
531
532         func= RNA_def_function(srna, "remove", "rna_Action_fcurve_remove");
533         RNA_def_function_ui_description(func, "Remove action group.");
534         RNA_def_function_flag(func, FUNC_USE_REPORTS);
535         parm= RNA_def_pointer(func, "fcurve", "FCurve", "", "FCurve to remove.");
536         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
537 }
538
539 static void rna_def_action_pose_markers(BlenderRNA *brna, PropertyRNA *cprop)
540 {
541         StructRNA *srna;
542         PropertyRNA *prop;
543
544         FunctionRNA *func;
545         PropertyRNA *parm;
546
547         RNA_def_property_srna(cprop, "ActionPoseMarkers");
548         srna= RNA_def_struct(brna, "ActionPoseMarkers", NULL);
549         RNA_def_struct_sdna(srna, "bAction");
550         RNA_def_struct_ui_text(srna, "Action Pose Markers", "Collection of timeline markers");
551
552         func= RNA_def_function(srna, "new", "rna_Action_pose_markers_new");
553         RNA_def_function_ui_description(func, "Add a pose marker to the action.");
554         RNA_def_function_flag(func, FUNC_USE_REPORTS);
555         parm= RNA_def_string(func, "name", "Marker", 0, "", "New name for the marker (not unique).");
556         RNA_def_property_flag(parm, PROP_REQUIRED);
557
558         parm= RNA_def_pointer(func, "marker", "TimelineMarker", "", "Newly created marker");
559         RNA_def_function_return(func, parm);
560
561         func= RNA_def_function(srna, "remove", "rna_Action_pose_markers_remove");
562         RNA_def_function_ui_description(func, "Remove a timeline marker.");
563         RNA_def_function_flag(func, FUNC_USE_REPORTS);
564         parm= RNA_def_pointer(func, "marker", "TimelineMarker", "", "Timeline marker to remove.");
565         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
566         
567         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
568         RNA_def_property_struct_type(prop, "TimelineMarker");
569         RNA_def_property_flag(prop, PROP_EDITABLE);
570         RNA_def_property_pointer_funcs(prop, "rna_Action_active_pose_marker_get", "rna_Action_active_pose_marker_set", NULL, NULL);
571         RNA_def_property_ui_text(prop, "Active Pose Marker", "Active pose marker for this Action");
572         
573         prop= RNA_def_property(srna, "active_index", PROP_INT, PROP_NONE);
574         RNA_def_property_int_sdna(prop, NULL, "active_marker");
575         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");
576         RNA_def_property_ui_text(prop, "Active Pose Marker Index", "Index of active pose marker");
577 }
578
579 static void rna_def_action(BlenderRNA *brna)
580 {
581         StructRNA *srna;
582         PropertyRNA *prop;
583         
584         srna= RNA_def_struct(brna, "Action", "ID");
585         RNA_def_struct_sdna(srna, "bAction");
586         RNA_def_struct_ui_text(srna, "Action", "A collection of F-Curves for animation");
587         RNA_def_struct_ui_icon(srna, ICON_ACTION);
588         
589         /* collections */
590         prop= RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
591         RNA_def_property_collection_sdna(prop, NULL, "curves", NULL);
592         RNA_def_property_struct_type(prop, "FCurve");
593         RNA_def_property_ui_text(prop, "F-Curves", "The individual F-Curves that make up the Action");
594         rna_def_action_fcurves(brna, prop);
595         
596         prop= RNA_def_property(srna, "groups", PROP_COLLECTION, PROP_NONE);
597         RNA_def_property_collection_sdna(prop, NULL, "groups", NULL);
598         RNA_def_property_struct_type(prop, "ActionGroup");
599         RNA_def_property_ui_text(prop, "Groups", "Convenient groupings of F-Curves");
600         rna_def_action_groups(brna, prop);
601         
602         prop= RNA_def_property(srna, "pose_markers", PROP_COLLECTION, PROP_NONE);
603         RNA_def_property_collection_sdna(prop, NULL, "markers", NULL);
604         RNA_def_property_struct_type(prop, "TimelineMarker");
605         RNA_def_property_ui_text(prop, "Pose Markers", "Markers specific to this Action, for labeling poses");
606         rna_def_action_pose_markers(brna, prop);
607         
608         /* properties */
609         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);
610         RNA_def_property_float_funcs(prop, "rna_Action_frame_range_get" , NULL, NULL);
611         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
612         
613         /* special "type" limiter - should not really be edited in general, but is still available/editable in 'emergencies' */
614         prop= RNA_def_property(srna, "id_root", PROP_ENUM, PROP_NONE);
615         RNA_def_property_enum_sdna(prop, NULL, "idroot");
616         RNA_def_property_enum_items(prop, id_type_items);
617         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");
618         
619         /* API calls */
620         RNA_api_action(srna);
621 }
622
623 /* --------- */
624
625 void RNA_def_action(BlenderRNA *brna)
626 {
627         rna_def_action(brna);
628         rna_def_action_group(brna);
629         rna_def_dopesheet(brna);
630 }
631
632
633 #endif