falloff option for mask layers
[blender.git] / source / blender / makesrna / intern / rna_mask.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,
19  *                 Sergey Sharybin
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file blender/makesrna/intern/rna_mask.c
25  *  \ingroup RNA
26  */
27
28
29 #include <stdlib.h>
30 #include <limits.h>
31
32 #include "MEM_guardedalloc.h"
33
34 #include "BKE_movieclip.h"
35 #include "BKE_tracking.h"
36
37 #include "RNA_define.h"
38 #include "RNA_enum_types.h"
39
40 #include "rna_internal.h"
41
42 #include "DNA_mask_types.h"
43 #include "DNA_object_types.h"   /* SELECT */
44 #include "DNA_scene_types.h"
45
46 #include "WM_types.h"
47
48 #include "IMB_imbuf_types.h"
49 #include "IMB_imbuf.h"
50
51 #ifdef RNA_RUNTIME
52
53 #include "DNA_mask_types.h"
54 #include "DNA_movieclip_types.h"
55
56 #include "BKE_depsgraph.h"
57 #include "BKE_mask.h"
58 #include "BKE_tracking.h"
59
60 #include "BLI_math.h"
61
62 #include "RNA_access.h"
63
64 #include "WM_api.h"
65
66 static void rna_Mask_update_data(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
67 {
68         Mask *mask = ptr->id.data;
69
70         WM_main_add_notifier(NC_MASK | ND_DATA, mask);
71         DAG_id_tag_update( &mask->id, 0);
72 }
73
74 static void rna_Mask_update_parent(Main *bmain, Scene *scene, PointerRNA *ptr)
75 {
76         MaskParent *parent = ptr->data;
77
78         if (parent->id) {
79                 if (GS(parent->id->name) == ID_MC) {
80                         MovieClip *clip = (MovieClip *) parent->id;
81                         MovieTracking *tracking = &clip->tracking;
82                         MovieTrackingObject *object = BKE_tracking_object_get_named(tracking, parent->parent);
83
84                         if (object) {
85                                 MovieTrackingTrack *track = BKE_tracking_track_get_named(tracking, object, parent->sub_parent);
86
87                                 if (track) {
88                                         int clip_framenr = BKE_movieclip_remap_scene_to_clip_frame(clip, scene->r.cfra);
89                                         MovieTrackingMarker *marker = BKE_tracking_marker_get(track, clip_framenr);
90                                         float marker_pos_ofs[2], parmask_pos[2];
91                                         MovieClipUser user = {0};
92
93                                         BKE_movieclip_user_set_frame(&user, scene->r.cfra);
94
95                                         add_v2_v2v2(marker_pos_ofs, marker->pos, track->offset);
96
97                                         BKE_mask_coord_from_movieclip(clip, &user, parmask_pos, marker_pos_ofs);
98
99                                         copy_v2_v2(parent->parent_orig, parmask_pos);
100                                 }
101                         }
102                 }
103         }
104
105         rna_Mask_update_data(bmain, scene, ptr);
106 }
107
108 /* note: this function exists only to avoid id refcounting */
109 static void rna_MaskParent_id_set(PointerRNA *ptr, PointerRNA value)
110 {
111         MaskParent *mpar = (MaskParent*) ptr->data;
112
113         mpar->id = value.data;
114 }
115
116 static StructRNA *rna_MaskParent_id_typef(PointerRNA *ptr)
117 {
118         MaskParent *mpar = (MaskParent*) ptr->data;
119
120         return ID_code_to_RNA_type(mpar->id_type);
121 }
122
123 static void rna_MaskParent_id_type_set(PointerRNA *ptr, int value)
124 {
125         MaskParent *mpar = (MaskParent*) ptr->data;
126
127         /* change ID-type to the new type */
128         mpar->id_type = value;
129
130         /* clear the id-block if the type is invalid */
131         if ((mpar->id) && (GS(mpar->id->name) != mpar->id_type))
132                 mpar->id = NULL;
133 }
134
135 static void rna_Mask_layers_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
136 {
137         Mask *mask = (Mask *)ptr->id.data;
138
139         rna_iterator_listbase_begin(iter, &mask->masklayers, NULL);
140 }
141
142 static int rna_Mask_layer_active_index_get(PointerRNA *ptr)
143 {
144         Mask *mask = (Mask *)ptr->id.data;
145
146         return mask->masklay_act;
147 }
148
149 static void rna_Mask_layer_active_index_set(PointerRNA *ptr, int value)
150 {
151         Mask *mask = (Mask *)ptr->id.data;
152
153         mask->masklay_act = value;
154 }
155
156 static void rna_Mask_layer_active_index_range(PointerRNA *ptr, int *min, int *max, int *softmin, int *softmax)
157 {
158         Mask *mask = (Mask *)ptr->id.data;
159
160         *min = 0;
161         *max = mask->masklay_tot - 1;
162         *max = MAX2(0, *max);
163
164         *softmin = *min;
165         *softmax = *max;
166 }
167
168 static char *rna_MaskLayer_path(PointerRNA *ptr)
169 {
170         return BLI_sprintfN("layers[\"%s\"]", ((MaskLayer *)ptr->data)->name);
171 }
172
173 static PointerRNA rna_Mask_layer_active_get(PointerRNA *ptr)
174 {
175         Mask *mask = (Mask *)ptr->id.data;
176         MaskLayer *masklay = BKE_mask_layer_active(mask);
177
178         return rna_pointer_inherit_refine(ptr, &RNA_MaskLayer, masklay);
179 }
180
181 static void rna_Mask_layer_active_set(PointerRNA *ptr, PointerRNA value)
182 {
183         Mask *mask = (Mask *)ptr->id.data;
184         MaskLayer *masklay = (MaskLayer *)value.data;
185
186         BKE_mask_layer_active_set(mask, masklay);
187 }
188
189 static void rna_MaskLayer_splines_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
190 {
191         MaskLayer *masklay = (MaskLayer *)ptr->data;
192
193         rna_iterator_listbase_begin(iter, &masklay->splines, NULL);
194 }
195
196 void rna_MaskLayer_name_set(PointerRNA *ptr, const char *value)
197 {
198         Mask *mask = (Mask *)ptr->id.data;
199         MaskLayer *masklay = (MaskLayer *)ptr->data;
200
201         BLI_strncpy(masklay->name, value, sizeof(masklay->name));
202
203         BKE_mask_layer_unique_name(mask, masklay);
204 }
205
206 static PointerRNA rna_MaskLayer_active_spline_get(PointerRNA *ptr)
207 {
208         MaskLayer *masklay = (MaskLayer *)ptr->data;
209
210         return rna_pointer_inherit_refine(ptr, &RNA_MaskSpline, masklay->act_spline);
211 }
212
213 static void rna_MaskLayer_active_spline_set(PointerRNA *ptr, PointerRNA value)
214 {
215         MaskLayer *masklay = (MaskLayer *)ptr->data;
216         MaskSpline *spline = (MaskSpline *)value.data;
217         int index = BLI_findindex(&masklay->splines, spline);
218
219         if (index >= 0)
220                 masklay->act_spline = spline;
221         else
222                 masklay->act_spline = NULL;
223 }
224
225 static PointerRNA rna_MaskLayer_active_spline_point_get(PointerRNA *ptr)
226 {
227         MaskLayer *masklay = (MaskLayer *)ptr->data;
228
229         return rna_pointer_inherit_refine(ptr, &RNA_MaskSplinePoint, masklay->act_point);
230 }
231
232 static void rna_MaskLayer_active_spline_point_set(PointerRNA *ptr, PointerRNA value)
233 {
234         MaskLayer *masklay = (MaskLayer *)ptr->data;
235         MaskSpline *spline;
236         MaskSplinePoint *point = (MaskSplinePoint *)value.data;
237
238         masklay->act_point = NULL;
239
240         for (spline = masklay->splines.first; spline; spline = spline->next) {
241                 if (point >= spline->points && point < spline->points + spline->tot_point) {
242                         masklay->act_point = point;
243
244                         break;
245                 }
246         }
247 }
248
249 static void rna_MaskSplinePoint_handle1_get(PointerRNA *ptr, float *values)
250 {
251         MaskSplinePoint *point = (MaskSplinePoint*) ptr->data;
252         BezTriple *bezt = &point->bezt;
253
254         values[0] = bezt->vec[0][0];
255         values[1] = bezt->vec[0][1];
256         values[2] = bezt->vec[0][2];
257 }
258
259 static void rna_MaskSplinePoint_handle1_set(PointerRNA *ptr, const float *values)
260 {
261         MaskSplinePoint *point = (MaskSplinePoint*) ptr->data;
262         BezTriple *bezt = &point->bezt;
263
264         bezt->vec[0][0] = values[0];
265         bezt->vec[0][1] = values[1];
266         bezt->vec[0][2] = values[2];
267 }
268
269 static void rna_MaskSplinePoint_handle2_get(PointerRNA *ptr, float *values)
270 {
271         MaskSplinePoint *point = (MaskSplinePoint*) ptr->data;
272         BezTriple *bezt = &point->bezt;
273
274         values[0] = bezt->vec[2][0];
275         values[1] = bezt->vec[2][1];
276         values[2] = bezt->vec[2][2];
277 }
278
279 static void rna_MaskSplinePoint_handle2_set(PointerRNA *ptr, const float *values)
280 {
281         MaskSplinePoint *point = (MaskSplinePoint*) ptr->data;
282         BezTriple *bezt = &point->bezt;
283
284         bezt->vec[2][0] = values[0];
285         bezt->vec[2][1] = values[1];
286         bezt->vec[2][2] = values[2];
287 }
288
289 static void rna_MaskSplinePoint_ctrlpoint_get(PointerRNA *ptr, float *values)
290 {
291         MaskSplinePoint *point = (MaskSplinePoint*) ptr->data;
292         BezTriple *bezt = &point->bezt;
293
294         values[0] = bezt->vec[1][0];
295         values[1] = bezt->vec[1][1];
296         values[2] = bezt->vec[1][2];
297 }
298
299 static void rna_MaskSplinePoint_ctrlpoint_set(PointerRNA *ptr, const float *values)
300 {
301         MaskSplinePoint *point = (MaskSplinePoint*) ptr->data;
302         BezTriple *bezt = &point->bezt;
303
304         bezt->vec[1][0] = values[0];
305         bezt->vec[1][1] = values[1];
306         bezt->vec[1][2] = values[2];
307 }
308
309 static int rna_MaskSplinePoint_handle_type_get(PointerRNA *ptr)
310 {
311         MaskSplinePoint *point = (MaskSplinePoint*) ptr->data;
312         BezTriple *bezt = &point->bezt;
313
314         return bezt->h1;
315 }
316
317 static void rna_MaskSplinePoint_handle_type_set(PointerRNA *ptr, int value)
318 {
319         MaskSplinePoint *point = (MaskSplinePoint*) ptr->data;
320         BezTriple *bezt = &point->bezt;
321
322         bezt->h1 = bezt->h2 = value;
323 }
324
325 /* ** API **  */
326
327 static MaskLayer *rna_Mask_layer_new(Mask *mask, const char *name)
328 {
329         MaskLayer *masklay = BKE_mask_layer_new(mask, name);
330
331         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
332
333         return masklay;
334 }
335
336 void rna_Mask_layer_remove(Mask *mask, MaskLayer *masklay)
337 {
338         BKE_mask_layer_remove(mask, masklay);
339
340         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
341 }
342
343 static void rna_MaskLayer_spline_add(ID *id, MaskLayer *masklay, int number)
344 {
345         Mask *mask = (Mask*) id;
346         int i;
347
348         for (i = 0; i < number; i++)
349                 BKE_mask_spline_add(masklay);
350
351         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
352 }
353
354 static void rna_Mask_start_frame_set(PointerRNA *ptr, int value)
355 {
356         Mask *data = (Mask *)ptr->data;
357         /* MINFRAME not MINAFRAME, since some output formats can't taken negative frames */
358         CLAMP(value, MINFRAME, MAXFRAME);
359         data->sfra = value;
360
361         if (data->sfra >= data->efra) {
362                 data->efra = MIN2(data->sfra, MAXFRAME);
363         }
364 }
365
366 static void rna_Mask_end_frame_set(PointerRNA *ptr, int value)
367 {
368         Mask *data = (Mask *)ptr->data;
369         CLAMP(value, MINFRAME, MAXFRAME);
370         data->efra = value;
371
372         if (data->sfra >= data->efra) {
373                 data->sfra = MAX2(data->efra, MINFRAME);
374         }
375 }
376
377 #else
378
379 static void rna_def_maskParent(BlenderRNA *brna)
380 {
381         StructRNA *srna;
382         PropertyRNA *prop;
383
384         static EnumPropertyItem mask_id_type_items[] = {
385                 {ID_MC, "MOVIECLIP", ICON_SEQUENCE, "Movie Clip", ""},
386                 {0, NULL, 0, NULL, NULL}};
387
388         srna = RNA_def_struct(brna, "MaskParent", NULL);
389         RNA_def_struct_ui_text(srna, "Mask Parent", "Parenting settings for masking element");
390
391         /* Target Properties - ID-block to Drive */
392         prop = RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
393         RNA_def_property_struct_type(prop, "ID");
394         RNA_def_property_flag(prop, PROP_EDITABLE);
395         // RNA_def_property_editable_func(prop, "rna_maskSpline_id_editable");
396         /* note: custom set function is ONLY to avoid rna setting a user for this. */
397         RNA_def_property_pointer_funcs(prop, NULL, "rna_MaskParent_id_set", "rna_MaskParent_id_typef", NULL);
398         RNA_def_property_ui_text(prop, "ID", "ID-block to which masking element would be parented to or to it's property");
399         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
400
401         prop = RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
402         RNA_def_property_enum_sdna(prop, NULL, "id_type");
403         RNA_def_property_enum_items(prop, mask_id_type_items);
404         RNA_def_property_enum_default(prop, ID_MC);
405         RNA_def_property_enum_funcs(prop, NULL, "rna_MaskParent_id_type_set", NULL);
406         //RNA_def_property_editable_func(prop, "rna_MaskParent_id_type_editable");
407         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used");
408         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
409
410         /* parent */
411         prop = RNA_def_property(srna, "parent", PROP_STRING, PROP_NONE);
412         RNA_def_property_ui_text(prop, "Parent", "Name of parent object in specified data block to which parenting happens");
413         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
414         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
415
416         /* sub_parent */
417         prop = RNA_def_property(srna, "sub_parent", PROP_STRING, PROP_NONE);
418         RNA_def_property_ui_text(prop, "Sub Parent", "Name of parent sub-object in specified data block to which parenting happens");
419         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
420         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
421 }
422
423 static void rna_def_maskSplinePointUW(BlenderRNA *brna)
424 {
425         StructRNA *srna;
426         PropertyRNA *prop;
427
428         srna = RNA_def_struct(brna, "MaskSplinePointUW", NULL);
429         RNA_def_struct_ui_text(srna, "Mask Spline UW Point", "Single point in spline segment defining feather");
430
431         /* u */
432         prop = RNA_def_property(srna, "u", PROP_FLOAT, PROP_NONE);
433         RNA_def_property_float_sdna(prop, NULL, "u");
434         RNA_def_property_range(prop, 0.0, 1.0);
435         RNA_def_property_ui_text(prop, "U", "U coordinate of point along spline segment");
436         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
437
438         /* weight */
439         prop = RNA_def_property(srna, "weight", PROP_FLOAT, PROP_NONE);
440         RNA_def_property_float_sdna(prop, NULL, "w");
441         RNA_def_property_range(prop, 0.0, 1.0);
442         RNA_def_property_ui_text(prop, "Weight", "Weight of feather point");
443         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
444
445         /* select */
446         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
447         RNA_def_property_boolean_sdna(prop, NULL, "flag", SELECT);
448         RNA_def_property_ui_text(prop, "Select", "Selection status");
449         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
450 }
451
452 static void rna_def_maskSplinePoint(BlenderRNA *brna)
453 {
454         StructRNA *srna;
455         PropertyRNA *prop;
456
457         static EnumPropertyItem handle_type_items[] = {
458                 {HD_AUTO, "AUTO", 0, "Auto", ""},
459                 {HD_VECT, "VECTOR", 0, "Vector", ""},
460                 {HD_ALIGN, "ALIGNED", 0, "Aligned", ""},
461                 {0, NULL, 0, NULL, NULL}};
462
463         rna_def_maskSplinePointUW(brna);
464
465         srna = RNA_def_struct(brna, "MaskSplinePoint", NULL);
466         RNA_def_struct_ui_text(srna, "Mask Spline Point", "Single point in spline used for defining mask");
467
468         /* Vector values */
469         prop = RNA_def_property(srna, "handle_left", PROP_FLOAT, PROP_TRANSLATION);
470         RNA_def_property_array(prop, 3);
471         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_handle1_get", "rna_MaskSplinePoint_handle1_set", NULL);
472         RNA_def_property_ui_text(prop, "Handle 1", "Coordinates of the first handle");
473         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
474
475         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
476         RNA_def_property_array(prop, 3);
477         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_ctrlpoint_get", "rna_MaskSplinePoint_ctrlpoint_set", NULL);
478         RNA_def_property_ui_text(prop, "Control Point", "Coordinates of the control point");
479         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
480
481         prop = RNA_def_property(srna, "handle_right", PROP_FLOAT, PROP_TRANSLATION);
482         RNA_def_property_array(prop, 3);
483         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_handle2_get", "rna_MaskSplinePoint_handle2_set", NULL);
484         RNA_def_property_ui_text(prop, "Handle 2", "Coordinates of the second handle");
485         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
486
487         /* handle_type */
488         prop = RNA_def_property(srna, "handle_type", PROP_ENUM, PROP_NONE);
489         RNA_def_property_enum_funcs(prop, "rna_MaskSplinePoint_handle_type_get", "rna_MaskSplinePoint_handle_type_set", NULL);
490         RNA_def_property_enum_items(prop, handle_type_items);
491         RNA_def_property_ui_text(prop, "Handle Type", "Handle type");
492         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
493
494         /* select */
495         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
496         RNA_def_property_boolean_sdna(prop, NULL, "bezt.f1", SELECT);
497         RNA_def_property_ui_text(prop, "Select", "Selection status");
498         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
499
500         /* parent */
501         prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
502         RNA_def_property_struct_type(prop, "MaskParent");
503
504         /* feather points */
505         prop = RNA_def_property(srna, "feather_points", PROP_COLLECTION, PROP_NONE);
506         RNA_def_property_struct_type(prop, "MaskSplinePointUW");
507         RNA_def_property_collection_sdna(prop, NULL, "uw", "tot_uw");
508         RNA_def_property_ui_text(prop, "Feather Points", "Points defining feather");
509 }
510
511 static void rna_def_mask_splines(BlenderRNA *brna)
512 {
513         StructRNA *srna;
514         FunctionRNA *func;
515         PropertyRNA *prop;
516
517         srna = RNA_def_struct(brna, "MaskSplines", NULL);
518         RNA_def_struct_sdna(srna, "MaskLayer");
519         RNA_def_struct_ui_text(srna, "Mask Splines", "Collection of masking splines");
520
521         func = RNA_def_function(srna, "add", "rna_MaskLayer_spline_add");
522         RNA_def_function_flag(func, FUNC_USE_SELF_ID);
523         RNA_def_function_ui_description(func, "Add a number of splines to mask layer");
524         RNA_def_int(func, "count", 1, 0, INT_MAX, "Number", "Number of splines to add to the layer", 0, INT_MAX);
525
526         /* active spline */
527         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
528         RNA_def_property_struct_type(prop, "MaskSpline");
529         RNA_def_property_pointer_funcs(prop, "rna_MaskLayer_active_spline_get", "rna_MaskLayer_active_spline_set", NULL, NULL);
530         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
531         RNA_def_property_ui_text(prop, "Active Spline", "Active spline of masking layer");
532
533         /* active point */
534         prop = RNA_def_property(srna, "active_point", PROP_POINTER, PROP_NONE);
535         RNA_def_property_struct_type(prop, "MaskSplinePoint");
536         RNA_def_property_pointer_funcs(prop, "rna_MaskLayer_active_spline_point_get", "rna_MaskLayer_active_spline_point_set", NULL, NULL);
537         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
538         RNA_def_property_ui_text(prop, "Active Spline", "Active spline of masking layer");
539 }
540
541 static void rna_def_maskSpline(BlenderRNA *brna)
542 {
543         static EnumPropertyItem spline_interpolation_items[] = {
544                 {MASK_SPLINE_INTERP_LINEAR, "LINEAR", 0, "Linear", ""},
545                 {MASK_SPLINE_INTERP_EASE, "EASE", 0, "Ease", ""},
546                 {0, NULL, 0, NULL, NULL}
547         };
548
549         StructRNA *srna;
550         PropertyRNA *prop;
551
552         rna_def_maskSplinePoint(brna);
553
554         srna = RNA_def_struct(brna, "MaskSpline", NULL);
555         RNA_def_struct_ui_text(srna, "Mask spline", "Single spline used for defining mask shape");
556
557         /* weight interpolation */
558         prop = RNA_def_property(srna, "weight_interpolation", PROP_ENUM, PROP_NONE);
559         RNA_def_property_enum_sdna(prop, NULL, "weight_interp");
560         RNA_def_property_enum_items(prop, spline_interpolation_items);
561         RNA_def_property_ui_text(prop, "Weight Interpolation", "The type of weight interpolation for spline");
562         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
563
564         /* cyclic */
565         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
566         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
567         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_SPLINE_CYCLIC);
568         RNA_def_property_ui_text(prop, "Cyclic", "Make this spline a closed loop");
569         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
570
571         /* fill */
572         prop = RNA_def_property(srna, "use_fill", PROP_BOOLEAN, PROP_NONE);
573         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
574         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", MASK_SPLINE_NOFILL);
575         RNA_def_property_ui_text(prop, "Fill", "Make this spline filled");
576         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
577 }
578
579 static void rna_def_mask_layer(BlenderRNA *brna)
580 {
581         static EnumPropertyItem masklay_blend_mode_items[] = {
582                 {MASK_BLEND_ADD, "ADD", 0, "Add", ""},
583                 {MASK_BLEND_SUBTRACT, "SUBTRACT", 0, "Subtract", ""},
584                 {0, NULL, 0, NULL, NULL}
585         };
586
587         StructRNA *srna;
588         PropertyRNA *prop;
589
590         rna_def_maskSpline(brna);
591         rna_def_mask_splines(brna);
592
593         srna = RNA_def_struct(brna, "MaskLayer", NULL);
594         RNA_def_struct_ui_text(srna, "Mask Layer", "Single layer used for masking pixels");
595         RNA_def_struct_path_func(srna, "rna_MaskLayer_path");
596
597         /* name */
598         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
599         RNA_def_property_ui_text(prop, "Name", "Unique name of layer");
600         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_MaskLayer_name_set");
601         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
602         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
603         RNA_def_struct_name_property(srna, prop);
604
605         /* splines */
606         prop = RNA_def_property(srna, "splines", PROP_COLLECTION, PROP_NONE);
607         RNA_def_property_collection_funcs(prop, "rna_MaskLayer_splines_begin", "rna_iterator_listbase_next", "rna_iterator_listbase_end", "rna_iterator_listbase_get", 0, 0, 0, 0);
608         RNA_def_property_struct_type(prop, "MaskSpline");
609         RNA_def_property_ui_text(prop, "Splines", "Collection of splines which defines this layer");
610         RNA_def_property_srna(prop, "MaskSplines");
611
612         /* restrict */
613         prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
614         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_VIEW);
615         RNA_def_property_ui_text(prop, "Restrict View", "Restrict visibility in the viewport");
616         RNA_def_property_ui_icon(prop, ICON_RESTRICT_VIEW_OFF, 1);
617         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
618
619         prop = RNA_def_property(srna, "hide_select", PROP_BOOLEAN, PROP_NONE);
620         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_SELECT);
621         RNA_def_property_ui_text(prop, "Restrict Select", "Restrict selection in the viewport");
622         RNA_def_property_ui_icon(prop, ICON_RESTRICT_SELECT_OFF, 1);
623         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
624
625         prop = RNA_def_property(srna, "hide_render", PROP_BOOLEAN, PROP_NONE);
626         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_RENDER);
627         RNA_def_property_ui_text(prop, "Restrict Render", "Restrict renderability");
628         RNA_def_property_ui_icon(prop, ICON_RESTRICT_RENDER_OFF, 1);
629         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
630
631         /* select (for dopesheet)*/
632         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
633         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_LAYERFLAG_SELECT);
634         RNA_def_property_ui_text(prop, "Select", "Layer is selected for editing in the DopeSheet");
635 //      RNA_def_property_update(prop, NC_SCREEN | ND_MASK, NULL);
636
637         /* render settings */
638         prop = RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
639         RNA_def_property_float_sdna(prop, NULL, "alpha");
640         RNA_def_property_range(prop, 0.0, 1.0f);
641         RNA_def_property_ui_text(prop, "Opacity", "Render Opacity");
642         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
643
644         /* weight interpolation */
645         prop = RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
646         RNA_def_property_enum_sdna(prop, NULL, "blend");
647         RNA_def_property_enum_items(prop, masklay_blend_mode_items);
648         RNA_def_property_ui_text(prop, "Blend", "Method of blending mask layers");
649         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
650         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
651
652         prop = RNA_def_property(srna, "invert", PROP_BOOLEAN, PROP_NONE);
653         RNA_def_property_boolean_sdna(prop, NULL, "blend_flag", MASK_BLENDFLAG_INVERT);
654         RNA_def_property_ui_text(prop, "Restrict View", "Invert the mask black/white");
655         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
656
657         prop = RNA_def_property(srna, "falloff", PROP_ENUM, PROP_NONE);
658         RNA_def_property_enum_sdna(prop, NULL, "falloff");
659         RNA_def_property_enum_items(prop, proportional_falloff_curve_only_items);
660         RNA_def_property_ui_text(prop, "Falloff", "Falloff type the feather");
661         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
662
663 }
664
665 static void rna_def_masklayers(BlenderRNA *brna, PropertyRNA *cprop)
666 {
667         StructRNA *srna;
668         PropertyRNA *prop;
669
670         FunctionRNA *func;
671         PropertyRNA *parm;
672
673         RNA_def_property_srna(cprop, "MaskLayers");
674         srna = RNA_def_struct(brna, "MaskLayers", NULL);
675         RNA_def_struct_sdna(srna, "Mask");
676         RNA_def_struct_ui_text(srna, "Mask Layers", "Collection of layers used by mask");
677
678         func = RNA_def_function(srna, "new", "rna_Mask_layer_new");
679         RNA_def_function_ui_description(func, "Add layer to this mask");
680         RNA_def_string(func, "name", "", 0, "Name", "Name of new layer");
681         parm = RNA_def_pointer(func, "layer", "MaskLayer", "", "New mask layer");
682         RNA_def_function_return(func, parm);
683
684         func = RNA_def_function(srna, "remove", "rna_Mask_layer_remove");
685         RNA_def_function_ui_description(func, "Remove layer from this mask");
686         RNA_def_pointer(func, "layer", "MaskLayer", "", "Shape to be removed");
687
688         /* active layer */
689         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
690         RNA_def_property_struct_type(prop, "MaskLayer");
691         RNA_def_property_pointer_funcs(prop, "rna_Mask_layer_active_get", "rna_Mask_layer_active_set", NULL, NULL);
692         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
693         RNA_def_property_ui_text(prop, "Active Shape", "Active layer in this mask");
694 }
695
696 static void rna_def_mask(BlenderRNA *brna)
697 {
698         StructRNA *srna;
699         PropertyRNA *prop;
700
701         rna_def_mask_layer(brna);
702
703         srna = RNA_def_struct(brna, "Mask", "ID");
704         RNA_def_struct_ui_text(srna, "Mask", "Mask datablock defining mask for compositing");
705         RNA_def_struct_ui_icon(srna, ICON_MOD_MASK);
706
707         /* mask layers */
708         prop = RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
709         RNA_def_property_collection_funcs(prop, "rna_Mask_layers_begin", "rna_iterator_listbase_next", "rna_iterator_listbase_end", "rna_iterator_listbase_get", 0, 0, 0, 0);
710         RNA_def_property_struct_type(prop, "MaskLayer");
711         RNA_def_property_ui_text(prop, "Layers", "Collection of layers which defines this mask");
712         rna_def_masklayers(brna, prop);
713
714         /* active masklay index */
715         prop = RNA_def_property(srna, "active_layer_index", PROP_INT, PROP_NONE);
716         RNA_def_property_int_sdna(prop, NULL, "masklay_act");
717         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
718         RNA_def_property_int_funcs(prop, "rna_Mask_layer_active_index_get", "rna_Mask_layer_active_index_set", "rna_Mask_layer_active_index_range");
719         RNA_def_property_ui_text(prop, "Active Shape Index", "Index of active layer in list of all mask's layers");
720         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
721
722         /* frame range */
723         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
724         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
725         RNA_def_property_int_sdna(prop, NULL, "sfra");
726         RNA_def_property_int_funcs(prop, NULL, "rna_Mask_start_frame_set", NULL);
727         RNA_def_property_range(prop, MINFRAME, MAXFRAME);
728         RNA_def_property_ui_text(prop, "Start Frame", "First frame of the mask (used for sequencer)");
729         RNA_def_property_update(prop, NC_SCENE | ND_FRAME_RANGE, NULL);
730
731         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_TIME);
732         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
733         RNA_def_property_int_sdna(prop, NULL, "efra");
734         RNA_def_property_int_funcs(prop, NULL, "rna_Mask_end_frame_set", NULL);
735         RNA_def_property_range(prop, MINFRAME, MAXFRAME);
736         RNA_def_property_ui_text(prop, "End Frame", "Final frame of the mask (used for sequencer)");
737         RNA_def_property_update(prop, NC_SCENE | ND_FRAME_RANGE, NULL);
738
739         /* pointers */
740         rna_def_animdata_common(srna);
741 }
742
743 void RNA_def_mask(BlenderRNA *brna)
744 {
745         rna_def_maskParent(brna);
746         rna_def_mask(brna);
747 }
748
749 #endif