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