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