=bmesh= merge from trunk at r36529
[blender.git] / source / blender / makesrna / intern / rna_nla.c
1 /*
2  * $Id: rna_nla.c 21537 2009-07-11 22:22:53Z gsrb3d $
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2009), Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/makesrna/intern/rna_nla.c
26  *  \ingroup RNA
27  */
28
29
30 #include <stdlib.h>
31
32 #include "RNA_define.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_anim_types.h"
37 #include "DNA_action_types.h"
38 #include "DNA_scene_types.h"
39
40 #include "MEM_guardedalloc.h"
41
42 #include "WM_api.h"
43 #include "WM_types.h"
44
45 #ifdef RNA_RUNTIME
46
47 #include <stdio.h>
48 #include <math.h>
49
50 /* needed for some of the validation stuff... */
51 #include "BKE_animsys.h"
52 #include "BKE_nla.h"
53
54 #include "ED_anim_api.h"
55
56 /* temp constant defined for these funcs only... */
57 #define NLASTRIP_MIN_LEN_THRESH         0.1f
58
59 static void rna_NlaStrip_name_set(PointerRNA *ptr, const char *value)
60 {
61         NlaStrip *data= (NlaStrip *)ptr->data;
62         
63         /* copy the name first */
64         BLI_strncpy(data->name, value, sizeof(data->name));
65         
66         /* validate if there's enough info to do so */
67         if (ptr->id.data) {
68                 AnimData *adt= BKE_animdata_from_id(ptr->id.data);
69                 BKE_nlastrip_validate_name(adt, data);
70         }
71 }
72
73 static char *rna_NlaStrip_path(PointerRNA *ptr)
74 {
75         NlaStrip *strip= (NlaStrip *)ptr->data;
76         AnimData *adt= BKE_animdata_from_id(ptr->id.data);
77         
78         /* if we're attached to AnimData, try to resolve path back to AnimData */
79         if (adt) {
80                 NlaTrack *nlt;
81                 NlaStrip *nls;
82                 
83                 for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next) {
84                         for (nls = nlt->strips.first; nls; nls = nls->next) {
85                                 if (nls == strip) {
86                                         // XXX but if we animate like this, the control will never work...
87                                         return BLI_sprintfN("animation_data.nla_tracks[\"%s\"].strips[\"%s\"]", nlt->name, strip->name);
88                                 }
89                         }
90                 }
91         }
92         
93         /* no path */
94         return "";
95 }
96
97 static void rna_NlaStrip_transform_update(Main *bmain, Scene *scene, PointerRNA *ptr)
98 {
99         NlaStrip *strip= (NlaStrip*)ptr->data;
100
101         BKE_nlameta_flush_transforms(strip);
102 }
103
104 static void rna_NlaStrip_start_frame_set(PointerRNA *ptr, float value)
105 {
106         NlaStrip *data= (NlaStrip*)ptr->data;
107         
108         /* clamp value to lie within valid limits 
109          *      - cannot start past the end of the strip + some flexibility threshold
110          *      - cannot start before the previous strip (if present) ends
111          *              -> but if it was a transition, we could go up to the start of the strip + some flexibility threshold
112          *              as long as we re-adjust the transition afterwards
113          *      - minimum frame is -MAXFRAME so that we don't get clipping on frame 0
114          */
115         if (data->prev) {
116                 if (data->prev->type == NLASTRIP_TYPE_TRANSITION) {
117                         CLAMP(value, data->prev->start+NLASTRIP_MIN_LEN_THRESH, data->end-NLASTRIP_MIN_LEN_THRESH);
118                         
119                         /* readjust the transition to stick to the endpoints of the action-clips */
120                         data->prev->end= value;
121                 }
122                 else {
123                         CLAMP(value, data->prev->end, data->end-NLASTRIP_MIN_LEN_THRESH);
124                 }
125         }
126         else {
127                 CLAMP(value, MINAFRAME, data->end);
128         }
129         data->start= value;
130 }
131
132 static void rna_NlaStrip_end_frame_set(PointerRNA *ptr, float value)
133 {
134         NlaStrip *data= (NlaStrip*)ptr->data;
135         
136         /* clamp value to lie within valid limits
137          *      - must not have zero or negative length strip, so cannot start before the first frame 
138          *        + some minimum-strip-length threshold
139          *      - cannot end later than the start of the next strip (if present)
140          *              -> but if it was a transition, we could go up to the start of the end - some flexibility threshold
141          *              as long as we re-adjust the transition afterwards
142          */
143         if (data->next) {
144                 if (data->next->type == NLASTRIP_TYPE_TRANSITION) {
145                         CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, data->next->end-NLASTRIP_MIN_LEN_THRESH);
146                         
147                         /* readjust the transition to stick to the endpoints of the action-clips */
148                         data->next->start= value;
149                 }
150                 else {
151                         CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, data->next->start);
152                 }
153         }
154         else {
155                 CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, MAXFRAME);
156         }
157         data->end= value;
158         
159         
160         /* calculate the lengths the strip and its action (if applicable) */
161         if (data->type == NLASTRIP_TYPE_CLIP) {
162                 float len, actlen;
163                 
164                 len= data->end - data->start;
165                 actlen= data->actend - data->actstart;
166                 if (IS_EQF(actlen, 0.0f)) actlen= 1.0f;
167                 
168                 /* now, adjust the 'scale' setting to reflect this (so that this change can be valid) */
169                 data->scale= len / ((actlen) * data->repeat);
170         }
171 }
172
173 static void rna_NlaStrip_scale_set(PointerRNA *ptr, float value)
174 {
175         NlaStrip *data= (NlaStrip*)ptr->data;
176         
177         /* set scale value */
178         CLAMP(value, 0.0001f, 1000.0f); /* NOTE: these need to be synced with the values in the property definition in rna_def_nlastrip() */
179         data->scale= value;
180         
181         /* adjust the strip extents in response to this */
182         BKE_nlastrip_recalculate_bounds(data);
183 }
184
185 static void rna_NlaStrip_repeat_set(PointerRNA *ptr, float value)
186 {
187         NlaStrip *data= (NlaStrip*)ptr->data;
188         
189         /* set repeat value */
190         CLAMP(value, 0.01f, 1000.0f); /* NOTE: these need to be synced with the values in the property definition in rna_def_nlastrip() */
191         data->repeat= value;
192         
193         /* adjust the strip extents in response to this */
194         BKE_nlastrip_recalculate_bounds(data);
195 }
196
197 static void rna_NlaStrip_blend_in_set(PointerRNA *ptr, float value)
198 {
199         NlaStrip *data= (NlaStrip*)ptr->data;
200         float len;
201         
202         /* blend-in is limited to the length of the strip, and also cannot overlap with blendout */
203         len= (data->end - data->start) - data->blendout;
204         CLAMP(value, 0, len);
205         
206         data->blendin= value;
207 }
208
209 static void rna_NlaStrip_blend_out_set(PointerRNA *ptr, float value)
210 {
211         NlaStrip *data= (NlaStrip*)ptr->data;
212         float len;
213         
214         /* blend-out is limited to the length of the strip */
215         len= (data->end - data->start);
216         CLAMP(value, 0, len);
217         
218         /* it also cannot overlap with blendin */
219         if ((len - value) < data->blendin)
220                 value= len - data->blendin;
221         
222         data->blendout= value;
223 }
224
225 static void rna_NlaStrip_action_start_frame_set(PointerRNA *ptr, float value)
226 {
227         NlaStrip *data= (NlaStrip*)ptr->data;
228         
229         /* prevent start frame from occurring after end of action */
230         CLAMP(value, MINAFRAME, data->actend);
231         data->actstart= value;
232         
233         /* adjust the strip extents in response to this */
234         // TODO: should the strip be moved backwards instead as a special case?
235         BKE_nlastrip_recalculate_bounds(data);
236 }
237
238 static void rna_NlaStrip_action_end_frame_set(PointerRNA *ptr, float value)
239 {
240         NlaStrip *data= (NlaStrip*)ptr->data;
241         
242         /* prevent end frame from starting before start of action */
243         CLAMP(value, data->actstart, MAXFRAME);
244         data->actend= value;
245         
246         /* adjust the strip extents in response to this */
247         BKE_nlastrip_recalculate_bounds(data);
248 }
249
250 static void rna_NlaStrip_animated_influence_set(PointerRNA *ptr, int value)
251 {
252         NlaStrip *data= (NlaStrip*)ptr->data;
253         
254         if (value) {
255                 /* set the flag, then make sure a curve for this exists */
256                 data->flag |= NLASTRIP_FLAG_USR_INFLUENCE;
257                 BKE_nlastrip_validate_fcurves(data);
258         }
259         else
260                 data->flag &= ~NLASTRIP_FLAG_USR_INFLUENCE;
261 }
262
263 static void rna_NlaStrip_animated_time_set(PointerRNA *ptr, int value)
264 {
265         NlaStrip *data= (NlaStrip*)ptr->data;
266         
267         if (value) {
268                 /* set the flag, then make sure a curve for this exists */
269                 data->flag |= NLASTRIP_FLAG_USR_TIME;
270                 BKE_nlastrip_validate_fcurves(data);
271         }
272         else
273                 data->flag &= ~NLASTRIP_FLAG_USR_TIME;
274 }
275
276 static NlaStrip *rna_NlaStrip_new(NlaTrack *track, bContext *C, ReportList *reports, const char *name, int start, bAction *action)
277 {
278         NlaStrip *strip = add_nlastrip(action);
279         
280         if (strip == NULL) {
281                 BKE_reportf(reports, RPT_ERROR, "Unable to create new strip.");
282                 return NULL;
283         }
284         
285         strip->end += (start - strip->start);
286         strip->start = start;
287         
288         if (BKE_nlastrips_add_strip(&track->strips, strip) == 0) {
289                 BKE_reportf(reports, RPT_ERROR, "Unable to add strip. Track doesn't have any space to accommodate this new strip.");
290                 free_nlastrip(NULL, strip);
291                 return NULL;
292         }
293         
294         /* create dummy AnimData block so that BKE_nlastrip_validate_name() 
295          * can be used to ensure a valid name, as we don't have one here...
296          *      - only the nla_tracks list is needed there, which we aim to reverse engineer here...
297          */
298         {
299                 AnimData adt = {NULL};
300                 NlaTrack *nlt, *nlt_p;
301                 
302                 /* 'first' NLA track is found by going back up chain of given track's parents until we fall off */
303                 nlt_p = track; nlt = track;
304                 while ((nlt = nlt->prev) != NULL)
305                         nlt_p = nlt;
306                 adt.nla_tracks.first = nlt_p;
307                 
308                 /* do the same thing to find the last track */
309                 nlt_p = track; nlt = track;
310                 while ((nlt = nlt->next) != NULL)
311                         nlt_p = nlt;
312                 adt.nla_tracks.last = nlt_p;
313                 
314                 /* now we can just auto-name as usual */
315                 BKE_nlastrip_validate_name(&adt, strip);
316         }
317         
318         WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_ADDED, NULL);
319         
320         return strip;
321 }
322
323 static void rna_NlaStrip_remove(NlaTrack *track, bContext *C, ReportList *reports, NlaStrip *strip)
324 {
325         if(BLI_findindex(&track->strips, strip) == -1) {
326                 BKE_reportf(reports, RPT_ERROR, "NLA's Strip '%s' not found in track '%s'", strip->name, track->name);
327                 return;
328         }
329         else {
330                 free_nlastrip(&track->strips, strip);
331                 WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_REMOVED, NULL);
332         }
333 }
334
335 #else
336
337 /* enum defines exported for rna_animation.c */
338 EnumPropertyItem nla_mode_blend_items[] = {
339         {NLASTRIP_MODE_REPLACE, "REPLACE", 0, "Replace", "Result strip replaces the accumulated results by amount specified by influence"},
340         {NLASTRIP_MODE_ADD, "ADD", 0, "Add", "Weighted result of strip is added to the accumulated results"},
341         {NLASTRIP_MODE_SUBTRACT, "SUBTRACT", 0, "Subtract", "Weighted result of strip is removed from the accumulated results"},
342         {NLASTRIP_MODE_MULTIPLY, "MULITPLY", 0, "Multiply", "Weighted result of strip is multiplied with the accumulated results"},
343         {0, NULL, 0, NULL, NULL}};
344 EnumPropertyItem nla_mode_extend_items[] = {
345         {NLASTRIP_EXTEND_NOTHING, "NOTHING", 0, "Nothing", "Strip has no influence past its extents"},
346         {NLASTRIP_EXTEND_HOLD, "HOLD", 0, "Hold", "Hold the first frame if no previous strips in track, and always hold last frame"},
347         {NLASTRIP_EXTEND_HOLD_FORWARD, "HOLD_FORWARD", 0, "Hold Forward", "Only hold last frame"},
348         {0, NULL, 0, NULL, NULL}};
349
350 static void rna_def_nlastrip(BlenderRNA *brna)
351 {
352         StructRNA *srna;
353         PropertyRNA *prop;
354         
355                 /* enum defs */
356         static EnumPropertyItem prop_type_items[] = {
357                 {NLASTRIP_TYPE_CLIP, "CLIP", 0, "Action Clip", "NLA Strip references some Action"},
358                 {NLASTRIP_TYPE_TRANSITION, "TRANSITION", 0, "Transition", "NLA Strip 'transitions' between adjacent strips"},
359                 {NLASTRIP_TYPE_META, "META", 0, "Meta", "NLA Strip acts as a container for adjacent strips"},
360                 {0, NULL, 0, NULL, NULL}};
361         
362         /* struct definition */
363         srna= RNA_def_struct(brna, "NlaStrip", NULL);
364         RNA_def_struct_ui_text(srna, "NLA Strip", "A container referencing an existing Action");
365         RNA_def_struct_path_func(srna, "rna_NlaStrip_path");
366         RNA_def_struct_ui_icon(srna, ICON_NLA); // XXX
367         
368         /* name property */
369         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
370         RNA_def_property_ui_text(prop, "Name", "");
371         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_NlaStrip_name_set");
372         RNA_def_struct_name_property(srna, prop);
373         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
374         
375         /* Enums */
376         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
377         RNA_def_property_enum_sdna(prop, NULL, "type");
378         RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now, not editable, since this is dangerous
379         RNA_def_property_enum_items(prop, prop_type_items);
380         RNA_def_property_ui_text(prop, "Type", "Type of NLA Strip");
381         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
382         
383         prop= RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
384         RNA_def_property_enum_sdna(prop, NULL, "extendmode");
385         RNA_def_property_enum_items(prop, nla_mode_extend_items);
386         RNA_def_property_ui_text(prop, "Extrapolation", "Action to take for gaps past the strip extents");
387         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
388         
389         prop= RNA_def_property(srna, "blend_type", PROP_ENUM, PROP_NONE);
390         RNA_def_property_enum_sdna(prop, NULL, "blendmode");
391         RNA_def_property_enum_items(prop, nla_mode_blend_items);
392         RNA_def_property_ui_text(prop, "Blending", "Method used for combining strip's result with accumulated result");
393         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
394         
395         /* Strip extents */
396         prop= RNA_def_property(srna, "frame_start", PROP_FLOAT, PROP_TIME);
397         RNA_def_property_float_sdna(prop, NULL, "start");
398         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_start_frame_set", NULL);
399         RNA_def_property_ui_text(prop, "Start Frame", "");
400         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update");
401         
402         prop= RNA_def_property(srna, "frame_end", PROP_FLOAT, PROP_TIME);
403         RNA_def_property_float_sdna(prop, NULL, "end");
404         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_end_frame_set", NULL);
405         RNA_def_property_ui_text(prop, "End Frame", "");
406         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update");
407         
408         /* Blending */
409         prop= RNA_def_property(srna, "blend_in", PROP_FLOAT, PROP_NONE);
410         RNA_def_property_float_sdna(prop, NULL, "blendin");
411         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_in_set", NULL);
412         RNA_def_property_ui_text(prop, "Blend In", "Number of frames at start of strip to fade in influence");
413         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
414         
415         prop= RNA_def_property(srna, "blend_out", PROP_FLOAT, PROP_NONE);
416         RNA_def_property_float_sdna(prop, NULL, "blendout");
417         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_out_set", NULL);
418         RNA_def_property_ui_text(prop, "Blend Out", "");
419         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
420         
421         prop= RNA_def_property(srna, "use_auto_blend", PROP_BOOLEAN, PROP_NONE);
422         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_AUTO_BLENDS);
423         RNA_def_property_ui_text(prop, "Auto Blend In/Out", "Number of frames for Blending In/Out is automatically determined from overlapping strips");
424         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
425         
426         /* Action */
427         prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
428         RNA_def_property_pointer_sdna(prop, NULL, "act");
429         RNA_def_property_pointer_funcs(prop, NULL, NULL, NULL, "rna_Action_id_poll");
430         RNA_def_property_flag(prop, PROP_EDITABLE); 
431         RNA_def_property_ui_text(prop, "Action", "Action referenced by this strip");
432         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
433         
434         /* Action extents */
435         prop= RNA_def_property(srna, "action_frame_start", PROP_FLOAT, PROP_TIME);
436         RNA_def_property_float_sdna(prop, NULL, "actstart");
437         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_start_frame_set", NULL);
438         RNA_def_property_ui_text(prop, "Action Start Frame", "");
439         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
440         
441         prop= RNA_def_property(srna, "action_frame_end", PROP_FLOAT, PROP_TIME);
442         RNA_def_property_float_sdna(prop, NULL, "actend");
443         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_end_frame_set", NULL);
444         RNA_def_property_ui_text(prop, "Action End Frame", "");
445         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
446         
447         /* Action Reuse */
448         prop= RNA_def_property(srna, "repeat", PROP_FLOAT, PROP_NONE);
449         RNA_def_property_float_sdna(prop, NULL, "repeat"); 
450         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_repeat_set", NULL);
451         RNA_def_property_range(prop, 0.1f, 1000.0f); /* these limits have currently be chosen arbitarily, but could be extended (minimum should still be > 0 though) if needed... */
452         RNA_def_property_ui_text(prop, "Repeat", "Number of times to repeat the action range");
453         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
454         
455         prop= RNA_def_property(srna, "scale", PROP_FLOAT, PROP_NONE);
456         RNA_def_property_float_sdna(prop, NULL, "scale"); 
457         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_scale_set", NULL);
458         RNA_def_property_range(prop, 0.0001f, 1000.0f); /* these limits can be extended, but beyond this, we can get some crazy+annoying bugs due to numeric errors */
459         RNA_def_property_ui_text(prop, "Scale", "Scaling factor for action");
460         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
461         
462         /* Strip's F-Curves */
463         prop= RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
464         RNA_def_property_struct_type(prop, "FCurve");
465         RNA_def_property_ui_text(prop, "F-Curves", "F-Curves for controlling the strip's influence and timing");
466         
467         /* Strip's F-Modifiers */
468         prop= RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
469         RNA_def_property_struct_type(prop, "FModifier");
470         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting all the F-Curves in the referenced Action");
471         
472         /* Strip's Sub-Strips (for Meta-Strips) */
473         prop= RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
474         RNA_def_property_struct_type(prop, "NlaStrip");
475         RNA_def_property_ui_text(prop, "NLA Strips", "NLA Strips that this strip acts as a container for (if it is of type Meta)");
476         
477         /* Settings - Values necessary for evaluation */
478         prop= RNA_def_property(srna, "influence", PROP_FLOAT, PROP_NONE);
479         RNA_def_property_range(prop, 0.0f, 1.0f);
480         RNA_def_property_ui_text(prop, "Influence", "Amount the strip contributes to the current result");
481         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
482         
483         prop= RNA_def_property(srna, "strip_time", PROP_FLOAT, PROP_TIME);
484         RNA_def_property_ui_text(prop, "Strip Time", "Frame of referenced Action to evaluate");
485         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
486         
487                 // TODO: should the animated_influence/time settings be animatable themselves?
488         prop= RNA_def_property(srna, "use_animated_influence", PROP_BOOLEAN, PROP_NONE);
489         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_INFLUENCE);
490         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_influence_set");
491         RNA_def_property_ui_text(prop, "Animated Influence", "Influence setting is controlled by an F-Curve rather than automatically determined");
492         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
493         
494         prop= RNA_def_property(srna, "use_animated_time", PROP_BOOLEAN, PROP_NONE);
495         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME);
496         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_time_set");
497         RNA_def_property_ui_text(prop, "Animated Strip Time", "Strip time is controlled by an F-Curve rather than automatically determined");
498         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
499         
500         prop= RNA_def_property(srna, "use_animated_time_cyclic", PROP_BOOLEAN, PROP_NONE);
501         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME_CYCLIC);
502         RNA_def_property_ui_text(prop, "Cyclic Strip Time", "Cycle the animated time within the action start & end");
503         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update"); // is there a better update flag?
504         
505         /* settings */
506         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
507         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
508         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_ACTIVE);
509         RNA_def_property_ui_text(prop, "Active", "NLA Strip is active");
510         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
511         
512         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
513         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_SELECT);
514         RNA_def_property_ui_text(prop, "Select", "NLA Strip is selected");
515         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
516         
517         prop= RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
518         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_MUTED);
519         RNA_def_property_ui_text(prop, "Muted", "NLA Strip is not evaluated");
520         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
521         
522         prop= RNA_def_property(srna, "use_reverse", PROP_BOOLEAN, PROP_NONE);
523         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_REVERSE);
524         RNA_def_property_ui_text(prop, "Reversed", "NLA Strip is played back in reverse order (only when timing is automatically determined)");
525         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
526         
527         // TODO: 
528         // - sync length
529 }
530
531 static void rna_api_nlatrack_strips(BlenderRNA *brna, PropertyRNA *cprop)
532 {
533         StructRNA *srna;
534         PropertyRNA *parm;
535         FunctionRNA *func;
536
537         RNA_def_property_srna(cprop, "NlaStrips");
538         srna= RNA_def_struct(brna, "NlaStrips", NULL);
539         RNA_def_struct_sdna(srna, "NlaTrack");
540         RNA_def_struct_ui_text(srna, "Nla Strips", "Collection of Nla Strips");
541
542         func = RNA_def_function(srna, "new", "rna_NlaStrip_new");
543         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
544         RNA_def_function_ui_description(func, "Add a new Action-Clip strip to the track");
545         parm= RNA_def_string(func, "name", "NlaStrip", 0, "", "Name for the NLA Strips.");
546         RNA_def_property_flag(parm, PROP_REQUIRED);
547         parm = RNA_def_int(func, "start", 0, INT_MIN, INT_MAX, "Start Frame", "Start frame for this strip.", INT_MIN, INT_MAX);
548         RNA_def_property_flag(parm, PROP_REQUIRED);
549         parm = RNA_def_pointer(func, "action", "Action", "", "Action to assign to this strip.");
550         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
551         /* return type */
552         parm = RNA_def_pointer(func, "strip", "NlaStrip", "", "New NLA Strip.");
553         RNA_def_function_return(func, parm);
554
555         func = RNA_def_function(srna, "remove", "rna_NlaStrip_remove");
556         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
557         RNA_def_function_ui_description(func, "Remove a NLA Strip.");
558         parm = RNA_def_pointer(func, "strip", "NlaStrip", "", "NLA Strip to remove.");
559         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
560 }
561
562 static void rna_def_nlatrack(BlenderRNA *brna)
563 {
564         StructRNA *srna;
565         PropertyRNA *prop;
566         
567         srna= RNA_def_struct(brna, "NlaTrack", NULL);
568         RNA_def_struct_ui_text(srna, "NLA Track", "A animation layer containing Actions referenced as NLA strips");
569         RNA_def_struct_ui_icon(srna, ICON_NLA);
570         
571         /* strips collection */
572         prop= RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
573         RNA_def_property_struct_type(prop, "NlaStrip");
574         RNA_def_property_ui_text(prop, "NLA Strips", "NLA Strips on this NLA-track");
575
576         rna_api_nlatrack_strips(brna, prop);
577
578         /* name property */
579         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
580         RNA_def_property_ui_text(prop, "Name", "");
581         RNA_def_struct_name_property(srna, prop);
582         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
583         
584         /* settings */
585         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
586         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
587         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_ACTIVE);
588         RNA_def_property_ui_text(prop, "Active", "NLA Track is active");
589         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
590         
591         prop= RNA_def_property(srna, "is_solo", PROP_BOOLEAN, PROP_NONE);
592         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
593         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SOLO);
594         RNA_def_property_ui_text(prop, "Solo", "NLA Track is evaluated itself (i.e. active Action and all other NLA Tracks in the same AnimData block are disabled)");
595         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
596         
597         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
598         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SELECTED);
599         RNA_def_property_ui_text(prop, "Select", "NLA Track is selected");
600         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
601         
602         prop= RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
603         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_MUTED);
604         RNA_def_property_ui_text(prop, "Muted", "NLA Track is not evaluated");
605         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
606
607         prop= RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
608         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_PROTECTED);
609         RNA_def_property_ui_text(prop, "Locked", "NLA Track is locked");
610         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
611 }
612
613 /* --------- */
614
615 void RNA_def_nla(BlenderRNA *brna)
616 {
617         rna_def_nlatrack(brna);
618         rna_def_nlastrip(brna);
619 }
620
621
622 #endif