Big i18n commit: add "reports" from bmesh/readfile/tracking/dynapaint (and a few...
[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 static 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         copy_v2_v2(values, bezt->vec[0]);
254 }
255
256 static void rna_MaskSplinePoint_handle1_set(PointerRNA *ptr, const float *values)
257 {
258         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
259         BezTriple *bezt = &point->bezt;
260         copy_v2_v2(bezt->vec[0], values);
261 }
262
263 static void rna_MaskSplinePoint_handle2_get(PointerRNA *ptr, float *values)
264 {
265         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
266         BezTriple *bezt = &point->bezt;
267         copy_v2_v2(values, bezt->vec[2]);
268 }
269
270 static void rna_MaskSplinePoint_handle2_set(PointerRNA *ptr, const float *values)
271 {
272         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
273         BezTriple *bezt = &point->bezt;
274         copy_v2_v2(bezt->vec[2], values);
275 }
276
277 static void rna_MaskSplinePoint_ctrlpoint_get(PointerRNA *ptr, float *values)
278 {
279         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
280         BezTriple *bezt = &point->bezt;
281         copy_v2_v2(values, bezt->vec[1]);
282 }
283
284 static void rna_MaskSplinePoint_ctrlpoint_set(PointerRNA *ptr, const float *values)
285 {
286         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
287         BezTriple *bezt = &point->bezt;
288         copy_v2_v2(bezt->vec[1], values);
289 }
290
291 static int rna_MaskSplinePoint_handle_type_get(PointerRNA *ptr)
292 {
293         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
294         BezTriple *bezt = &point->bezt;
295
296         return bezt->h1;
297 }
298
299 static void rna_MaskSplinePoint_handle_type_set(PointerRNA *ptr, int value)
300 {
301         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
302         BezTriple *bezt = &point->bezt;
303
304         bezt->h1 = bezt->h2 = value;
305 }
306
307 /* ** API **  */
308
309 static MaskLayer *rna_Mask_layers_new(Mask *mask, const char *name)
310 {
311         MaskLayer *masklay = BKE_mask_layer_new(mask, name);
312
313         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
314
315         return masklay;
316 }
317
318 static void rna_Mask_layers_remove(Mask *mask, ReportList *reports, MaskLayer *masklay)
319 {
320         if (BLI_findindex(&mask->masklayers, masklay) == -1) {
321                 BKE_reportf(reports, RPT_ERROR, "Mask layer '%s' not found in mask '%s'", masklay->name, mask->id.name + 2);
322                 return;
323         }
324
325         BKE_mask_layer_remove(mask, masklay);
326
327         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
328 }
329
330 static void rna_Mask_layers_clear(Mask *mask)
331 {
332         BKE_mask_layer_free_list(&mask->masklayers);
333
334         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
335 }
336
337 static void rna_MaskLayer_spline_add(ID *id, MaskLayer *masklay, int number)
338 {
339         Mask *mask = (Mask *) id;
340         int i;
341
342         for (i = 0; i < number; i++)
343                 BKE_mask_spline_add(masklay);
344
345         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
346 }
347
348 static void rna_Mask_start_frame_set(PointerRNA *ptr, int value)
349 {
350         Mask *data = (Mask *)ptr->data;
351         /* MINFRAME not MINAFRAME, since some output formats can't taken negative frames */
352         CLAMP(value, MINFRAME, MAXFRAME);
353         data->sfra = value;
354
355         if (data->sfra >= data->efra) {
356                 data->efra = MIN2(data->sfra, MAXFRAME);
357         }
358 }
359
360 static void rna_Mask_end_frame_set(PointerRNA *ptr, int value)
361 {
362         Mask *data = (Mask *)ptr->data;
363         CLAMP(value, MINFRAME, MAXFRAME);
364         data->efra = value;
365
366         if (data->sfra >= data->efra) {
367                 data->sfra = MAX2(data->efra, MINFRAME);
368         }
369 }
370
371 #else
372
373 static void rna_def_maskParent(BlenderRNA *brna)
374 {
375         StructRNA *srna;
376         PropertyRNA *prop;
377
378         static EnumPropertyItem mask_id_type_items[] = {
379                 {ID_MC, "MOVIECLIP", ICON_SEQUENCE, "Movie Clip", ""},
380                 {0, NULL, 0, NULL, NULL}};
381
382         srna = RNA_def_struct(brna, "MaskParent", NULL);
383         RNA_def_struct_ui_text(srna, "Mask Parent", "Parenting settings for masking element");
384
385         /* Target Properties - ID-block to Drive */
386         prop = RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
387         RNA_def_property_struct_type(prop, "ID");
388         RNA_def_property_flag(prop, PROP_EDITABLE);
389         // RNA_def_property_editable_func(prop, "rna_maskSpline_id_editable");
390         /* note: custom set function is ONLY to avoid rna setting a user for this. */
391         RNA_def_property_pointer_funcs(prop, NULL, "rna_MaskParent_id_set", "rna_MaskParent_id_typef", NULL);
392         RNA_def_property_ui_text(prop, "ID", "ID-block to which masking element would be parented to or to it's property");
393         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
394
395         prop = RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
396         RNA_def_property_enum_sdna(prop, NULL, "id_type");
397         RNA_def_property_enum_items(prop, mask_id_type_items);
398         RNA_def_property_enum_default(prop, ID_MC);
399         RNA_def_property_enum_funcs(prop, NULL, "rna_MaskParent_id_type_set", NULL);
400         //RNA_def_property_editable_func(prop, "rna_MaskParent_id_type_editable");
401         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used");
402         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
403
404         /* parent */
405         prop = RNA_def_property(srna, "parent", PROP_STRING, PROP_NONE);
406         RNA_def_property_ui_text(prop, "Parent", "Name of parent object in specified data block to which parenting happens");
407         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
408         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
409
410         /* sub_parent */
411         prop = RNA_def_property(srna, "sub_parent", PROP_STRING, PROP_NONE);
412         RNA_def_property_ui_text(prop, "Sub Parent", "Name of parent sub-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
417 static void rna_def_maskSplinePointUW(BlenderRNA *brna)
418 {
419         StructRNA *srna;
420         PropertyRNA *prop;
421
422         srna = RNA_def_struct(brna, "MaskSplinePointUW", NULL);
423         RNA_def_struct_ui_text(srna, "Mask Spline UW Point", "Single point in spline segment defining feather");
424
425         /* u */
426         prop = RNA_def_property(srna, "u", PROP_FLOAT, PROP_NONE);
427         RNA_def_property_float_sdna(prop, NULL, "u");
428         RNA_def_property_range(prop, 0.0, 1.0);
429         RNA_def_property_ui_text(prop, "U", "U coordinate of point along spline segment");
430         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
431
432         /* weight */
433         prop = RNA_def_property(srna, "weight", PROP_FLOAT, PROP_NONE);
434         RNA_def_property_float_sdna(prop, NULL, "w");
435         RNA_def_property_range(prop, 0.0, 1.0);
436         RNA_def_property_ui_text(prop, "Weight", "Weight of feather point");
437         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
438
439         /* select */
440         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
441         RNA_def_property_boolean_sdna(prop, NULL, "flag", SELECT);
442         RNA_def_property_ui_text(prop, "Select", "Selection status");
443         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
444 }
445
446 static void rna_def_maskSplinePoint(BlenderRNA *brna)
447 {
448         StructRNA *srna;
449         PropertyRNA *prop;
450
451         static EnumPropertyItem handle_type_items[] = {
452                 {HD_AUTO, "AUTO", 0, "Auto", ""},
453                 {HD_VECT, "VECTOR", 0, "Vector", ""},
454                 {HD_ALIGN, "ALIGNED", 0, "Aligned", ""},
455                 {0, NULL, 0, NULL, NULL}};
456
457         rna_def_maskSplinePointUW(brna);
458
459         srna = RNA_def_struct(brna, "MaskSplinePoint", NULL);
460         RNA_def_struct_ui_text(srna, "Mask Spline Point", "Single point in spline used for defining mask");
461
462         /* Vector values */
463         prop = RNA_def_property(srna, "handle_left", PROP_FLOAT, PROP_TRANSLATION);
464         RNA_def_property_array(prop, 2);
465         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_handle1_get", "rna_MaskSplinePoint_handle1_set", NULL);
466         RNA_def_property_ui_text(prop, "Handle 1", "Coordinates of the first handle");
467         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
468
469         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
470         RNA_def_property_array(prop, 2);
471         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_ctrlpoint_get", "rna_MaskSplinePoint_ctrlpoint_set", NULL);
472         RNA_def_property_ui_text(prop, "Control Point", "Coordinates of the control point");
473         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
474
475         prop = RNA_def_property(srna, "handle_right", PROP_FLOAT, PROP_TRANSLATION);
476         RNA_def_property_array(prop, 2);
477         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_handle2_get", "rna_MaskSplinePoint_handle2_set", NULL);
478         RNA_def_property_ui_text(prop, "Handle 2", "Coordinates of the second handle");
479         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
480
481         /* handle_type */
482         prop = RNA_def_property(srna, "handle_type", PROP_ENUM, PROP_NONE);
483         RNA_def_property_enum_funcs(prop, "rna_MaskSplinePoint_handle_type_get", "rna_MaskSplinePoint_handle_type_set", NULL);
484         RNA_def_property_enum_items(prop, handle_type_items);
485         RNA_def_property_ui_text(prop, "Handle Type", "Handle type");
486         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
487
488         /* select */
489         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
490         RNA_def_property_boolean_sdna(prop, NULL, "bezt.f1", SELECT);
491         RNA_def_property_ui_text(prop, "Select", "Selection status");
492         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
493
494         /* parent */
495         prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
496         RNA_def_property_struct_type(prop, "MaskParent");
497
498         /* feather points */
499         prop = RNA_def_property(srna, "feather_points", PROP_COLLECTION, PROP_NONE);
500         RNA_def_property_struct_type(prop, "MaskSplinePointUW");
501         RNA_def_property_collection_sdna(prop, NULL, "uw", "tot_uw");
502         RNA_def_property_ui_text(prop, "Feather Points", "Points defining feather");
503 }
504
505 static void rna_def_mask_splines(BlenderRNA *brna)
506 {
507         StructRNA *srna;
508         FunctionRNA *func;
509         PropertyRNA *prop;
510
511         srna = RNA_def_struct(brna, "MaskSplines", NULL);
512         RNA_def_struct_sdna(srna, "MaskLayer");
513         RNA_def_struct_ui_text(srna, "Mask Splines", "Collection of masking splines");
514
515         func = RNA_def_function(srna, "add", "rna_MaskLayer_spline_add");
516         RNA_def_function_flag(func, FUNC_USE_SELF_ID);
517         RNA_def_function_ui_description(func, "Add a number of splines to mask layer");
518         RNA_def_int(func, "count", 1, 0, INT_MAX, "Number", "Number of splines to add to the layer", 0, INT_MAX);
519
520         /* active spline */
521         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
522         RNA_def_property_struct_type(prop, "MaskSpline");
523         RNA_def_property_pointer_funcs(prop, "rna_MaskLayer_active_spline_get", "rna_MaskLayer_active_spline_set", NULL, NULL);
524         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
525         RNA_def_property_ui_text(prop, "Active Spline", "Active spline of masking layer");
526
527         /* active point */
528         prop = RNA_def_property(srna, "active_point", PROP_POINTER, PROP_NONE);
529         RNA_def_property_struct_type(prop, "MaskSplinePoint");
530         RNA_def_property_pointer_funcs(prop, "rna_MaskLayer_active_spline_point_get", "rna_MaskLayer_active_spline_point_set", NULL, NULL);
531         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
532         RNA_def_property_ui_text(prop, "Active Spline", "Active spline of masking layer");
533 }
534
535 static void rna_def_maskSpline(BlenderRNA *brna)
536 {
537         static EnumPropertyItem spline_interpolation_items[] = {
538                 {MASK_SPLINE_INTERP_LINEAR, "LINEAR", 0, "Linear", ""},
539                 {MASK_SPLINE_INTERP_EASE, "EASE", 0, "Ease", ""},
540                 {0, NULL, 0, NULL, NULL}
541         };
542
543         static EnumPropertyItem spline_offset_mode_items[] = {
544                 {MASK_SPLINE_OFFSET_EVEN, "EVEN", 0, "Even", "Calculate even feather offset"},
545                 {MASK_SPLINE_OFFSET_SMOOTH, "SMOOTH", 0, "Smooth", "Calculate feather offset as a second curve"},
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         /* offset mode */
558         prop = RNA_def_property(srna, "offset_mode", PROP_ENUM, PROP_NONE);
559         RNA_def_property_enum_sdna(prop, NULL, "offset_mode");
560         RNA_def_property_enum_items(prop, spline_offset_mode_items);
561         RNA_def_property_ui_text(prop, "Feather Offset", "The method used for calculating the feather offset");
562         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
563
564         /* weight interpolation */
565         prop = RNA_def_property(srna, "weight_interpolation", PROP_ENUM, PROP_NONE);
566         RNA_def_property_enum_sdna(prop, NULL, "weight_interp");
567         RNA_def_property_enum_items(prop, spline_interpolation_items);
568         RNA_def_property_ui_text(prop, "Weight Interpolation", "The type of weight interpolation for spline");
569         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
570
571         /* cyclic */
572         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
573         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
574         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_SPLINE_CYCLIC);
575         RNA_def_property_ui_text(prop, "Cyclic", "Make this spline a closed loop");
576         RNA_def_property_update(prop, NC_MASK | NA_EDITED, "rna_Mask_update_data");
577
578         /* fill */
579         prop = RNA_def_property(srna, "use_fill", PROP_BOOLEAN, PROP_NONE);
580         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
581         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", MASK_SPLINE_NOFILL);
582         RNA_def_property_ui_text(prop, "Fill", "Make this spline filled");
583         RNA_def_property_update(prop, NC_MASK | NA_EDITED, "rna_Mask_update_data");
584
585         /* self-intersection check */
586         prop = RNA_def_property(srna, "use_self_intersection_check", PROP_BOOLEAN, PROP_NONE);
587         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
588         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_SPLINE_NOINTERSECT);
589         RNA_def_property_ui_text(prop, "Self Intersection Check", "Prevent feather from self-intersections");
590         RNA_def_property_update(prop, NC_MASK | NA_EDITED, "rna_Mask_update_data");
591 }
592
593 static void rna_def_mask_layer(BlenderRNA *brna)
594 {
595         static EnumPropertyItem masklay_blend_mode_items[] = {
596                 {MASK_BLEND_MERGE_ADD, "MERGE_ADD", 0, "Merge Add", ""},
597                 {MASK_BLEND_MERGE_SUBTRACT, "MERGE_SUBTRACT", 0, "Merge Subtract", ""},
598                 {MASK_BLEND_ADD, "ADD", 0, "Add", ""},
599                 {MASK_BLEND_SUBTRACT, "SUBTRACT", 0, "Subtract", ""},
600                 {MASK_BLEND_LIGHTEN, "LIGHTEN", 0, "Lighten", ""},
601                 {MASK_BLEND_DARKEN, "DARKEN", 0, "Darken", ""},
602                 {MASK_BLEND_MUL, "MUL", 0, "Multiply", ""},
603                 {MASK_BLEND_REPLACE, "REPLACE", 0, "Replace", ""},
604                 {MASK_BLEND_DIFFERENCE, "DIFFERENCE", 0, "Difference", ""},
605                 {0, NULL, 0, NULL, NULL}
606         };
607
608         StructRNA *srna;
609         PropertyRNA *prop;
610
611         rna_def_maskSpline(brna);
612         rna_def_mask_splines(brna);
613
614         srna = RNA_def_struct(brna, "MaskLayer", NULL);
615         RNA_def_struct_ui_text(srna, "Mask Layer", "Single layer used for masking pixels");
616         RNA_def_struct_path_func(srna, "rna_MaskLayer_path");
617
618         /* name */
619         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
620         RNA_def_property_ui_text(prop, "Name", "Unique name of layer");
621         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_MaskLayer_name_set");
622         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
623         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
624         RNA_def_struct_name_property(srna, prop);
625
626         /* splines */
627         prop = RNA_def_property(srna, "splines", PROP_COLLECTION, PROP_NONE);
628         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);
629         RNA_def_property_struct_type(prop, "MaskSpline");
630         RNA_def_property_ui_text(prop, "Splines", "Collection of splines which defines this layer");
631         RNA_def_property_srna(prop, "MaskSplines");
632
633         /* restrict */
634         prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
635         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_VIEW);
636         RNA_def_property_ui_text(prop, "Restrict View", "Restrict visibility in the viewport");
637         RNA_def_property_ui_icon(prop, ICON_RESTRICT_VIEW_OFF, 1);
638         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
639
640         prop = RNA_def_property(srna, "hide_select", PROP_BOOLEAN, PROP_NONE);
641         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_SELECT);
642         RNA_def_property_ui_text(prop, "Restrict Select", "Restrict selection in the viewport");
643         RNA_def_property_ui_icon(prop, ICON_RESTRICT_SELECT_OFF, 1);
644         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
645
646         prop = RNA_def_property(srna, "hide_render", PROP_BOOLEAN, PROP_NONE);
647         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_RENDER);
648         RNA_def_property_ui_text(prop, "Restrict Render", "Restrict renderability");
649         RNA_def_property_ui_icon(prop, ICON_RESTRICT_RENDER_OFF, 1);
650         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
651
652         /* select (for dopesheet)*/
653         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
654         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_LAYERFLAG_SELECT);
655         RNA_def_property_ui_text(prop, "Select", "Layer is selected for editing in the DopeSheet");
656 //      RNA_def_property_update(prop, NC_SCREEN | ND_MASK, NULL);
657
658         /* render settings */
659         prop = RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
660         RNA_def_property_float_sdna(prop, NULL, "alpha");
661         RNA_def_property_ui_range(prop, 0.0f, 1.0f, 0.1, 3);
662         RNA_def_property_ui_text(prop, "Opacity", "Render Opacity");
663         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
664
665         /* weight interpolation */
666         prop = RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
667         RNA_def_property_enum_sdna(prop, NULL, "blend");
668         RNA_def_property_enum_items(prop, masklay_blend_mode_items);
669         RNA_def_property_ui_text(prop, "Blend", "Method of blending mask layers");
670         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
671         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
672
673         prop = RNA_def_property(srna, "invert", PROP_BOOLEAN, PROP_NONE);
674         RNA_def_property_boolean_sdna(prop, NULL, "blend_flag", MASK_BLENDFLAG_INVERT);
675         RNA_def_property_ui_text(prop, "Restrict View", "Invert the mask black/white");
676         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
677
678         prop = RNA_def_property(srna, "falloff", PROP_ENUM, PROP_NONE);
679         RNA_def_property_enum_sdna(prop, NULL, "falloff");
680         RNA_def_property_enum_items(prop, proportional_falloff_curve_only_items);
681         RNA_def_property_ui_text(prop, "Falloff", "Falloff type the feather");
682         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
683
684 }
685
686 static void rna_def_masklayers(BlenderRNA *brna, PropertyRNA *cprop)
687 {
688         StructRNA *srna;
689         PropertyRNA *prop;
690
691         FunctionRNA *func;
692         PropertyRNA *parm;
693
694         RNA_def_property_srna(cprop, "MaskLayers");
695         srna = RNA_def_struct(brna, "MaskLayers", NULL);
696         RNA_def_struct_sdna(srna, "Mask");
697         RNA_def_struct_ui_text(srna, "Mask Layers", "Collection of layers used by mask");
698
699         func = RNA_def_function(srna, "new", "rna_Mask_layers_new");
700         RNA_def_function_ui_description(func, "Add layer to this mask");
701         RNA_def_string(func, "name", "", 0, "Name", "Name of new layer");
702         parm = RNA_def_pointer(func, "layer", "MaskLayer", "", "New mask layer");
703         RNA_def_function_return(func, parm);
704
705         func = RNA_def_function(srna, "remove", "rna_Mask_layers_remove");
706         RNA_def_function_flag(func, FUNC_USE_REPORTS);
707         RNA_def_function_ui_description(func, "Remove layer from this mask");
708         RNA_def_pointer(func, "layer", "MaskLayer", "", "Shape to be removed");
709
710         /* clear all layers */
711         func = RNA_def_function(srna, "clear", "rna_Mask_layers_clear");
712         RNA_def_function_ui_description(func, "Remove all mask layers");
713
714         /* active layer */
715         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
716         RNA_def_property_struct_type(prop, "MaskLayer");
717         RNA_def_property_pointer_funcs(prop, "rna_Mask_layer_active_get", "rna_Mask_layer_active_set", NULL, NULL);
718         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
719         RNA_def_property_ui_text(prop, "Active Shape", "Active layer in this mask");
720 }
721
722 static void rna_def_mask(BlenderRNA *brna)
723 {
724         StructRNA *srna;
725         PropertyRNA *prop;
726
727         rna_def_mask_layer(brna);
728
729         srna = RNA_def_struct(brna, "Mask", "ID");
730         RNA_def_struct_ui_text(srna, "Mask", "Mask datablock defining mask for compositing");
731         RNA_def_struct_ui_icon(srna, ICON_MOD_MASK);
732
733         /* mask layers */
734         prop = RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
735         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);
736         RNA_def_property_struct_type(prop, "MaskLayer");
737         RNA_def_property_ui_text(prop, "Layers", "Collection of layers which defines this mask");
738         rna_def_masklayers(brna, prop);
739
740         /* active masklay index */
741         prop = RNA_def_property(srna, "active_layer_index", PROP_INT, PROP_NONE);
742         RNA_def_property_int_sdna(prop, NULL, "masklay_act");
743         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
744         RNA_def_property_int_funcs(prop, "rna_Mask_layer_active_index_get", "rna_Mask_layer_active_index_set", "rna_Mask_layer_active_index_range");
745         RNA_def_property_ui_text(prop, "Active Shape Index", "Index of active layer in list of all mask's layers");
746         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
747
748         /* frame range */
749         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
750         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
751         RNA_def_property_int_sdna(prop, NULL, "sfra");
752         RNA_def_property_int_funcs(prop, NULL, "rna_Mask_start_frame_set", NULL);
753         RNA_def_property_range(prop, MINFRAME, MAXFRAME);
754         RNA_def_property_ui_text(prop, "Start Frame", "First frame of the mask (used for sequencer)");
755         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
756
757         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_TIME);
758         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
759         RNA_def_property_int_sdna(prop, NULL, "efra");
760         RNA_def_property_int_funcs(prop, NULL, "rna_Mask_end_frame_set", NULL);
761         RNA_def_property_range(prop, MINFRAME, MAXFRAME);
762         RNA_def_property_ui_text(prop, "End Frame", "Final frame of the mask (used for sequencer)");
763         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
764
765         /* pointers */
766         rna_def_animdata_common(srna);
767 }
768
769 void RNA_def_mask(BlenderRNA *brna)
770 {
771         rna_def_maskParent(brna);
772         rna_def_mask(brna);
773 }
774
775 #endif