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