Node socket values now only have soft limits, rather than hard limits, so you
[blender.git] / source / blender / makesrna / intern / rna_nla.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 (2009), Joshua Leung
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_nla.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31
32 #include "rna_internal.h"
33
34 #include "DNA_anim_types.h"
35 #include "DNA_action_types.h"
36 #include "DNA_scene_types.h"
37
38 #include "MEM_guardedalloc.h"
39
40 #include "WM_api.h"
41 #include "WM_types.h"
42
43 #ifdef RNA_RUNTIME
44
45 #include <stdio.h>
46 #include <math.h>
47
48 /* needed for some of the validation stuff... */
49 #include "BKE_animsys.h"
50 #include "BKE_nla.h"
51
52 #include "ED_anim_api.h"
53
54 /* temp constant defined for these funcs only... */
55 #define NLASTRIP_MIN_LEN_THRESH         0.1f
56
57 static void rna_NlaStrip_name_set(PointerRNA *ptr, const char *value)
58 {
59         NlaStrip *data = (NlaStrip *)ptr->data;
60         
61         /* copy the name first */
62         BLI_strncpy_utf8(data->name, value, sizeof(data->name));
63         
64         /* validate if there's enough info to do so */
65         if (ptr->id.data) {
66                 AnimData *adt = BKE_animdata_from_id(ptr->id.data);
67                 BKE_nlastrip_validate_name(adt, data);
68         }
69 }
70
71 static char *rna_NlaStrip_path(PointerRNA *ptr)
72 {
73         NlaStrip *strip = (NlaStrip *)ptr->data;
74         AnimData *adt = BKE_animdata_from_id(ptr->id.data);
75         
76         /* if we're attached to AnimData, try to resolve path back to AnimData */
77         if (adt) {
78                 NlaTrack *nlt;
79                 NlaStrip *nls;
80                 
81                 for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
82                         for (nls = nlt->strips.first; nls; nls = nls->next) {
83                                 if (nls == strip) {
84                                         /* XXX but if we animate like this, the control will never work... */
85                                         return BLI_sprintfN("animation_data.nla_tracks[\"%s\"].strips[\"%s\"]", nlt->name, strip->name);
86                                 }
87                         }
88                 }
89         }
90         
91         /* no path */
92         return "";
93 }
94
95 static void rna_NlaStrip_transform_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
96 {
97         NlaStrip *strip = (NlaStrip*)ptr->data;
98
99         BKE_nlameta_flush_transforms(strip);
100 }
101
102 static void rna_NlaStrip_start_frame_set(PointerRNA *ptr, float value)
103 {
104         NlaStrip *data = (NlaStrip*)ptr->data;
105         
106         /* clamp value to lie within valid limits
107          *      - cannot start past the end of the strip + some flexibility threshold
108          *      - cannot start before the previous strip (if present) ends
109          *              -> but if it was a transition, we could go up to the start of the strip + some flexibility threshold
110          *              as long as we re-adjust the transition afterwards
111          *      - minimum frame is -MAXFRAME so that we don't get clipping on frame 0
112          */
113         if (data->prev) {
114                 if (data->prev->type == NLASTRIP_TYPE_TRANSITION) {
115                         CLAMP(value, data->prev->start+NLASTRIP_MIN_LEN_THRESH, data->end-NLASTRIP_MIN_LEN_THRESH);
116                         
117                         /* readjust the transition to stick to the endpoints of the action-clips */
118                         data->prev->end = value;
119                 }
120                 else {
121                         CLAMP(value, data->prev->end, data->end-NLASTRIP_MIN_LEN_THRESH);
122                 }
123         }
124         else {
125                 CLAMP(value, MINAFRAME, data->end);
126         }
127         data->start = value;
128 }
129
130 static void rna_NlaStrip_end_frame_set(PointerRNA *ptr, float value)
131 {
132         NlaStrip *data = (NlaStrip*)ptr->data;
133         
134         /* clamp value to lie within valid limits
135          *      - must not have zero or negative length strip, so cannot start before the first frame
136          *        + some minimum-strip-length threshold
137          *      - cannot end later than the start of the next strip (if present)
138          *              -> but if it was a transition, we could go up to the start of the end - some flexibility threshold
139          *              as long as we re-adjust the transition afterwards
140          */
141         if (data->next) {
142                 if (data->next->type == NLASTRIP_TYPE_TRANSITION) {
143                         CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, data->next->end-NLASTRIP_MIN_LEN_THRESH);
144                         
145                         /* readjust the transition to stick to the endpoints of the action-clips */
146                         data->next->start = value;
147                 }
148                 else {
149                         CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, data->next->start);
150                 }
151         }
152         else {
153                 CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, MAXFRAME);
154         }
155         data->end = value;
156         
157         
158         /* calculate the lengths the strip and its action (if applicable) */
159         if (data->type == NLASTRIP_TYPE_CLIP) {
160                 float len, actlen;
161                 
162                 len = data->end - data->start;
163                 actlen = data->actend - data->actstart;
164                 if (IS_EQF(actlen, 0.0f)) actlen = 1.0f;
165                 
166                 /* now, adjust the 'scale' setting to reflect this (so that this change can be valid) */
167                 data->scale = len / ((actlen) * data->repeat);
168         }
169 }
170
171 static void rna_NlaStrip_scale_set(PointerRNA *ptr, float value)
172 {
173         NlaStrip *data = (NlaStrip*)ptr->data;
174         
175         /* set scale value */
176                 /* NOTE: these need to be synced with the values in the property definition in rna_def_nlastrip() */
177         CLAMP(value, 0.0001f, 1000.0f);
178         data->scale = value;
179         
180         /* adjust the strip extents in response to this */
181         BKE_nlastrip_recalculate_bounds(data);
182 }
183
184 static void rna_NlaStrip_repeat_set(PointerRNA *ptr, float value)
185 {
186         NlaStrip *data = (NlaStrip*)ptr->data;
187         
188         /* set repeat value */
189                 /* NOTE: these need to be synced with the values in the property definition in rna_def_nlastrip() */
190         CLAMP(value, 0.01f, 1000.0f);
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),
300                                   int start, bAction *action)
301 {
302         NlaStrip *strip = add_nlastrip(action);
303         
304         if (strip == NULL) {
305                 BKE_reportf(reports, RPT_ERROR, "Unable to create new strip");
306                 return NULL;
307         }
308         
309         strip->end += (start - strip->start);
310         strip->start = start;
311         
312         if (BKE_nlastrips_add_strip(&track->strips, strip) == 0) {
313                 BKE_reportf(reports, RPT_ERROR,
314                             "Unable to add strip. Track doesn't have any space to accommodate this new strip");
315                 free_nlastrip(NULL, strip);
316                 return NULL;
317         }
318         
319         /* create dummy AnimData block so that BKE_nlastrip_validate_name()
320          * can be used to ensure a valid name, as we don't have one here...
321          *      - only the nla_tracks list is needed there, which we aim to reverse engineer here...
322          */
323         {
324                 AnimData adt = {NULL};
325                 NlaTrack *nlt, *nlt_p;
326                 
327                 /* 'first' NLA track is found by going back up chain of given track's parents until we fall off */
328                 nlt_p = track; nlt = track;
329                 while ((nlt = nlt->prev) != NULL)
330                         nlt_p = nlt;
331                 adt.nla_tracks.first = nlt_p;
332                 
333                 /* do the same thing to find the last track */
334                 nlt_p = track; nlt = track;
335                 while ((nlt = nlt->next) != NULL)
336                         nlt_p = nlt;
337                 adt.nla_tracks.last = nlt_p;
338                 
339                 /* now we can just auto-name as usual */
340                 BKE_nlastrip_validate_name(&adt, strip);
341         }
342         
343         WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_ADDED, NULL);
344         
345         return strip;
346 }
347
348 static void rna_NlaStrip_remove(NlaTrack *track, bContext *C, ReportList *reports, NlaStrip *strip)
349 {
350         if (BLI_findindex(&track->strips, strip) == -1) {
351                 BKE_reportf(reports, RPT_ERROR, "NLA's Strip '%s' not found in track '%s'", strip->name, track->name);
352                 return;
353         }
354         else {
355                 free_nlastrip(&track->strips, strip);
356                 WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_REMOVED, NULL);
357         }
358 }
359
360 #else
361
362 /* enum defines exported for rna_animation.c */
363 EnumPropertyItem nla_mode_blend_items[] = {
364         {NLASTRIP_MODE_REPLACE, "REPLACE", 0, "Replace",
365                                 "Result strip replaces the accumulated results by amount specified by influence"},
366         {NLASTRIP_MODE_ADD, "ADD", 0, "Add", "Weighted result of strip is added to the accumulated results"},
367         {NLASTRIP_MODE_SUBTRACT, "SUBTRACT", 0, "Subtract",
368                                  "Weighted result of strip is removed from the accumulated results"},
369         {NLASTRIP_MODE_MULTIPLY, "MULITPLY", 0, "Multiply",
370                                  "Weighted result of strip is multiplied with the accumulated results"},
371         {0, NULL, 0, NULL, NULL}};
372 EnumPropertyItem nla_mode_extend_items[] = {
373         {NLASTRIP_EXTEND_NOTHING, "NOTHING", 0, "Nothing", "Strip has no influence past its extents"},
374         {NLASTRIP_EXTEND_HOLD, "HOLD", 0, "Hold",
375                                "Hold the first frame if no previous strips in track, and always hold last frame"},
376         {NLASTRIP_EXTEND_HOLD_FORWARD, "HOLD_FORWARD", 0, "Hold Forward", "Only hold last frame"},
377         {0, NULL, 0, NULL, NULL}};
378
379 static void rna_def_nlastrip(BlenderRNA *brna)
380 {
381         StructRNA *srna;
382         PropertyRNA *prop;
383         
384                 /* enum defs */
385         static EnumPropertyItem prop_type_items[] = {
386                 {NLASTRIP_TYPE_CLIP, "CLIP", 0, "Action Clip", "NLA Strip references some Action"},
387                 {NLASTRIP_TYPE_TRANSITION, "TRANSITION", 0, "Transition", "NLA Strip 'transitions' between adjacent strips"},
388                 {NLASTRIP_TYPE_META, "META", 0, "Meta", "NLA Strip acts as a container for adjacent strips"},
389                 {NLASTRIP_TYPE_SOUND, "SOUND", 0, "Sound Clip", "NLA Strip representing a sound event for speakers"},
390                 {0, NULL, 0, NULL, NULL}};
391         
392         /* struct definition */
393         srna = RNA_def_struct(brna, "NlaStrip", NULL);
394         RNA_def_struct_ui_text(srna, "NLA Strip", "A container referencing an existing Action");
395         RNA_def_struct_path_func(srna, "rna_NlaStrip_path");
396         RNA_def_struct_ui_icon(srna, ICON_NLA); /* XXX */
397         
398         /* name property */
399         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
400         RNA_def_property_ui_text(prop, "Name", "");
401         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_NlaStrip_name_set");
402         RNA_def_struct_name_property(srna, prop);
403         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
404         
405         /* Enums */
406         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
407         RNA_def_property_enum_sdna(prop, NULL, "type");
408         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* XXX for now, not editable, since this is dangerous */
409         RNA_def_property_enum_items(prop, prop_type_items);
410         RNA_def_property_ui_text(prop, "Type", "Type of NLA Strip");
411         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
412         
413         prop = RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
414         RNA_def_property_enum_sdna(prop, NULL, "extendmode");
415         RNA_def_property_enum_items(prop, nla_mode_extend_items);
416         RNA_def_property_ui_text(prop, "Extrapolation", "Action to take for gaps past the strip extents");
417         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
418         
419         prop = RNA_def_property(srna, "blend_type", PROP_ENUM, PROP_NONE);
420         RNA_def_property_enum_sdna(prop, NULL, "blendmode");
421         RNA_def_property_enum_items(prop, nla_mode_blend_items);
422         RNA_def_property_ui_text(prop, "Blending", "Method used for combining strip's result with accumulated result");
423         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
424         
425         /* Strip extents */
426         prop = RNA_def_property(srna, "frame_start", PROP_FLOAT, PROP_TIME);
427         RNA_def_property_float_sdna(prop, NULL, "start");
428         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_start_frame_set", NULL);
429         RNA_def_property_ui_text(prop, "Start Frame", "");
430         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update");
431         
432         prop = RNA_def_property(srna, "frame_end", PROP_FLOAT, PROP_TIME);
433         RNA_def_property_float_sdna(prop, NULL, "end");
434         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_end_frame_set", NULL);
435         RNA_def_property_ui_text(prop, "End Frame", "");
436         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update");
437         
438         /* Blending */
439         prop = RNA_def_property(srna, "blend_in", PROP_FLOAT, PROP_NONE);
440         RNA_def_property_float_sdna(prop, NULL, "blendin");
441         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_in_set", NULL);
442         RNA_def_property_ui_text(prop, "Blend In", "Number of frames at start of strip to fade in influence");
443         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
444         
445         prop = RNA_def_property(srna, "blend_out", PROP_FLOAT, PROP_NONE);
446         RNA_def_property_float_sdna(prop, NULL, "blendout");
447         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_out_set", NULL);
448         RNA_def_property_ui_text(prop, "Blend Out", "");
449         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
450         
451         prop = RNA_def_property(srna, "use_auto_blend", PROP_BOOLEAN, PROP_NONE);
452         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_AUTO_BLENDS);
453         RNA_def_property_ui_text(prop, "Auto Blend In/Out",
454                                  "Number of frames for Blending In/Out is automatically determined from "
455                                  "overlapping strips");
456         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
457         
458         /* Action */
459         prop = RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
460         RNA_def_property_pointer_sdna(prop, NULL, "act");
461         RNA_def_property_pointer_funcs(prop, NULL, NULL, NULL, "rna_Action_id_poll");
462         RNA_def_property_flag(prop, PROP_EDITABLE);
463         RNA_def_property_editable_func(prop, "rna_NlaStrip_action_editable");
464         RNA_def_property_ui_text(prop, "Action", "Action referenced by this strip");
465         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
466         
467         /* Action extents */
468         prop = RNA_def_property(srna, "action_frame_start", PROP_FLOAT, PROP_TIME);
469         RNA_def_property_float_sdna(prop, NULL, "actstart");
470         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_start_frame_set", NULL);
471         RNA_def_property_ui_text(prop, "Action Start Frame", "");
472         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
473         
474         prop = RNA_def_property(srna, "action_frame_end", PROP_FLOAT, PROP_TIME);
475         RNA_def_property_float_sdna(prop, NULL, "actend");
476         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_end_frame_set", NULL);
477         RNA_def_property_ui_text(prop, "Action End Frame", "");
478         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
479         
480         /* Action Reuse */
481         prop = RNA_def_property(srna, "repeat", PROP_FLOAT, PROP_NONE);
482         RNA_def_property_float_sdna(prop, NULL, "repeat");
483         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_repeat_set", NULL);
484                 /* these limits have currently be chosen arbitarily, but could be extended
485                  * (minimum should still be > 0 though) if needed... */
486         RNA_def_property_range(prop, 0.1f, 1000.0f);
487         RNA_def_property_ui_text(prop, "Repeat", "Number of times to repeat the action range");
488         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
489         
490         prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_NONE);
491         RNA_def_property_float_sdna(prop, NULL, "scale");
492         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_scale_set", NULL);
493                 /* these limits can be extended, but beyond this, we can get some crazy+annoying bugs
494                  * due to numeric errors */
495         RNA_def_property_range(prop, 0.0001f, 1000.0f);
496         RNA_def_property_ui_text(prop, "Scale", "Scaling factor for action");
497         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
498         
499         /* Strip's F-Curves */
500         prop = RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
501         RNA_def_property_struct_type(prop, "FCurve");
502         RNA_def_property_ui_text(prop, "F-Curves", "F-Curves for controlling the strip's influence and timing");
503         
504         /* Strip's F-Modifiers */
505         prop = RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
506         RNA_def_property_struct_type(prop, "FModifier");
507         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting all the F-Curves in the referenced Action");
508         
509         /* Strip's Sub-Strips (for Meta-Strips) */
510         prop = RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
511         RNA_def_property_struct_type(prop, "NlaStrip");
512         RNA_def_property_ui_text(prop, "NLA Strips",
513                                  "NLA Strips that this strip acts as a container for (if it is of type Meta)");
514         
515         /* Settings - Values necessary for evaluation */
516         prop = RNA_def_property(srna, "influence", PROP_FLOAT, PROP_NONE);
517         RNA_def_property_range(prop, 0.0f, 1.0f);
518         RNA_def_property_ui_text(prop, "Influence", "Amount the strip contributes to the current result");
519         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
520         
521         prop = RNA_def_property(srna, "strip_time", PROP_FLOAT, PROP_TIME);
522         RNA_def_property_ui_text(prop, "Strip Time", "Frame of referenced Action to evaluate");
523         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
524         
525                 /* TODO: should the animated_influence/time settings be animatable themselves? */
526         prop = RNA_def_property(srna, "use_animated_influence", PROP_BOOLEAN, PROP_NONE);
527         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_INFLUENCE);
528         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_influence_set");
529         RNA_def_property_ui_text(prop, "Animated Influence",
530                                  "Influence setting is controlled by an F-Curve rather than automatically determined");
531         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
532         
533         prop = RNA_def_property(srna, "use_animated_time", PROP_BOOLEAN, PROP_NONE);
534         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME);
535         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_time_set");
536         RNA_def_property_ui_text(prop, "Animated Strip Time",
537                                  "Strip time is controlled by an F-Curve rather than automatically determined");
538         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
539         
540         prop = RNA_def_property(srna, "use_animated_time_cyclic", PROP_BOOLEAN, PROP_NONE);
541         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME_CYCLIC);
542         RNA_def_property_ui_text(prop, "Cyclic Strip Time", "Cycle the animated time within the action start & end");
543         RNA_def_property_update(prop, 0, "rna_NlaStrip_transform_update"); /* is there a better update flag? */
544         
545         /* settings */
546         prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
547                 /* can be made editable by hooking it up to the necessary NLA API methods */
548         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
549         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_ACTIVE);
550         RNA_def_property_ui_text(prop, "Active", "NLA Strip is active");
551         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
552         
553         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
554         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_SELECT);
555         RNA_def_property_ui_text(prop, "Select", "NLA Strip is selected");
556         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
557         
558         prop = RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
559         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_MUTED);
560         RNA_def_property_ui_text(prop, "Muted", "NLA Strip is not evaluated");
561         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
562         
563         prop = RNA_def_property(srna, "use_reverse", PROP_BOOLEAN, PROP_NONE);
564         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_REVERSE);
565         RNA_def_property_ui_text(prop, "Reversed",
566                                  "NLA Strip is played back in reverse order (only when timing is "
567                                  "automatically determined)");
568         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
569         
570         /* TODO:  */
571         /* - sync length */
572 }
573
574 static void rna_api_nlatrack_strips(BlenderRNA *brna, PropertyRNA *cprop)
575 {
576         StructRNA *srna;
577         PropertyRNA *parm;
578         FunctionRNA *func;
579
580         RNA_def_property_srna(cprop, "NlaStrips");
581         srna = RNA_def_struct(brna, "NlaStrips", NULL);
582         RNA_def_struct_sdna(srna, "NlaTrack");
583         RNA_def_struct_ui_text(srna, "Nla Strips", "Collection of Nla Strips");
584
585         func = RNA_def_function(srna, "new", "rna_NlaStrip_new");
586         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
587         RNA_def_function_ui_description(func, "Add a new Action-Clip strip to the track");
588         parm = RNA_def_string(func, "name", "NlaStrip", 0, "", "Name for the NLA Strips");
589         RNA_def_property_flag(parm, PROP_REQUIRED);
590         parm = RNA_def_int(func, "start", 0, INT_MIN, INT_MAX, "Start Frame",
591                            "Start frame for this strip", INT_MIN, INT_MAX);
592         RNA_def_property_flag(parm, PROP_REQUIRED);
593         parm = RNA_def_pointer(func, "action", "Action", "", "Action to assign to this strip");
594         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
595         /* return type */
596         parm = RNA_def_pointer(func, "strip", "NlaStrip", "", "New NLA Strip");
597         RNA_def_function_return(func, parm);
598
599         func = RNA_def_function(srna, "remove", "rna_NlaStrip_remove");
600         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
601         RNA_def_function_ui_description(func, "Remove a NLA Strip");
602         parm = RNA_def_pointer(func, "strip", "NlaStrip", "", "NLA Strip to remove");
603         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
604 }
605
606 static void rna_def_nlatrack(BlenderRNA *brna)
607 {
608         StructRNA *srna;
609         PropertyRNA *prop;
610         
611         srna = RNA_def_struct(brna, "NlaTrack", NULL);
612         RNA_def_struct_ui_text(srna, "NLA Track", "A animation layer containing Actions referenced as NLA strips");
613         RNA_def_struct_ui_icon(srna, ICON_NLA);
614         
615         /* strips collection */
616         prop = RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
617         RNA_def_property_struct_type(prop, "NlaStrip");
618         RNA_def_property_ui_text(prop, "NLA Strips", "NLA Strips on this NLA-track");
619
620         rna_api_nlatrack_strips(brna, prop);
621
622         /* name property */
623         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
624         RNA_def_property_ui_text(prop, "Name", "");
625         RNA_def_struct_name_property(srna, prop);
626         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
627         
628         /* settings */
629         prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
630                 /* can be made editable by hooking it up to the necessary NLA API methods */
631         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
632         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_ACTIVE);
633         RNA_def_property_ui_text(prop, "Active", "NLA Track is active");
634         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
635         
636         prop = RNA_def_property(srna, "is_solo", PROP_BOOLEAN, PROP_NONE);
637                 /* can be made editable by hooking it up to the necessary NLA API methods */
638         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
639         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SOLO);
640         RNA_def_property_ui_text(prop, "Solo",
641                                  "NLA Track is evaluated itself (i.e. active Action and all other NLA Tracks in the "
642                                  "same AnimData block are disabled)");
643         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
644         
645         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
646         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SELECTED);
647         RNA_def_property_ui_text(prop, "Select", "NLA Track is selected");
648         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
649         
650         prop = RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
651         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_MUTED);
652         RNA_def_property_ui_text(prop, "Muted", "NLA Track is not evaluated");
653         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
654
655         prop = RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
656         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_PROTECTED);
657         RNA_def_property_ui_text(prop, "Locked", "NLA Track is locked");
658         RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
659 }
660
661 /* --------- */
662
663 void RNA_def_nla(BlenderRNA *brna)
664 {
665         rna_def_nlatrack(brna);
666         rna_def_nlastrip(brna);
667 }
668
669
670 #endif