Cleanup: indentation
[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 #include <stdlib.h>
28
29 #include "DNA_anim_types.h"
30 #include "DNA_action_types.h"
31 #include "DNA_scene_types.h"
32
33 #include "BLI_utildefines.h"
34
35 #include "MEM_guardedalloc.h"
36
37 #include "RNA_access.h"
38 #include "RNA_define.h"
39 #include "RNA_enum_types.h"
40
41 #include "rna_internal.h"
42
43 #include "WM_api.h"
44 #include "WM_types.h"
45
46 #ifdef RNA_RUNTIME
47
48 #include <stdio.h>
49 #include <math.h>
50
51 /* needed for some of the validation stuff... */
52 #include "BKE_animsys.h"
53 #include "BKE_fcurve.h"
54 #include "BKE_nla.h"
55
56 #include "DNA_object_types.h"
57
58 #include "ED_anim_api.h"
59
60 /* temp constant defined for these funcs only... */
61 #define NLASTRIP_MIN_LEN_THRESH     0.1f
62
63 static void rna_NlaStrip_name_set(PointerRNA *ptr, const char *value)
64 {
65         NlaStrip *data = (NlaStrip *)ptr->data;
66
67         /* copy the name first */
68         BLI_strncpy_utf8(data->name, value, sizeof(data->name));
69
70         /* validate if there's enough info to do so */
71         if (ptr->id.data) {
72                 AnimData *adt = BKE_animdata_from_id(ptr->id.data);
73                 BKE_nlastrip_validate_name(adt, data);
74         }
75 }
76
77 static char *rna_NlaStrip_path(PointerRNA *ptr)
78 {
79         NlaStrip *strip = (NlaStrip *)ptr->data;
80         AnimData *adt = BKE_animdata_from_id(ptr->id.data);
81
82         /* if we're attached to AnimData, try to resolve path back to AnimData */
83         if (adt) {
84                 NlaTrack *nlt;
85                 NlaStrip *nls;
86
87                 for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
88                         for (nls = nlt->strips.first; nls; nls = nls->next) {
89                                 if (nls == strip) {
90                                         /* XXX but if we animate like this, the control will never work... */
91                                         char name_esc_nlt[sizeof(nlt->name) * 2];
92                                         char name_esc_strip[sizeof(strip->name) * 2];
93
94                                         BLI_strescape(name_esc_nlt, nlt->name, sizeof(name_esc_nlt));
95                                         BLI_strescape(name_esc_strip, strip->name, sizeof(name_esc_strip));
96                                         return BLI_sprintfN("animation_data.nla_tracks[\"%s\"].strips[\"%s\"]",
97                                                             name_esc_nlt, name_esc_strip);
98                                 }
99                         }
100                 }
101         }
102
103         /* no path */
104         return BLI_strdup("");
105 }
106
107 static void rna_NlaStrip_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
108 {
109         ID *id = ptr->id.data;
110
111         ANIM_id_update(scene, id);
112 }
113
114 static void rna_NlaStrip_transform_update(Main *bmain, Scene *scene, PointerRNA *ptr)
115 {
116         NlaStrip *strip = (NlaStrip *)ptr->data;
117
118         BKE_nlameta_flush_transforms(strip);
119
120         /* set the flag */
121         if ((strip->flag & NLASTRIP_FLAG_AUTO_BLENDS) && ptr->id.data) {
122                 /* validate state to ensure that auto-blend gets applied immediately */
123                 IdAdtTemplate *iat = (IdAdtTemplate *)ptr->id.data;
124
125                 if (iat->adt) {
126                         BKE_nla_validate_state(iat->adt);
127                 }
128         }
129
130         rna_NlaStrip_update(bmain, scene, ptr);
131 }
132
133 static void rna_NlaStrip_start_frame_set(PointerRNA *ptr, float value)
134 {
135         NlaStrip *data = (NlaStrip *)ptr->data;
136
137         /* clamp value to lie within valid limits
138          *      - cannot start past the end of the strip + some flexibility threshold
139          *      - cannot start before the previous strip (if present) ends
140          *              -> but if it was a transition, we could go up to the start of the strip + some flexibility threshold
141          *              as long as we re-adjust the transition afterwards
142          *      - minimum frame is -MAXFRAME so that we don't get clipping on frame 0
143          */
144         if (data->prev) {
145                 if (data->prev->type == NLASTRIP_TYPE_TRANSITION) {
146                         CLAMP(value, data->prev->start + NLASTRIP_MIN_LEN_THRESH, data->end - NLASTRIP_MIN_LEN_THRESH);
147
148                         /* re-adjust the transition to stick to the endpoints of the action-clips */
149                         data->prev->end = value;
150                 }
151                 else {
152                         CLAMP(value, data->prev->end, data->end - NLASTRIP_MIN_LEN_THRESH);
153                 }
154         }
155         else {
156                 CLAMP(value, MINAFRAME, data->end);
157         }
158         data->start = value;
159 }
160
161 static void rna_NlaStrip_end_frame_set(PointerRNA *ptr, float value)
162 {
163         NlaStrip *data = (NlaStrip *)ptr->data;
164
165         /* clamp value to lie within valid limits
166          *      - must not have zero or negative length strip, so cannot start before the first frame
167          *        + some minimum-strip-length threshold
168          *      - cannot end later than the start of the next strip (if present)
169          *              -> but if it was a transition, we could go up to the start of the end - some flexibility threshold
170          *              as long as we re-adjust the transition afterwards
171          */
172         if (data->next) {
173                 if (data->next->type == NLASTRIP_TYPE_TRANSITION) {
174                         CLAMP(value, data->start + NLASTRIP_MIN_LEN_THRESH, data->next->end - NLASTRIP_MIN_LEN_THRESH);
175
176                         /* readjust the transition to stick to the endpoints of the action-clips */
177                         data->next->start = value;
178                 }
179                 else {
180                         CLAMP(value, data->start + NLASTRIP_MIN_LEN_THRESH, data->next->start);
181                 }
182         }
183         else {
184                 CLAMP(value, data->start + NLASTRIP_MIN_LEN_THRESH, MAXFRAME);
185         }
186         data->end = value;
187
188
189         /* calculate the lengths the strip and its action (if applicable) */
190         if (data->type == NLASTRIP_TYPE_CLIP) {
191                 float len, actlen;
192
193                 len = data->end - data->start;
194                 actlen = data->actend - data->actstart;
195                 if (IS_EQF(actlen, 0.0f)) actlen = 1.0f;
196
197                 /* now, adjust the 'scale' setting to reflect this (so that this change can be valid) */
198                 data->scale = len / ((actlen) * data->repeat);
199         }
200 }
201
202 static void rna_NlaStrip_scale_set(PointerRNA *ptr, float value)
203 {
204         NlaStrip *data = (NlaStrip *)ptr->data;
205
206         /* set scale value */
207         /* NOTE: these need to be synced with the values in the property definition in rna_def_nlastrip() */
208         CLAMP(value, 0.0001f, 1000.0f);
209         data->scale = value;
210
211         /* adjust the strip extents in response to this */
212         BKE_nlastrip_recalculate_bounds(data);
213 }
214
215 static void rna_NlaStrip_repeat_set(PointerRNA *ptr, float value)
216 {
217         NlaStrip *data = (NlaStrip *)ptr->data;
218
219         /* set repeat value */
220         /* NOTE: these need to be synced with the values in the property definition in rna_def_nlastrip() */
221         CLAMP(value, 0.01f, 1000.0f);
222         data->repeat = value;
223
224         /* adjust the strip extents in response to this */
225         BKE_nlastrip_recalculate_bounds(data);
226 }
227
228 static void rna_NlaStrip_blend_in_set(PointerRNA *ptr, float value)
229 {
230         NlaStrip *data = (NlaStrip *)ptr->data;
231         float len;
232
233         /* blend-in is limited to the length of the strip, and also cannot overlap with blendout */
234         len = (data->end - data->start) - data->blendout;
235         CLAMP(value, 0, len);
236
237         data->blendin = value;
238 }
239
240 static void rna_NlaStrip_blend_out_set(PointerRNA *ptr, float value)
241 {
242         NlaStrip *data = (NlaStrip *)ptr->data;
243         float len;
244
245         /* blend-out is limited to the length of the strip */
246         len = (data->end - data->start);
247         CLAMP(value, 0, len);
248
249         /* it also cannot overlap with blendin */
250         if ((len - value) < data->blendin)
251                 value = len - data->blendin;
252
253         data->blendout = value;
254 }
255
256 static void rna_NlaStrip_use_auto_blend_set(PointerRNA *ptr, bool value)
257 {
258         NlaStrip *data = (NlaStrip *)ptr->data;
259
260         if (value) {
261                 /* set the flag */
262                 data->flag |= NLASTRIP_FLAG_AUTO_BLENDS;
263
264                 /* validate state to ensure that auto-blend gets applied immediately */
265                 if (ptr->id.data) {
266                         IdAdtTemplate *iat = (IdAdtTemplate *)ptr->id.data;
267
268                         if (iat->adt) {
269                                 BKE_nla_validate_state(iat->adt);
270                         }
271                 }
272         }
273         else {
274                 /* clear the flag */
275                 data->flag &= ~NLASTRIP_FLAG_AUTO_BLENDS;
276
277                 /* clear the values too, so that it's clear that there has been an effect */
278                 /* TODO: it's somewhat debatable whether it's better to leave these in instead... */
279                 data->blendin  = 0.0f;
280                 data->blendout = 0.0f;
281         }
282 }
283
284 static int rna_NlaStrip_action_editable(PointerRNA *ptr, const char **UNUSED(r_info))
285 {
286         NlaStrip *strip = (NlaStrip *)ptr->data;
287
288         /* strip actions shouldn't be editable if NLA tweakmode is on */
289         if (ptr->id.data) {
290                 AnimData *adt = BKE_animdata_from_id(ptr->id.data);
291
292                 if (adt) {
293                         /* active action is only editable when it is not a tweaking strip */
294                         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact))
295                                 return 0;
296                 }
297         }
298
299         /* check for clues that strip probably shouldn't be used... */
300         if (strip->flag & NLASTRIP_FLAG_TWEAKUSER)
301                 return 0;
302
303         /* should be ok, though we may still miss some cases */
304         return PROP_EDITABLE;
305 }
306
307 static void rna_NlaStrip_action_start_frame_set(PointerRNA *ptr, float value)
308 {
309         NlaStrip *data = (NlaStrip *)ptr->data;
310
311         /* prevent start frame from occurring after end of action */
312         CLAMP(value, MINAFRAME, data->actend);
313         data->actstart = value;
314
315         /* adjust the strip extents in response to this */
316         /* TODO: should the strip be moved backwards instead as a special case? */
317         BKE_nlastrip_recalculate_bounds(data);
318 }
319
320 static void rna_NlaStrip_action_end_frame_set(PointerRNA *ptr, float value)
321 {
322         NlaStrip *data = (NlaStrip *)ptr->data;
323
324         /* prevent end frame from starting before start of action */
325         CLAMP(value, data->actstart, MAXFRAME);
326         data->actend = value;
327
328         /* adjust the strip extents in response to this */
329         BKE_nlastrip_recalculate_bounds(data);
330 }
331
332 static void rna_NlaStrip_animated_influence_set(PointerRNA *ptr, bool value)
333 {
334         NlaStrip *data = (NlaStrip *)ptr->data;
335
336         if (value) {
337                 /* set the flag, then make sure a curve for this exists */
338                 data->flag |= NLASTRIP_FLAG_USR_INFLUENCE;
339                 BKE_nlastrip_validate_fcurves(data);
340         }
341         else
342                 data->flag &= ~NLASTRIP_FLAG_USR_INFLUENCE;
343 }
344
345 static void rna_NlaStrip_animated_time_set(PointerRNA *ptr, bool value)
346 {
347         NlaStrip *data = (NlaStrip *)ptr->data;
348
349         if (value) {
350                 /* set the flag, then make sure a curve for this exists */
351                 data->flag |= NLASTRIP_FLAG_USR_TIME;
352                 BKE_nlastrip_validate_fcurves(data);
353         }
354         else
355                 data->flag &= ~NLASTRIP_FLAG_USR_TIME;
356 }
357
358 static FCurve *rna_NlaStrip_fcurve_find(NlaStrip *strip, ReportList *reports, const char *data_path, int index)
359 {
360         if (data_path[0] == '\0') {
361                 BKE_report(reports, RPT_ERROR, "F-Curve data path empty, invalid argument");
362                 return NULL;
363         }
364
365         /* Returns NULL if not found. */
366         return list_find_fcurve(&strip->fcurves, data_path, index);
367 }
368
369
370 static NlaStrip *rna_NlaStrip_new(NlaTrack *track, bContext *C, ReportList *reports, const char *UNUSED(name),
371                                   int start, bAction *action)
372 {
373         NlaStrip *strip = BKE_nlastrip_new(action);
374
375         if (strip == NULL) {
376                 BKE_report(reports, RPT_ERROR, "Unable to create new strip");
377                 return NULL;
378         }
379
380         strip->end += (start - strip->start);
381         strip->start = start;
382
383         if (BKE_nlastrips_add_strip(&track->strips, strip) == 0) {
384                 BKE_report(reports, RPT_ERROR,
385                            "Unable to add strip (the track does not have any space to accommodate this new strip)");
386                 BKE_nlastrip_free(NULL, strip, true);
387                 return NULL;
388         }
389
390         /* create dummy AnimData block so that BKE_nlastrip_validate_name()
391          * can be used to ensure a valid name, as we don't have one here...
392          *  - only the nla_tracks list is needed there, which we aim to reverse engineer here...
393          */
394         {
395                 AnimData adt = {NULL};
396                 NlaTrack *nlt, *nlt_p;
397
398                 /* 'first' NLA track is found by going back up chain of given track's parents until we fall off */
399                 nlt_p = track; nlt = track;
400                 while ((nlt = nlt->prev) != NULL)
401                         nlt_p = nlt;
402                 adt.nla_tracks.first = nlt_p;
403
404                 /* do the same thing to find the last track */
405                 nlt_p = track; nlt = track;
406                 while ((nlt = nlt->next) != NULL)
407                         nlt_p = nlt;
408                 adt.nla_tracks.last = nlt_p;
409
410                 /* now we can just auto-name as usual */
411                 BKE_nlastrip_validate_name(&adt, strip);
412         }
413
414         WM_event_add_notifier(C, NC_ANIMATION | ND_NLA | NA_ADDED, NULL);
415
416         return strip;
417 }
418
419 static void rna_NlaStrip_remove(NlaTrack *track, bContext *C, ReportList *reports, PointerRNA *strip_ptr)
420 {
421         NlaStrip *strip = strip_ptr->data;
422         if (BLI_findindex(&track->strips, strip) == -1) {
423                 BKE_reportf(reports, RPT_ERROR, "NLA strip '%s' not found in track '%s'", strip->name, track->name);
424                 return;
425         }
426
427         BKE_nlastrip_free(&track->strips, strip, true);
428         RNA_POINTER_INVALIDATE(strip_ptr);
429
430         WM_event_add_notifier(C, NC_ANIMATION | ND_NLA | NA_REMOVED, NULL);
431 }
432
433 /* Set the 'solo' setting for the given NLA-track, making sure that it is the only one
434  * that has this status in its AnimData block.
435  */
436 static void rna_NlaTrack_solo_set(PointerRNA *ptr, bool value)
437 {
438         NlaTrack *data = (NlaTrack *)ptr->data;
439         AnimData *adt = BKE_animdata_from_id(ptr->id.data);
440         NlaTrack *nt;
441
442         if (data == NULL) {
443                 return;
444         }
445
446         /* firstly, make sure 'solo' flag for all tracks is disabled */
447         for (nt = data; nt; nt = nt->next) {
448                 nt->flag &= ~NLATRACK_SOLO;
449         }
450         for (nt = data; nt; nt = nt->prev) {
451                 nt->flag &= ~NLATRACK_SOLO;
452         }
453
454         /* now, enable 'solo' for the given track if appropriate */
455         if (value) {
456                 /* set solo status */
457                 data->flag |= NLATRACK_SOLO;
458
459                 /* set solo-status on AnimData */
460                 adt->flag |= ADT_NLA_SOLO_TRACK;
461         }
462         else {
463                 /* solo status was already cleared on track */
464
465                 /* clear solo-status on AnimData */
466                 adt->flag &= ~ADT_NLA_SOLO_TRACK;
467         }
468 }
469
470 #else
471
472 /* enum defines exported for rna_animation.c */
473 const EnumPropertyItem rna_enum_nla_mode_blend_items[] = {
474         {NLASTRIP_MODE_REPLACE, "REPLACE", 0, "Replace",
475                                 "Result strip replaces the accumulated results by amount specified by influence"},
476         {NLASTRIP_MODE_ADD, "ADD", 0, "Add", "Weighted result of strip is added to the accumulated results"},
477         {NLASTRIP_MODE_SUBTRACT, "SUBTRACT", 0, "Subtract",
478                                  "Weighted result of strip is removed from the accumulated results"},
479         {NLASTRIP_MODE_MULTIPLY, "MULTIPLY", 0, "Multiply",
480                                  "Weighted result of strip is multiplied with the accumulated results"},
481         {0, NULL, 0, NULL, NULL}
482 };
483
484 const EnumPropertyItem rna_enum_nla_mode_extend_items[] = {
485         {NLASTRIP_EXTEND_NOTHING, "NOTHING", 0, "Nothing", "Strip has no influence past its extents"},
486         {NLASTRIP_EXTEND_HOLD, "HOLD", 0, "Hold",
487                                "Hold the first frame if no previous strips in track, and always hold last frame"},
488         {NLASTRIP_EXTEND_HOLD_FORWARD, "HOLD_FORWARD", 0, "Hold Forward", "Only hold last frame"},
489         {0, NULL, 0, NULL, NULL}
490 };
491
492 static void rna_def_strip_fcurves(BlenderRNA *brna, PropertyRNA *cprop)
493 {
494         StructRNA *srna;
495
496         FunctionRNA *func;
497         PropertyRNA *parm;
498
499         RNA_def_property_srna(cprop, "NlaStripFCurves");
500         srna = RNA_def_struct(brna, "NlaStripFCurves", NULL);
501         RNA_def_struct_sdna(srna, "NlaStrip");
502         RNA_def_struct_ui_text(srna, "NLA-Strip F-Curves", "Collection of NLA strip F-Curves");
503
504         /* Strip.fcurves.find(...) */
505         func = RNA_def_function(srna, "find", "rna_NlaStrip_fcurve_find");
506         RNA_def_function_ui_description(func, "Find an F-Curve. Note that this function performs a linear scan "
507                                         "of all F-Curves in the NLA strip.");
508         RNA_def_function_flag(func, FUNC_USE_REPORTS);
509         parm = RNA_def_string(func, "data_path", NULL, 0, "Data Path", "F-Curve data path");
510         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
511         RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "Array index", 0, INT_MAX);
512
513         parm = RNA_def_pointer(func, "fcurve", "FCurve", "", "The found F-Curve, or None if it doesn't exist");
514         RNA_def_function_return(func, parm);
515 }
516
517 static void rna_def_nlastrip(BlenderRNA *brna)
518 {
519         StructRNA *srna;
520         PropertyRNA *prop;
521
522         /* enum defs */
523         static const EnumPropertyItem prop_type_items[] = {
524                 {NLASTRIP_TYPE_CLIP, "CLIP", 0, "Action Clip", "NLA Strip references some Action"},
525                 {NLASTRIP_TYPE_TRANSITION, "TRANSITION", 0, "Transition", "NLA Strip 'transitions' between adjacent strips"},
526                 {NLASTRIP_TYPE_META, "META", 0, "Meta", "NLA Strip acts as a container for adjacent strips"},
527                 {NLASTRIP_TYPE_SOUND, "SOUND", 0, "Sound Clip", "NLA Strip representing a sound event for speakers"},
528                 {0, NULL, 0, NULL, NULL}
529         };
530
531         /* struct definition */
532         srna = RNA_def_struct(brna, "NlaStrip", NULL);
533         RNA_def_struct_ui_text(srna, "NLA Strip", "A container referencing an existing Action");
534         RNA_def_struct_path_func(srna, "rna_NlaStrip_path");
535         RNA_def_struct_ui_icon(srna, ICON_NLA); /* XXX */
536
537         /* name property */
538         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
539         RNA_def_property_ui_text(prop, "Name", "");
540         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_NlaStrip_name_set");
541         RNA_def_struct_name_property(srna, prop);
542         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
543
544         /* Enums */
545         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
546         RNA_def_property_enum_sdna(prop, NULL, "type");
547         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* XXX for now, not editable, since this is dangerous */
548         RNA_def_property_enum_items(prop, prop_type_items);
549         RNA_def_property_ui_text(prop, "Type", "Type of NLA Strip");
550         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
551
552         prop = RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
553         RNA_def_property_enum_sdna(prop, NULL, "extendmode");
554         RNA_def_property_enum_items(prop, rna_enum_nla_mode_extend_items);
555         RNA_def_property_ui_text(prop, "Extrapolation", "Action to take for gaps past the strip extents");
556         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
557
558         prop = RNA_def_property(srna, "blend_type", PROP_ENUM, PROP_NONE);
559         RNA_def_property_enum_sdna(prop, NULL, "blendmode");
560         RNA_def_property_enum_items(prop, rna_enum_nla_mode_blend_items);
561         RNA_def_property_ui_text(prop, "Blending", "Method used for combining strip's result with accumulated result");
562         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
563
564         /* Strip extents */
565         prop = RNA_def_property(srna, "frame_start", PROP_FLOAT, PROP_TIME);
566         RNA_def_property_float_sdna(prop, NULL, "start");
567         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_start_frame_set", NULL);
568         RNA_def_property_ui_text(prop, "Start Frame", "");
569         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_transform_update");
570
571         prop = RNA_def_property(srna, "frame_end", PROP_FLOAT, PROP_TIME);
572         RNA_def_property_float_sdna(prop, NULL, "end");
573         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_end_frame_set", NULL);
574         RNA_def_property_ui_text(prop, "End Frame", "");
575         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_transform_update");
576
577         /* Blending */
578         prop = RNA_def_property(srna, "blend_in", PROP_FLOAT, PROP_NONE);
579         RNA_def_property_float_sdna(prop, NULL, "blendin");
580         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_in_set", NULL);
581         RNA_def_property_ui_text(prop, "Blend In", "Number of frames at start of strip to fade in influence");
582         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
583
584         prop = RNA_def_property(srna, "blend_out", PROP_FLOAT, PROP_NONE);
585         RNA_def_property_float_sdna(prop, NULL, "blendout");
586         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_out_set", NULL);
587         RNA_def_property_ui_text(prop, "Blend Out", "");
588         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
589
590         prop = RNA_def_property(srna, "use_auto_blend", PROP_BOOLEAN, PROP_NONE);
591         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_AUTO_BLENDS);
592         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_use_auto_blend_set");
593         RNA_def_property_ui_text(prop, "Auto Blend In/Out",
594                                  "Number of frames for Blending In/Out is automatically determined from "
595                                  "overlapping strips");
596         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
597
598         /* Action */
599         prop = RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
600         RNA_def_property_pointer_sdna(prop, NULL, "act");
601         RNA_def_property_pointer_funcs(prop, NULL, NULL, NULL, "rna_Action_id_poll");
602         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_ID_REFCOUNT);
603         RNA_def_property_editable_func(prop, "rna_NlaStrip_action_editable");
604         RNA_def_property_ui_text(prop, "Action", "Action referenced by this strip");
605         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
606
607         /* Action extents */
608         prop = RNA_def_property(srna, "action_frame_start", PROP_FLOAT, PROP_TIME);
609         RNA_def_property_float_sdna(prop, NULL, "actstart");
610         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_start_frame_set", NULL);
611         RNA_def_property_ui_text(prop, "Action Start Frame", "First frame from action to use");
612         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_transform_update");
613
614         prop = RNA_def_property(srna, "action_frame_end", PROP_FLOAT, PROP_TIME);
615         RNA_def_property_float_sdna(prop, NULL, "actend");
616         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_end_frame_set", NULL);
617         RNA_def_property_ui_text(prop, "Action End Frame", "Last frame from action to use");
618         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_transform_update");
619
620         /* Action Reuse */
621         prop = RNA_def_property(srna, "repeat", PROP_FLOAT, PROP_NONE);
622         RNA_def_property_float_sdna(prop, NULL, "repeat");
623         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_repeat_set", NULL);
624         /* these limits have currently be chosen arbitrarily, but could be extended
625          * (minimum should still be > 0 though) if needed... */
626         RNA_def_property_range(prop, 0.1f, 1000.0f);
627         RNA_def_property_ui_text(prop, "Repeat", "Number of times to repeat the action range");
628         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_transform_update");
629
630         prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_NONE);
631         RNA_def_property_float_sdna(prop, NULL, "scale");
632         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_scale_set", NULL);
633         /* these limits can be extended, but beyond this, we can get some crazy+annoying bugs
634          * due to numeric errors */
635         RNA_def_property_range(prop, 0.0001f, 1000.0f);
636         RNA_def_property_ui_text(prop, "Scale", "Scaling factor for action");
637         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_transform_update");
638
639         /* Strip's F-Curves */
640         prop = RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
641         RNA_def_property_collection_sdna(prop, NULL, "fcurves", NULL);
642         RNA_def_property_struct_type(prop, "FCurve");
643         RNA_def_property_ui_text(prop, "F-Curves", "F-Curves for controlling the strip's influence and timing");
644         rna_def_strip_fcurves(brna, prop);
645
646         /* Strip's F-Modifiers */
647         prop = RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
648         RNA_def_property_struct_type(prop, "FModifier");
649         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting all the F-Curves in the referenced Action");
650
651         /* Strip's Sub-Strips (for Meta-Strips) */
652         prop = RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
653         RNA_def_property_struct_type(prop, "NlaStrip");
654         RNA_def_property_ui_text(prop, "NLA Strips",
655                                  "NLA Strips that this strip acts as a container for (if it is of type Meta)");
656
657         /* Settings - Values necessary for evaluation */
658         prop = RNA_def_property(srna, "influence", PROP_FLOAT, PROP_FACTOR);
659         RNA_def_property_range(prop, 0.0f, 1.0f);
660         RNA_def_property_ui_text(prop, "Influence", "Amount the strip contributes to the current result");
661         /* XXX: Update temporarily disabled so that the property can be edited at all!
662          * Even autokey only applies after the curves have been re-evaluated, causing the unkeyed values to be lost
663          */
664         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, /*"rna_NlaStrip_update"*/ NULL);
665
666         prop = RNA_def_property(srna, "strip_time", PROP_FLOAT, PROP_TIME);
667         RNA_def_property_ui_text(prop, "Strip Time", "Frame of referenced Action to evaluate");
668         /* XXX: Update temporarily disabled so that the property can be edited at all!
669          * Even autokey only applies after the curves have been re-evaluated, causing the unkeyed values to be lost
670          */
671         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, /*"rna_NlaStrip_update"*/ NULL);
672
673         /* TODO: should the animated_influence/time settings be animatable themselves? */
674         prop = RNA_def_property(srna, "use_animated_influence", PROP_BOOLEAN, PROP_NONE);
675         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_INFLUENCE);
676         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_influence_set");
677         RNA_def_property_ui_text(prop, "Animated Influence",
678                                  "Influence setting is controlled by an F-Curve rather than automatically determined");
679         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
680
681         prop = RNA_def_property(srna, "use_animated_time", PROP_BOOLEAN, PROP_NONE);
682         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME);
683         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_time_set");
684         RNA_def_property_ui_text(prop, "Animated Strip Time",
685                                  "Strip time is controlled by an F-Curve rather than automatically determined");
686         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
687
688         prop = RNA_def_property(srna, "use_animated_time_cyclic", PROP_BOOLEAN, PROP_NONE);
689         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME_CYCLIC);
690         RNA_def_property_ui_text(prop, "Cyclic Strip Time", "Cycle the animated time within the action start & end");
691         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_transform_update");
692
693         /* settings */
694         prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
695         /* can be made editable by hooking it up to the necessary NLA API methods */
696         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
697         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_ACTIVE);
698         RNA_def_property_ui_text(prop, "Active", "NLA Strip is active");
699         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
700
701         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
702         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_SELECT);
703         RNA_def_property_ui_text(prop, "Select", "NLA Strip is selected");
704         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
705
706         prop = RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
707         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_MUTED);
708         RNA_def_property_ui_text(prop, "Muted", "NLA Strip is not evaluated");
709         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
710
711         prop = RNA_def_property(srna, "use_reverse", PROP_BOOLEAN, PROP_NONE);
712         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_REVERSE);
713         RNA_def_property_ui_text(prop, "Reversed",
714                                  "NLA Strip is played back in reverse order (only when timing is "
715                                  "automatically determined)");
716         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
717
718         prop = RNA_def_property(srna, "use_sync_length", PROP_BOOLEAN, PROP_NONE);
719         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_SYNC_LENGTH);
720         RNA_def_property_ui_text(prop, "Sync Action Length",
721                                  "Update range of frames referenced from action "
722                                  "after tweaking strip and its keyframes");
723         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
724 }
725
726 static void rna_api_nlatrack_strips(BlenderRNA *brna, PropertyRNA *cprop)
727 {
728         StructRNA *srna;
729         PropertyRNA *parm;
730         FunctionRNA *func;
731
732         RNA_def_property_srna(cprop, "NlaStrips");
733         srna = RNA_def_struct(brna, "NlaStrips", NULL);
734         RNA_def_struct_sdna(srna, "NlaTrack");
735         RNA_def_struct_ui_text(srna, "Nla Strips", "Collection of Nla Strips");
736
737         func = RNA_def_function(srna, "new", "rna_NlaStrip_new");
738         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
739         RNA_def_function_ui_description(func, "Add a new Action-Clip strip to the track");
740         parm = RNA_def_string(func, "name", "NlaStrip", 0, "", "Name for the NLA Strips");
741         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
742         parm = RNA_def_int(func, "start", 0, INT_MIN, INT_MAX, "Start Frame",
743                            "Start frame for this strip", INT_MIN, INT_MAX);
744         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
745         parm = RNA_def_pointer(func, "action", "Action", "", "Action to assign to this strip");
746         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
747         /* return type */
748         parm = RNA_def_pointer(func, "strip", "NlaStrip", "", "New NLA Strip");
749         RNA_def_function_return(func, parm);
750
751         func = RNA_def_function(srna, "remove", "rna_NlaStrip_remove");
752         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
753         RNA_def_function_ui_description(func, "Remove a NLA Strip");
754         parm = RNA_def_pointer(func, "strip", "NlaStrip", "", "NLA Strip to remove");
755         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
756         RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
757 }
758
759 static void rna_def_nlatrack(BlenderRNA *brna)
760 {
761         StructRNA *srna;
762         PropertyRNA *prop;
763
764         srna = RNA_def_struct(brna, "NlaTrack", NULL);
765         RNA_def_struct_ui_text(srna, "NLA Track", "A animation layer containing Actions referenced as NLA strips");
766         RNA_def_struct_ui_icon(srna, ICON_NLA);
767
768         /* strips collection */
769         prop = RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
770         RNA_def_property_struct_type(prop, "NlaStrip");
771         RNA_def_property_ui_text(prop, "NLA Strips", "NLA Strips on this NLA-track");
772
773         rna_api_nlatrack_strips(brna, prop);
774
775         /* name property */
776         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
777         RNA_def_property_ui_text(prop, "Name", "");
778         RNA_def_struct_name_property(srna, prop);
779         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
780
781         /* settings */
782         prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
783         /* can be made editable by hooking it up to the necessary NLA API methods */
784         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
785         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_ACTIVE);
786         RNA_def_property_ui_text(prop, "Active", "NLA Track is active");
787         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
788
789         prop = RNA_def_property(srna, "is_solo", PROP_BOOLEAN, PROP_NONE);
790         /* can be made editable by hooking it up to the necessary NLA API methods */
791         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SOLO);
792         RNA_def_property_ui_text(prop, "Solo",
793                                  "NLA Track is evaluated itself (i.e. active Action and all other NLA Tracks in the "
794                                  "same AnimData block are disabled)");
795         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
796         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaTrack_solo_set");
797
798         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
799         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SELECTED);
800         RNA_def_property_ui_text(prop, "Select", "NLA Track is selected");
801         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
802
803         prop = RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
804         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_MUTED);
805         RNA_def_property_ui_text(prop, "Muted", "NLA Track is not evaluated");
806         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA | NA_EDITED, "rna_NlaStrip_update");
807
808         prop = RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
809         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_PROTECTED);
810         RNA_def_property_ui_text(prop, "Locked", "NLA Track is locked");
811         RNA_def_property_update(prop, NC_ANIMATION | ND_NLA, NULL); /* this will do? */
812 }
813
814 /* --------- */
815
816 void RNA_def_nla(BlenderRNA *brna)
817 {
818         rna_def_nlatrack(brna);
819         rna_def_nlastrip(brna);
820 }
821
822
823 #endif