Merging with trunk up to r38631.
[blender.git] / source / blender / makesrna / intern / rna_nla.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (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 *UNUSED(bmain), Scene *UNUSED(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 int rna_NlaStrip_action_editable(PointerRNA *ptr)
226 {
227         NlaStrip *strip = (NlaStrip *)ptr->data;
228         
229         /* strip actions shouldn't be editable if NLA tweakmode is on */
230         if (ptr->id.data) {
231                 AnimData *adt = BKE_animdata_from_id(ptr->id.data);
232                 
233                 if (adt) {
234                         /* active action is only editable when it is not a tweaking strip */
235                         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact))
236                                 return 0;
237                 }
238         }
239         
240         /* check for clues that strip probably shouldn't be used... */
241         if (strip->flag & NLASTRIP_FLAG_TWEAKUSER)
242                 return 0;
243                 
244         /* should be ok, though we may still miss some cases */
245         return 1;
246 }
247
248 static void rna_NlaStrip_action_start_frame_set(PointerRNA *ptr, float value)
249 {
250         NlaStrip *data= (NlaStrip*)ptr->data;
251         
252         /* prevent start frame from occurring after end of action */
253         CLAMP(value, MINAFRAME, data->actend);
254         data->actstart= value;
255         
256         /* adjust the strip extents in response to this */
257         // TODO: should the strip be moved backwards instead as a special case?
258         BKE_nlastrip_recalculate_bounds(data);
259 }
260
261 static void rna_NlaStrip_action_end_frame_set(PointerRNA *ptr, float value)
262 {
263         NlaStrip *data= (NlaStrip*)ptr->data;
264         
265         /* prevent end frame from starting before start of action */
266         CLAMP(value, data->actstart, MAXFRAME);
267         data->actend= value;
268         
269         /* adjust the strip extents in response to this */
270         BKE_nlastrip_recalculate_bounds(data);
271 }
272
273 static void rna_NlaStrip_animated_influence_set(PointerRNA *ptr, int value)
274 {
275         NlaStrip *data= (NlaStrip*)ptr->data;
276         
277         if (value) {
278                 /* set the flag, then make sure a curve for this exists */
279                 data->flag |= NLASTRIP_FLAG_USR_INFLUENCE;
280                 BKE_nlastrip_validate_fcurves(data);
281         }
282         else
283                 data->flag &= ~NLASTRIP_FLAG_USR_INFLUENCE;
284 }
285
286 static void rna_NlaStrip_animated_time_set(PointerRNA *ptr, int value)
287 {
288         NlaStrip *data= (NlaStrip*)ptr->data;
289         
290         if (value) {
291                 /* set the flag, then make sure a curve for this exists */
292                 data->flag |= NLASTRIP_FLAG_USR_TIME;
293                 BKE_nlastrip_validate_fcurves(data);
294         }
295         else
296                 data->flag &= ~NLASTRIP_FLAG_USR_TIME;
297 }
298
299 static NlaStrip *rna_NlaStrip_new(NlaTrack *track, bContext *C, ReportList *reports, const char *UNUSED(name), int start, bAction *action)
300 {
301         NlaStrip *strip = add_nlastrip(action);
302         
303         if (strip == NULL) {
304                 BKE_reportf(reports, RPT_ERROR, "Unable to create new strip.");
305                 return NULL;
306         }
307         
308         strip->end += (start - strip->start);
309         strip->start = start;
310         
311         if (BKE_nlastrips_add_strip(&track->strips, strip) == 0) {
312                 BKE_reportf(reports, RPT_ERROR, "Unable to add strip. Track doesn't have any space to accommodate this new strip.");
313                 free_nlastrip(NULL, strip);
314                 return NULL;
315         }
316         
317         /* create dummy AnimData block so that BKE_nlastrip_validate_name() 
318          * can be used to ensure a valid name, as we don't have one here...
319          *      - only the nla_tracks list is needed there, which we aim to reverse engineer here...
320          */
321         {
322                 AnimData adt = {NULL};
323                 NlaTrack *nlt, *nlt_p;
324                 
325                 /* 'first' NLA track is found by going back up chain of given track's parents until we fall off */
326                 nlt_p = track; nlt = track;
327                 while ((nlt = nlt->prev) != NULL)
328                         nlt_p = nlt;
329                 adt.nla_tracks.first = nlt_p;
330                 
331                 /* do the same thing to find the last track */
332                 nlt_p = track; nlt = track;
333                 while ((nlt = nlt->next) != NULL)
334                         nlt_p = nlt;
335                 adt.nla_tracks.last = nlt_p;
336                 
337                 /* now we can just auto-name as usual */
338                 BKE_nlastrip_validate_name(&adt, strip);
339         }
340         
341         WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_ADDED, NULL);
342         
343         return strip;
344 }
345
346 static void rna_NlaStrip_remove(NlaTrack *track, bContext *C, ReportList *reports, NlaStrip *strip)
347 {
348         if(BLI_findindex(&track->strips, strip) == -1) {
349                 BKE_reportf(reports, RPT_ERROR, "NLA's Strip '%s' not found in track '%s'", strip->name, track->name);
350                 return;
351         }
352         else {
353                 free_nlastrip(&track->strips, strip);
354                 WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_REMOVED, NULL);
355         }
356 }
357
358 #else
359
360 /* enum defines exported for rna_animation.c */
361 EnumPropertyItem nla_mode_blend_items[] = {
362         {NLASTRIP_MODE_REPLACE, "REPLACE", 0, "Replace", "Result strip replaces the accumulated results by amount specified by influence"},
363         {NLASTRIP_MODE_ADD, "ADD", 0, "Add", "Weighted result of strip is added to the accumulated results"},
364         {NLASTRIP_MODE_SUBTRACT, "SUBTRACT", 0, "Subtract", "Weighted result of strip is removed from the accumulated results"},
365         {NLASTRIP_MODE_MULTIPLY, "MULITPLY", 0, "Multiply", "Weighted result of strip is multiplied with the accumulated results"},
366         {0, NULL, 0, NULL, NULL}};
367 EnumPropertyItem nla_mode_extend_items[] = {
368         {NLASTRIP_EXTEND_NOTHING, "NOTHING", 0, "Nothing", "Strip has no influence past its extents"},
369         {NLASTRIP_EXTEND_HOLD, "HOLD", 0, "Hold", "Hold the first frame if no previous strips in track, and always hold last frame"},
370         {NLASTRIP_EXTEND_HOLD_FORWARD, "HOLD_FORWARD", 0, "Hold Forward", "Only hold last frame"},
371         {0, NULL, 0, NULL, NULL}};
372
373 static void rna_def_nlastrip(BlenderRNA *brna)
374 {
375         StructRNA *srna;
376         PropertyRNA *prop;
377         
378                 /* enum defs */
379         static EnumPropertyItem prop_type_items[] = {
380                 {NLASTRIP_TYPE_CLIP, "CLIP", 0, "Action Clip", "NLA Strip references some Action"},
381                 {NLASTRIP_TYPE_TRANSITION, "TRANSITION", 0, "Transition", "NLA Strip 'transitions' between adjacent strips"},
382                 {NLASTRIP_TYPE_META, "META", 0, "Meta", "NLA Strip acts as a container for adjacent strips"},
383                 {0, NULL, 0, NULL, NULL}};
384         
385         /* struct definition */
386         srna= RNA_def_struct(brna, "NlaStrip", NULL);
387         RNA_def_struct_ui_text(srna, "NLA Strip", "A container referencing an existing Action");
388         RNA_def_struct_path_func(srna, "rna_NlaStrip_path");
389         RNA_def_struct_ui_icon(srna, ICON_NLA); // XXX
390         
391         /* name property */
392         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
393         RNA_def_property_ui_text(prop, "Name", "");
394         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_NlaStrip_name_set");
395         RNA_def_struct_name_property(srna, prop);
396         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
397         
398         /* Enums */
399         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
400         RNA_def_property_enum_sdna(prop, NULL, "type");
401         RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now, not editable, since this is dangerous
402         RNA_def_property_enum_items(prop, prop_type_items);
403         RNA_def_property_ui_text(prop, "Type", "Type of NLA Strip");
404         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
405         
406         prop= RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
407         RNA_def_property_enum_sdna(prop, NULL, "extendmode");
408         RNA_def_property_enum_items(prop, nla_mode_extend_items);
409         RNA_def_property_ui_text(prop, "Extrapolation", "Action to take for gaps past the strip extents");
410         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
411         
412         prop= RNA_def_property(srna, "blend_type", PROP_ENUM, PROP_NONE);
413         RNA_def_property_enum_sdna(prop, NULL, "blendmode");
414         RNA_def_property_enum_items(prop, nla_mode_blend_items);
415         RNA_def_property_ui_text(prop, "Blending", "Method used for combining strip's result with accumulated result");
416         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
417         
418         /* Strip extents */
419         prop= RNA_def_property(srna, "frame_start", PROP_FLOAT, PROP_TIME);
420         RNA_def_property_float_sdna(prop, NULL, "start");
421         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_start_frame_set", NULL);
422         RNA_def_property_ui_text(prop, "Start Frame", "");
423         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update");
424         
425         prop= RNA_def_property(srna, "frame_end", PROP_FLOAT, PROP_TIME);
426         RNA_def_property_float_sdna(prop, NULL, "end");
427         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_end_frame_set", NULL);
428         RNA_def_property_ui_text(prop, "End Frame", "");
429         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update");
430         
431         /* Blending */
432         prop= RNA_def_property(srna, "blend_in", PROP_FLOAT, PROP_NONE);
433         RNA_def_property_float_sdna(prop, NULL, "blendin");
434         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_in_set", NULL);
435         RNA_def_property_ui_text(prop, "Blend In", "Number of frames at start of strip to fade in influence");
436         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
437         
438         prop= RNA_def_property(srna, "blend_out", PROP_FLOAT, PROP_NONE);
439         RNA_def_property_float_sdna(prop, NULL, "blendout");
440         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_out_set", NULL);
441         RNA_def_property_ui_text(prop, "Blend Out", "");
442         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
443         
444         prop= RNA_def_property(srna, "use_auto_blend", PROP_BOOLEAN, PROP_NONE);
445         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_AUTO_BLENDS);
446         RNA_def_property_ui_text(prop, "Auto Blend In/Out", "Number of frames for Blending In/Out is automatically determined from overlapping strips");
447         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
448         
449         /* Action */
450         // TODO: this should only be editable if it is not being edited atm...
451         prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
452         RNA_def_property_pointer_sdna(prop, NULL, "act");
453         RNA_def_property_pointer_funcs(prop, NULL, NULL, NULL, "rna_Action_id_poll");
454         RNA_def_property_flag(prop, PROP_EDITABLE); 
455         RNA_def_property_editable_func(prop, "rna_NlaStrip_action_editable");
456         RNA_def_property_ui_text(prop, "Action", "Action referenced by this strip");
457         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
458         
459         /* Action extents */
460         prop= RNA_def_property(srna, "action_frame_start", PROP_FLOAT, PROP_TIME);
461         RNA_def_property_float_sdna(prop, NULL, "actstart");
462         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_start_frame_set", NULL);
463         RNA_def_property_ui_text(prop, "Action Start Frame", "");
464         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
465         
466         prop= RNA_def_property(srna, "action_frame_end", PROP_FLOAT, PROP_TIME);
467         RNA_def_property_float_sdna(prop, NULL, "actend");
468         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_end_frame_set", NULL);
469         RNA_def_property_ui_text(prop, "Action End Frame", "");
470         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
471         
472         /* Action Reuse */
473         prop= RNA_def_property(srna, "repeat", PROP_FLOAT, PROP_NONE);
474         RNA_def_property_float_sdna(prop, NULL, "repeat"); 
475         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_repeat_set", NULL);
476         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... */
477         RNA_def_property_ui_text(prop, "Repeat", "Number of times to repeat the action range");
478         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
479         
480         prop= RNA_def_property(srna, "scale", PROP_FLOAT, PROP_NONE);
481         RNA_def_property_float_sdna(prop, NULL, "scale"); 
482         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_scale_set", NULL);
483         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 */
484         RNA_def_property_ui_text(prop, "Scale", "Scaling factor for action");
485         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
486         
487         /* Strip's F-Curves */
488         prop= RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
489         RNA_def_property_struct_type(prop, "FCurve");
490         RNA_def_property_ui_text(prop, "F-Curves", "F-Curves for controlling the strip's influence and timing");
491         
492         /* Strip's F-Modifiers */
493         prop= RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
494         RNA_def_property_struct_type(prop, "FModifier");
495         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting all the F-Curves in the referenced Action");
496         
497         /* Strip's Sub-Strips (for Meta-Strips) */
498         prop= RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
499         RNA_def_property_struct_type(prop, "NlaStrip");
500         RNA_def_property_ui_text(prop, "NLA Strips", "NLA Strips that this strip acts as a container for (if it is of type Meta)");
501         
502         /* Settings - Values necessary for evaluation */
503         prop= RNA_def_property(srna, "influence", PROP_FLOAT, PROP_NONE);
504         RNA_def_property_range(prop, 0.0f, 1.0f);
505         RNA_def_property_ui_text(prop, "Influence", "Amount the strip contributes to the current result");
506         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
507         
508         prop= RNA_def_property(srna, "strip_time", PROP_FLOAT, PROP_TIME);
509         RNA_def_property_ui_text(prop, "Strip Time", "Frame of referenced Action to evaluate");
510         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
511         
512                 // TODO: should the animated_influence/time settings be animatable themselves?
513         prop= RNA_def_property(srna, "use_animated_influence", PROP_BOOLEAN, PROP_NONE);
514         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_INFLUENCE);
515         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_influence_set");
516         RNA_def_property_ui_text(prop, "Animated Influence", "Influence setting is controlled by an F-Curve rather than automatically determined");
517         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
518         
519         prop= RNA_def_property(srna, "use_animated_time", PROP_BOOLEAN, PROP_NONE);
520         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME);
521         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_time_set");
522         RNA_def_property_ui_text(prop, "Animated Strip Time", "Strip time is controlled by an F-Curve rather than automatically determined");
523         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
524         
525         prop= RNA_def_property(srna, "use_animated_time_cyclic", PROP_BOOLEAN, PROP_NONE);
526         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME_CYCLIC);
527         RNA_def_property_ui_text(prop, "Cyclic Strip Time", "Cycle the animated time within the action start & end");
528         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update"); // is there a better update flag?
529         
530         /* settings */
531         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
532         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
533         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_ACTIVE);
534         RNA_def_property_ui_text(prop, "Active", "NLA Strip is active");
535         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
536         
537         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
538         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_SELECT);
539         RNA_def_property_ui_text(prop, "Select", "NLA Strip is selected");
540         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
541         
542         prop= RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
543         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_MUTED);
544         RNA_def_property_ui_text(prop, "Muted", "NLA Strip is not evaluated");
545         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
546         
547         prop= RNA_def_property(srna, "use_reverse", PROP_BOOLEAN, PROP_NONE);
548         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_REVERSE);
549         RNA_def_property_ui_text(prop, "Reversed", "NLA Strip is played back in reverse order (only when timing is automatically determined)");
550         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
551         
552         // TODO: 
553         // - sync length
554 }
555
556 static void rna_api_nlatrack_strips(BlenderRNA *brna, PropertyRNA *cprop)
557 {
558         StructRNA *srna;
559         PropertyRNA *parm;
560         FunctionRNA *func;
561
562         RNA_def_property_srna(cprop, "NlaStrips");
563         srna= RNA_def_struct(brna, "NlaStrips", NULL);
564         RNA_def_struct_sdna(srna, "NlaTrack");
565         RNA_def_struct_ui_text(srna, "Nla Strips", "Collection of Nla Strips");
566
567         func = RNA_def_function(srna, "new", "rna_NlaStrip_new");
568         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
569         RNA_def_function_ui_description(func, "Add a new Action-Clip strip to the track");
570         parm= RNA_def_string(func, "name", "NlaStrip", 0, "", "Name for the NLA Strips.");
571         RNA_def_property_flag(parm, PROP_REQUIRED);
572         parm = RNA_def_int(func, "start", 0, INT_MIN, INT_MAX, "Start Frame", "Start frame for this strip.", INT_MIN, INT_MAX);
573         RNA_def_property_flag(parm, PROP_REQUIRED);
574         parm = RNA_def_pointer(func, "action", "Action", "", "Action to assign to this strip.");
575         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
576         /* return type */
577         parm = RNA_def_pointer(func, "strip", "NlaStrip", "", "New NLA Strip.");
578         RNA_def_function_return(func, parm);
579
580         func = RNA_def_function(srna, "remove", "rna_NlaStrip_remove");
581         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
582         RNA_def_function_ui_description(func, "Remove a NLA Strip.");
583         parm = RNA_def_pointer(func, "strip", "NlaStrip", "", "NLA Strip to remove.");
584         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
585 }
586
587 static void rna_def_nlatrack(BlenderRNA *brna)
588 {
589         StructRNA *srna;
590         PropertyRNA *prop;
591         
592         srna= RNA_def_struct(brna, "NlaTrack", NULL);
593         RNA_def_struct_ui_text(srna, "NLA Track", "A animation layer containing Actions referenced as NLA strips");
594         RNA_def_struct_ui_icon(srna, ICON_NLA);
595         
596         /* strips collection */
597         prop= RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
598         RNA_def_property_struct_type(prop, "NlaStrip");
599         RNA_def_property_ui_text(prop, "NLA Strips", "NLA Strips on this NLA-track");
600
601         rna_api_nlatrack_strips(brna, prop);
602
603         /* name property */
604         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
605         RNA_def_property_ui_text(prop, "Name", "");
606         RNA_def_struct_name_property(srna, prop);
607         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
608         
609         /* settings */
610         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
611         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
612         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_ACTIVE);
613         RNA_def_property_ui_text(prop, "Active", "NLA Track is active");
614         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
615         
616         prop= RNA_def_property(srna, "is_solo", PROP_BOOLEAN, PROP_NONE);
617         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
618         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SOLO);
619         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)");
620         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
621         
622         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
623         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SELECTED);
624         RNA_def_property_ui_text(prop, "Select", "NLA Track is selected");
625         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
626         
627         prop= RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
628         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_MUTED);
629         RNA_def_property_ui_text(prop, "Muted", "NLA Track is not evaluated");
630         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
631
632         prop= RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
633         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_PROTECTED);
634         RNA_def_property_ui_text(prop, "Locked", "NLA Track is locked");
635         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
636 }
637
638 /* --------- */
639
640 void RNA_def_nla(BlenderRNA *brna)
641 {
642         rna_def_nlatrack(brna);
643         rna_def_nlastrip(brna);
644 }
645
646
647 #endif