NLA SoC: Tweaks from feedback from Broken + jez
[blender.git] / source / blender / makesrna / intern / rna_nla.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2009), Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_anim_types.h"
33 #include "DNA_action_types.h"
34 #include "DNA_scene_types.h"
35
36 #include "MEM_guardedalloc.h"
37
38 #ifdef RNA_RUNTIME
39
40 #include <stdio.h>
41 #include <math.h>
42
43 /* needed for some of the validation stuff... */
44 #include "BKE_nla.h"
45
46 /* temp constant defined for these funcs only... */
47 #define NLASTRIP_MIN_LEN_THRESH         0.1f
48
49 static void rna_NlaStrip_start_frame_set(PointerRNA *ptr, float value)
50 {
51         NlaStrip *data= (NlaStrip*)ptr->data;
52         
53         /* clamp value to lie within valid limits 
54          *      - cannot start past the end of the strip + some flexibility threshold
55          *      - cannot start before the previous strip (if present) ends
56          *              -> but if it was a transition, we could go up to the start of the strip + some flexibility threshold
57          *              as long as we re-adjust the transition afterwards
58          *      - minimum frame is -MAXFRAME so that we don't get clipping on frame 0
59          */
60         if (data->prev) {
61                 if (data->prev->type == NLASTRIP_TYPE_TRANSITION) {
62                         CLAMP(value, data->prev->start+NLASTRIP_MIN_LEN_THRESH, data->end-NLASTRIP_MIN_LEN_THRESH);
63                         
64                         /* readjust the transition to stick to the endpoints of the action-clips */
65                         data->prev->end= value;
66                 }
67                 else {
68                         CLAMP(value, data->prev->end, data->end-NLASTRIP_MIN_LEN_THRESH);
69                 }
70         }
71         else {
72                 CLAMP(value, MINAFRAME, data->end);
73         }
74         data->start= value;
75 }
76
77 static void rna_NlaStrip_end_frame_set(PointerRNA *ptr, float value)
78 {
79         NlaStrip *data= (NlaStrip*)ptr->data;
80         
81         /* clamp value to lie within valid limits
82          *      - must not have zero or negative length strip, so cannot start before the first frame 
83          *        + some minimum-strip-length threshold
84          *      - cannot end later than the start of the next strip (if present)
85          *              -> but if it was a transition, we could go up to the start of the end - some flexibility threshold
86          *              as long as we re-adjust the transition afterwards
87          */
88         if (data->next) {
89                 if (data->next->type == NLASTRIP_TYPE_TRANSITION) {
90                         CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, data->next->end-NLASTRIP_MIN_LEN_THRESH);
91                         
92                         /* readjust the transition to stick to the endpoints of the action-clips */
93                         data->next->start= value;
94                 }
95                 else {
96                         CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, data->next->start);
97                 }
98         }
99         else {
100                 CLAMP(value, data->start+NLASTRIP_MIN_LEN_THRESH, MAXFRAME);
101         }
102         data->end= value;
103         
104         
105         /* calculate the lengths the strip and its action (if applicable) */
106         if (data->type == NLASTRIP_TYPE_CLIP) {
107                 float len, actlen;
108                 
109                 len= data->end - data->start;
110                 actlen= data->actend - data->actstart;
111                 if (IS_EQ(actlen, 0.0f)) actlen= 1.0f;
112                 
113                 /* now, adjust the 'scale' setting to reflect this (so that this change can be valid) */
114                 data->scale= len / ((actlen) * data->repeat);
115         }
116 }
117
118 static void rna_NlaStrip_scale_set(PointerRNA *ptr, float value)
119 {
120         NlaStrip *data= (NlaStrip*)ptr->data;
121         float actlen, mapping;
122         
123         /* set scale value */
124         CLAMP(value, 0.0001f, 1000.0f); /* NOTE: these need to be synced with the values in the property definition in rna_def_nlastrip() */
125         data->scale= value;
126         
127         /* calculate existing factors */
128         actlen= data->actend - data->actstart;
129         if (IS_EQ(actlen, 0.0f)) actlen= 1.0f;
130         mapping= data->scale * data->repeat;
131         
132         /* adjust endpoint of strip in response to this */
133         if (IS_EQ(mapping, 0.0f) == 0)
134                 data->end = (actlen * mapping) + data->start; 
135         else
136                 printf("NlaStrip Set Scale Error (in RNA): Scale = %0.4f, Repeat = %0.4f \n", data->scale, data->repeat);
137 }
138
139 static void rna_NlaStrip_repeat_set(PointerRNA *ptr, float value)
140 {
141         NlaStrip *data= (NlaStrip*)ptr->data;
142         float actlen, mapping;
143         
144         /* set scale value */
145         CLAMP(value, 0.01f, 1000.0f); /* NOTE: these need to be synced with the values in the property definition in rna_def_nlastrip() */
146         data->repeat= value;
147         
148         /* calculate existing factors */
149         actlen= data->actend - data->actstart;
150         if (IS_EQ(actlen, 0.0f)) actlen= 1.0f;
151         mapping= data->scale * data->repeat;
152         
153         /* adjust endpoint of strip in response to this */
154         if (IS_EQ(mapping, 0.0f) == 0)
155                 data->end = (actlen * mapping) + data->start; 
156         else
157                 printf("NlaStrip Set Repeat Error (in RNA): Scale = %0.4f, Repeat = %0.4f \n", data->scale, data->repeat);
158 }
159
160 static void rna_NlaStrip_blend_in_set(PointerRNA *ptr, float value)
161 {
162         NlaStrip *data= (NlaStrip*)ptr->data;
163         float len;
164         
165         /* blend-in is limited to the length of the strip, and also cannot overlap with blendout */
166         len= (data->end - data->start) - data->blendout;
167         CLAMP(value, 0, len);
168         
169         data->blendin= value;
170 }
171
172 static void rna_NlaStrip_blend_out_set(PointerRNA *ptr, float value)
173 {
174         NlaStrip *data= (NlaStrip*)ptr->data;
175         float len;
176         
177         /* blend-out is limited to the length of the strip */
178         len= (data->end - data->start);
179         CLAMP(value, 0, len);
180         
181         /* it also cannot overlap with blendin */
182         if ((len - value) < data->blendin)
183                 value= len - data->blendin;
184         
185         data->blendout= value;
186 }
187
188 static void rna_NlaStrip_action_start_frame_set(PointerRNA *ptr, float value)
189 {
190         NlaStrip *data= (NlaStrip*)ptr->data;
191         CLAMP(value, MINAFRAME, data->actend);
192         data->actstart= value;
193 }
194
195 static void rna_NlaStrip_action_end_frame_set(PointerRNA *ptr, float value)
196 {
197         NlaStrip *data= (NlaStrip*)ptr->data;
198         CLAMP(value, data->actstart, MAXFRAME);
199         data->actend= value;
200 }
201
202 static void rna_NlaStrip_animated_influence_set(PointerRNA *ptr, int value)
203 {
204         NlaStrip *data= (NlaStrip*)ptr->data;
205         
206         if (value) {
207                 /* set the flag, then make sure a curve for this exists */
208                 data->flag |= NLASTRIP_FLAG_USR_INFLUENCE;
209                 BKE_nlastrip_validate_fcurves(data);
210         }
211         else
212                 data->flag &= ~NLASTRIP_FLAG_USR_INFLUENCE;
213 }
214
215 static void rna_NlaStrip_animated_time_set(PointerRNA *ptr, int value)
216 {
217         NlaStrip *data= (NlaStrip*)ptr->data;
218         
219         if (value) {
220                 /* set the flag, then make sure a curve for this exists */
221                 data->flag |= NLASTRIP_FLAG_USR_TIME;
222                 BKE_nlastrip_validate_fcurves(data);
223         }
224         else
225                 data->flag &= ~NLASTRIP_FLAG_USR_TIME;
226 }
227
228 #else
229
230 void rna_def_nlastrip(BlenderRNA *brna)
231 {
232         StructRNA *srna;
233         PropertyRNA *prop;
234         
235                 /* enum defs */
236         static EnumPropertyItem prop_type_items[] = {
237                 {NLASTRIP_TYPE_CLIP, "CLIP", 0, "Action Clip", "NLA Strip references some Action."},
238                 {NLASTRIP_TYPE_TRANSITION, "TRANSITION", 0, "Transition", "NLA Strip 'transitions' between adjacent strips."},
239                 {NLASTRIP_TYPE_META, "META", 0, "Meta", "NLA Strip acts as a container for adjacent strips."},
240                 {0, NULL, 0, NULL, NULL}};
241         static EnumPropertyItem prop_mode_blend_items[] = {
242                 {NLASTRIP_MODE_REPLACE, "REPLACE", 0, "Replace", "Result strip replaces the accumulated results by amount specified by influence."},
243                 {NLASTRIP_MODE_ADD, "ADD", 0, "Add", "Weighted result of strip is added to the accumlated results."},
244                 {NLASTRIP_MODE_SUBTRACT, "SUBTRACT", 0, "Subtract", "Weighted result of strip is removed from the accumlated results."},
245                 {NLASTRIP_MODE_MULTIPLY, "MULITPLY", 0, "Multiply", "Weighted result of strip is multiplied with the accumlated results."},
246                 {0, NULL, 0, NULL, NULL}};
247         static EnumPropertyItem prop_mode_extend_items[] = {
248                 {NLASTRIP_EXTEND_NOTHING, "NOTHING", 0, "Nothing", "Strip has no influence past its extents."},
249                 {NLASTRIP_EXTEND_HOLD, "HOLD", 0, "Hold", "Hold the first frame if no previous strips in track, and always hold last frame."},
250                 {NLASTRIP_EXTEND_HOLD_FORWARD, "HOLD_FORWARD", 0, "Hold Forward", "Only hold last frame."},
251                 {0, NULL, 0, NULL, NULL}};
252         
253         /* struct definition */
254         srna= RNA_def_struct(brna, "NlaStrip", NULL);
255         RNA_def_struct_ui_text(srna, "NLA Strip", "A container referencing an existing Action.");
256         RNA_def_struct_ui_icon(srna, ICON_NLA); // XXX
257         
258         /* Enums */
259         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
260         RNA_def_property_enum_sdna(prop, NULL, "type");
261         RNA_def_property_clear_flag(prop, PROP_EDITABLE); // XXX for now, not editable, since this is dangerous
262         RNA_def_property_enum_items(prop, prop_type_items);
263         RNA_def_property_ui_text(prop, "Type", "Type of NLA Strip.");
264         
265         prop= RNA_def_property(srna, "extrapolation", PROP_ENUM, PROP_NONE);
266         RNA_def_property_enum_sdna(prop, NULL, "extendmode");
267         RNA_def_property_enum_items(prop, prop_mode_extend_items);
268         RNA_def_property_ui_text(prop, "Extrapolation", "Action to take for gaps past the strip extents.");
269         
270         prop= RNA_def_property(srna, "blending", PROP_ENUM, PROP_NONE);
271         RNA_def_property_enum_sdna(prop, NULL, "blendmode");
272         RNA_def_property_enum_items(prop, prop_mode_blend_items);
273         RNA_def_property_ui_text(prop, "Blending", "Method used for combining strip's result with accumulated result.");
274         
275         /* Strip extents */
276         prop= RNA_def_property(srna, "start_frame", PROP_FLOAT, PROP_NONE);
277         RNA_def_property_float_sdna(prop, NULL, "start");
278         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_start_frame_set", NULL);
279         RNA_def_property_ui_text(prop, "Start Frame", "");
280         
281         prop= RNA_def_property(srna, "end_frame", PROP_FLOAT, PROP_NONE);
282         RNA_def_property_float_sdna(prop, NULL, "end");
283         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_end_frame_set", NULL);
284         RNA_def_property_ui_text(prop, "End Frame", "");
285         
286         /* Blending */
287         prop= RNA_def_property(srna, "blend_in", PROP_FLOAT, PROP_NONE);
288         RNA_def_property_float_sdna(prop, NULL, "blendin");
289         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_in_set", NULL);
290         RNA_def_property_ui_text(prop, "Blend In", "Number of frames at start of strip to fade in influence.");
291         
292         prop= RNA_def_property(srna, "blend_out", PROP_FLOAT, PROP_NONE);
293         RNA_def_property_float_sdna(prop, NULL, "blendout");
294         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_blend_out_set", NULL);
295         RNA_def_property_ui_text(prop, "Blend Out", "");
296         
297         prop= RNA_def_property(srna, "auto_blending", PROP_BOOLEAN, PROP_NONE);
298         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_AUTO_BLENDS);
299         RNA_def_property_ui_text(prop, "Auto Blend In/Out", "Number of frames for Blending In/Out is automatically determined from overlapping strips.");
300         
301         /* Action */
302         prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
303         RNA_def_property_pointer_sdna(prop, NULL, "act");
304         RNA_def_property_ui_text(prop, "Action", "Action referenced by this strip.");
305         
306         /* Action extents */
307         prop= RNA_def_property(srna, "action_start_frame", PROP_FLOAT, PROP_NONE);
308         RNA_def_property_float_sdna(prop, NULL, "actstart");
309         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_start_frame_set", NULL);
310         RNA_def_property_ui_text(prop, "Action Start Frame", "");
311         
312         prop= RNA_def_property(srna, "action_end_frame", PROP_FLOAT, PROP_NONE);
313         RNA_def_property_float_sdna(prop, NULL, "actend");
314         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_action_end_frame_set", NULL);
315         RNA_def_property_ui_text(prop, "Action End Frame", "");
316         
317         /* Action Reuse */
318         prop= RNA_def_property(srna, "repeat", PROP_FLOAT, PROP_NONE);
319         RNA_def_property_float_sdna(prop, NULL, "repeat"); 
320         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_repeat_set", NULL);
321         RNA_def_property_range(prop, 0.1f, 1000.0f); /* these limits have currently be chosen arbitarily, but could be extended (minimum should still be > 0 though) if needed... */
322         RNA_def_property_ui_text(prop, "Repeat", "Number of times to repeat the action range.");
323         
324         prop= RNA_def_property(srna, "scale", PROP_FLOAT, PROP_NONE);
325         RNA_def_property_float_sdna(prop, NULL, "scale"); 
326         RNA_def_property_float_funcs(prop, NULL, "rna_NlaStrip_scale_set", NULL);
327         RNA_def_property_range(prop, 0.0001f, 1000.0f); /* these limits can be extended, but beyond this, we can get some crazy+annoying bugs due to numeric errors */
328         RNA_def_property_ui_text(prop, "Scale", "Scaling factor for action.");
329         
330         /* Strip's F-Curves */
331         prop= RNA_def_property(srna, "fcurves", PROP_COLLECTION, PROP_NONE);
332         RNA_def_property_struct_type(prop, "FCurve");
333         RNA_def_property_ui_text(prop, "F-Curves", "F-Curves for controlling the strip's influence and timing.");
334         
335         /* Strip's F-Modifiers */
336         prop= RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
337         RNA_def_property_struct_type(prop, "FModifier");
338         RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting all the F-Curves in the referenced Action.");
339         
340         /* Strip's Sub-Strips (for Meta-Strips) */
341         prop= RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
342         RNA_def_property_struct_type(prop, "NlaStrip");
343         RNA_def_property_ui_text(prop, "NLA Strips", "NLA Strips that this strip acts as a container for (if it is of type Meta).");
344         
345         /* Settings - Values necessary for evaluation */
346         prop= RNA_def_property(srna, "influence", PROP_FLOAT, PROP_NONE);
347         RNA_def_property_range(prop, 0.0f, 1.0f);
348         RNA_def_property_ui_text(prop, "Influence", "Amount the strip contributes to the current result.");
349         
350         prop= RNA_def_property(srna, "strip_time", PROP_FLOAT, PROP_NONE);
351         RNA_def_property_ui_text(prop, "Strip Time", "Frame of referenced Action to evaluate.");
352         
353                 // TODO: should the animated_influence/time settings be animatable themselves?
354         prop= RNA_def_property(srna, "animated_influence", PROP_BOOLEAN, PROP_NONE);
355         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_INFLUENCE);
356         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_influence_set");
357         RNA_def_property_ui_text(prop, "Animated Influence", "Influence setting is controlled by an F-Curve rather than automatically determined.");
358         
359         prop= RNA_def_property(srna, "animated_time", PROP_BOOLEAN, PROP_NONE);
360         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_USR_TIME);
361         RNA_def_property_boolean_funcs(prop, NULL, "rna_NlaStrip_animated_time_set");
362         RNA_def_property_ui_text(prop, "Animated Strip Time", "Strip time is controlled by an F-Curve rather than automatically determined.");
363         
364         /* settings */
365         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
366         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
367         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_ACTIVE);
368         RNA_def_property_ui_text(prop, "Active", "NLA Strip is active.");
369         
370         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
371         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_SELECT);
372         RNA_def_property_ui_text(prop, "Selected", "NLA Strip is selected.");
373         
374         prop= RNA_def_property(srna, "muted", PROP_BOOLEAN, PROP_NONE);
375         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_MUTED);
376         RNA_def_property_ui_text(prop, "Muted", "NLA Strip is not evaluated.");
377         
378         prop= RNA_def_property(srna, "reversed", PROP_BOOLEAN, PROP_NONE);
379         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLASTRIP_FLAG_REVERSE);
380         RNA_def_property_ui_text(prop, "Reversed", "NLA Strip is played back in reverse order (only when timing is automatically determined).");
381         
382         // TODO: 
383         // - sync length
384 }
385
386 void rna_def_nlatrack(BlenderRNA *brna)
387 {
388         StructRNA *srna;
389         PropertyRNA *prop;
390         
391         srna= RNA_def_struct(brna, "NlaTrack", NULL);
392         RNA_def_struct_ui_text(srna, "NLA Track", "A animation layer containing Actions referenced as NLA strips.");
393         RNA_def_struct_ui_icon(srna, ICON_NLA);
394         
395         /* strips collection */
396         prop= RNA_def_property(srna, "strips", PROP_COLLECTION, PROP_NONE);
397         RNA_def_property_struct_type(prop, "NlaStrip");
398         RNA_def_property_ui_text(prop, "NLA Strips", "NLA Strips on this NLA-track.");
399         
400         /* name property */
401         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
402         RNA_def_property_ui_text(prop, "Name", "");
403         RNA_def_struct_name_property(srna, prop);
404         
405         /* settings */
406         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
407         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
408         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_ACTIVE);
409         RNA_def_property_ui_text(prop, "Active", "NLA Track is active.");
410         
411         prop= RNA_def_property(srna, "solo", PROP_BOOLEAN, PROP_NONE);
412         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* can be made editable by hooking it up to the necessary NLA API methods */
413         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SOLO);
414         RNA_def_property_ui_text(prop, "Solo", "NLA Track is evaluated itself (i.e. active Action and all other NLA Tracks in the same AnimData block are disabled).");
415         
416         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
417         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_SELECTED);
418         RNA_def_property_ui_text(prop, "Selected", "NLA Track is selected.");
419         
420         prop= RNA_def_property(srna, "muted", PROP_BOOLEAN, PROP_NONE);
421         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_MUTED);
422         RNA_def_property_ui_text(prop, "Muted", "NLA Track is not evaluated.");
423
424         prop= RNA_def_property(srna, "locked", PROP_BOOLEAN, PROP_NONE);
425         RNA_def_property_boolean_sdna(prop, NULL, "flag", NLATRACK_PROTECTED);
426         RNA_def_property_ui_text(prop, "Locked", "NLA Track is locked.");
427 }
428
429 /* --------- */
430
431 void RNA_def_nla(BlenderRNA *brna)
432 {
433         rna_def_nlatrack(brna);
434         rna_def_nlastrip(brna);
435 }
436
437
438 #endif