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