31e6b0e48e2d9f178b41a605a2977b5d1fb87c66
[blender-staging.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 "DNA_mask_types.h"
35 #include "DNA_object_types.h"   /* SELECT */
36 #include "DNA_scene_types.h"
37
38 #include "BLF_translation.h"
39
40 #include "BKE_movieclip.h"
41 #include "BKE_tracking.h"
42
43 #include "RNA_define.h"
44 #include "RNA_enum_types.h"
45
46 #include "rna_internal.h"
47
48 #include "WM_types.h"
49
50 #include "IMB_imbuf_types.h"
51 #include "IMB_imbuf.h"
52
53 #ifdef RNA_RUNTIME
54
55 #include "DNA_mask_types.h"
56 #include "DNA_movieclip_types.h"
57
58 #include "BKE_depsgraph.h"
59 #include "BKE_mask.h"
60 #include "BKE_tracking.h"
61
62 #include "BLI_math.h"
63
64 #include "RNA_access.h"
65
66 #include "WM_api.h"
67
68 static void rna_Mask_update_data(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
69 {
70         Mask *mask = ptr->id.data;
71
72         WM_main_add_notifier(NC_MASK | ND_DATA, mask);
73         DAG_id_tag_update( &mask->id, 0);
74 }
75
76 static void rna_Mask_update_parent(Main *bmain, Scene *scene, PointerRNA *ptr)
77 {
78         MaskParent *parent = ptr->data;
79
80         if (parent->id) {
81                 if (GS(parent->id->name) == ID_MC) {
82                         MovieClip *clip = (MovieClip *) parent->id;
83                         MovieTracking *tracking = &clip->tracking;
84                         MovieTrackingObject *object = BKE_tracking_object_get_named(tracking, parent->parent);
85
86                         if (object) {
87                                 int clip_framenr = BKE_movieclip_remap_scene_to_clip_frame(clip, scene->r.cfra);
88
89                                 if (parent->type == MASK_PARENT_POINT_TRACK) {
90                                         MovieTrackingTrack *track = BKE_tracking_track_get_named(tracking, object, parent->sub_parent);
91
92                                         if (track) {
93                                                 MovieTrackingMarker *marker = BKE_tracking_marker_get(track, clip_framenr);
94                                                 float marker_pos_ofs[2], parmask_pos[2];
95                                                 MovieClipUser user = {0};
96
97                                                 BKE_movieclip_user_set_frame(&user, scene->r.cfra);
98
99                                                 add_v2_v2v2(marker_pos_ofs, marker->pos, track->offset);
100
101                                                 BKE_mask_coord_from_movieclip(clip, &user, parmask_pos, marker_pos_ofs);
102
103                                                 copy_v2_v2(parent->parent_orig, parmask_pos);
104                                         }
105                                 }
106                                 else /* if (parent->type == MASK_PARENT_PLANE_TRACK) */ {
107                                         MovieTrackingPlaneTrack *plane_track = BKE_tracking_plane_track_get_named(tracking, object, parent->sub_parent);
108                                         if (plane_track) {
109                                                 MovieTrackingPlaneMarker *plane_marker = BKE_tracking_plane_marker_get(plane_track, clip_framenr);
110
111                                                 memcpy(parent->parent_corners_orig, plane_marker->corners, sizeof(parent->parent_corners_orig));
112                                                 zero_v2(parent->parent_orig);
113                                         }
114                                 }
115                         }
116                 }
117         }
118
119         rna_Mask_update_data(bmain, scene, ptr);
120 }
121
122 /* note: this function exists only to avoid id refcounting */
123 static void rna_MaskParent_id_set(PointerRNA *ptr, PointerRNA value)
124 {
125         MaskParent *mpar = (MaskParent *) ptr->data;
126
127         mpar->id = value.data;
128 }
129
130 static StructRNA *rna_MaskParent_id_typef(PointerRNA *ptr)
131 {
132         MaskParent *mpar = (MaskParent *) ptr->data;
133
134         return ID_code_to_RNA_type(mpar->id_type);
135 }
136
137 static void rna_MaskParent_id_type_set(PointerRNA *ptr, int value)
138 {
139         MaskParent *mpar = (MaskParent *) ptr->data;
140
141         /* change ID-type to the new type */
142         mpar->id_type = value;
143
144         /* clear the id-block if the type is invalid */
145         if ((mpar->id) && (GS(mpar->id->name) != mpar->id_type))
146                 mpar->id = NULL;
147 }
148
149 static void rna_Mask_layers_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
150 {
151         Mask *mask = (Mask *)ptr->id.data;
152
153         rna_iterator_listbase_begin(iter, &mask->masklayers, NULL);
154 }
155
156 static int rna_Mask_layer_active_index_get(PointerRNA *ptr)
157 {
158         Mask *mask = (Mask *)ptr->id.data;
159
160         return mask->masklay_act;
161 }
162
163 static void rna_Mask_layer_active_index_set(PointerRNA *ptr, int value)
164 {
165         Mask *mask = (Mask *)ptr->id.data;
166
167         mask->masklay_act = value;
168 }
169
170 static void rna_Mask_layer_active_index_range(PointerRNA *ptr, int *min, int *max, int *softmin, int *softmax)
171 {
172         Mask *mask = (Mask *)ptr->id.data;
173
174         *min = 0;
175         *max = max_ii(0, mask->masklay_tot - 1);
176
177         *softmin = *min;
178         *softmax = *max;
179 }
180
181 static char *rna_MaskLayer_path(PointerRNA *ptr)
182 {
183         MaskLayer *masklay = (MaskLayer *)ptr->data;
184         char name_esc[sizeof(masklay->name) * 2];
185         BLI_strescape(name_esc, masklay->name, sizeof(name_esc));
186         return BLI_sprintfN("layers[\"%s\"]", name_esc);
187 }
188
189 static PointerRNA rna_Mask_layer_active_get(PointerRNA *ptr)
190 {
191         Mask *mask = (Mask *)ptr->id.data;
192         MaskLayer *masklay = BKE_mask_layer_active(mask);
193
194         return rna_pointer_inherit_refine(ptr, &RNA_MaskLayer, masklay);
195 }
196
197 static void rna_Mask_layer_active_set(PointerRNA *ptr, PointerRNA value)
198 {
199         Mask *mask = (Mask *)ptr->id.data;
200         MaskLayer *masklay = (MaskLayer *)value.data;
201
202         BKE_mask_layer_active_set(mask, masklay);
203 }
204
205 static void rna_MaskLayer_splines_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
206 {
207         MaskLayer *masklay = (MaskLayer *)ptr->data;
208
209         rna_iterator_listbase_begin(iter, &masklay->splines, NULL);
210 }
211
212 static void rna_MaskLayer_name_set(PointerRNA *ptr, const char *value)
213 {
214         Mask *mask = (Mask *)ptr->id.data;
215         MaskLayer *masklay = (MaskLayer *)ptr->data;
216
217         BLI_strncpy(masklay->name, value, sizeof(masklay->name));
218
219         BKE_mask_layer_unique_name(mask, masklay);
220 }
221
222 static PointerRNA rna_MaskLayer_active_spline_get(PointerRNA *ptr)
223 {
224         MaskLayer *masklay = (MaskLayer *)ptr->data;
225
226         return rna_pointer_inherit_refine(ptr, &RNA_MaskSpline, masklay->act_spline);
227 }
228
229 static void rna_MaskLayer_active_spline_set(PointerRNA *ptr, PointerRNA value)
230 {
231         MaskLayer *masklay = (MaskLayer *)ptr->data;
232         MaskSpline *spline = (MaskSpline *)value.data;
233         int index = BLI_findindex(&masklay->splines, spline);
234
235         if (index != -1)
236                 masklay->act_spline = spline;
237         else
238                 masklay->act_spline = NULL;
239 }
240
241 static PointerRNA rna_MaskLayer_active_spline_point_get(PointerRNA *ptr)
242 {
243         MaskLayer *masklay = (MaskLayer *)ptr->data;
244
245         return rna_pointer_inherit_refine(ptr, &RNA_MaskSplinePoint, masklay->act_point);
246 }
247
248 static void rna_MaskLayer_active_spline_point_set(PointerRNA *ptr, PointerRNA value)
249 {
250         MaskLayer *masklay = (MaskLayer *)ptr->data;
251         MaskSpline *spline;
252         MaskSplinePoint *point = (MaskSplinePoint *)value.data;
253
254         masklay->act_point = NULL;
255
256         for (spline = masklay->splines.first; spline; spline = spline->next) {
257                 if (point >= spline->points && point < spline->points + spline->tot_point) {
258                         masklay->act_point = point;
259
260                         break;
261                 }
262         }
263 }
264
265 static void rna_MaskSplinePoint_handle1_get(PointerRNA *ptr, float *values)
266 {
267         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
268         BezTriple *bezt = &point->bezt;
269         copy_v2_v2(values, bezt->vec[0]);
270 }
271
272 static void rna_MaskSplinePoint_handle1_set(PointerRNA *ptr, const float *values)
273 {
274         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
275         BezTriple *bezt = &point->bezt;
276         copy_v2_v2(bezt->vec[0], values);
277 }
278
279 static void rna_MaskSplinePoint_handle2_get(PointerRNA *ptr, float *values)
280 {
281         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
282         BezTriple *bezt = &point->bezt;
283         copy_v2_v2(values, bezt->vec[2]);
284 }
285
286 static void rna_MaskSplinePoint_handle2_set(PointerRNA *ptr, const float *values)
287 {
288         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
289         BezTriple *bezt = &point->bezt;
290         copy_v2_v2(bezt->vec[2], values);
291 }
292
293 static void rna_MaskSplinePoint_ctrlpoint_get(PointerRNA *ptr, float *values)
294 {
295         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
296         BezTriple *bezt = &point->bezt;
297         copy_v2_v2(values, bezt->vec[1]);
298 }
299
300 static void rna_MaskSplinePoint_ctrlpoint_set(PointerRNA *ptr, const float *values)
301 {
302         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
303         BezTriple *bezt = &point->bezt;
304         copy_v2_v2(bezt->vec[1], values);
305 }
306
307 static int rna_MaskSplinePoint_handle_type_get(PointerRNA *ptr)
308 {
309         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
310         BezTriple *bezt = &point->bezt;
311
312         return bezt->h1;
313 }
314
315 static void rna_MaskSplinePoint_handle_type_set(PointerRNA *ptr, int value)
316 {
317         MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
318         BezTriple *bezt = &point->bezt;
319
320         bezt->h1 = bezt->h2 = value;
321 }
322
323 /* ** API **  */
324
325 static MaskLayer *rna_Mask_layers_new(Mask *mask, const char *name)
326 {
327         MaskLayer *masklay = BKE_mask_layer_new(mask, name);
328
329         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
330
331         return masklay;
332 }
333
334 static void rna_Mask_layers_remove(Mask *mask, ReportList *reports, PointerRNA *masklay_ptr)
335 {
336         MaskLayer *masklay = masklay_ptr->data;
337         if (BLI_findindex(&mask->masklayers, masklay) == -1) {
338                 BKE_reportf(reports, RPT_ERROR, "Mask layer '%s' not found in mask '%s'", masklay->name, mask->id.name + 2);
339                 return;
340         }
341
342         BKE_mask_layer_remove(mask, masklay);
343         RNA_POINTER_INVALIDATE(masklay_ptr);
344
345         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
346 }
347
348 static void rna_Mask_layers_clear(Mask *mask)
349 {
350         BKE_mask_layer_free_list(&mask->masklayers);
351
352         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
353 }
354
355 static MaskSpline *rna_MaskLayer_spline_new(ID *id, MaskLayer *mask_layer)
356 {
357         Mask *mask = (Mask *) id;
358         MaskSpline *new_spline;
359
360         new_spline = BKE_mask_spline_add(mask_layer);
361
362         WM_main_add_notifier(NC_MASK | NA_EDITED, mask);
363
364         return new_spline;
365 }
366
367 static void rna_MaskLayer_spline_remove(ID *id, MaskLayer *mask_layer, ReportList *reports, PointerRNA *spline_ptr)
368 {
369         Mask *mask = (Mask *) id;
370         MaskSpline *spline = spline_ptr->data;
371
372         if (BKE_mask_spline_remove(mask_layer, spline) == FALSE) {
373                 BKE_reportf(reports, RPT_ERROR, "Mask layer '%s' does not contain spline given", mask_layer->name);
374                 return;
375         }
376
377         RNA_POINTER_INVALIDATE(spline_ptr);
378
379         DAG_id_tag_update(&mask->id, OB_RECALC_DATA);
380 }
381
382 static void rna_Mask_start_frame_set(PointerRNA *ptr, int value)
383 {
384         Mask *data = (Mask *)ptr->data;
385         /* MINFRAME not MINAFRAME, since some output formats can't taken negative frames */
386         CLAMP(value, MINFRAME, MAXFRAME);
387         data->sfra = value;
388
389         if (data->sfra >= data->efra) {
390                 data->efra = MIN2(data->sfra, MAXFRAME);
391         }
392 }
393
394 static void rna_Mask_end_frame_set(PointerRNA *ptr, int value)
395 {
396         Mask *data = (Mask *)ptr->data;
397         CLAMP(value, MINFRAME, MAXFRAME);
398         data->efra = value;
399
400         if (data->sfra >= data->efra) {
401                 data->sfra = MAX2(data->efra, MINFRAME);
402         }
403 }
404
405 static void rna_MaskSpline_points_add(ID *id, MaskSpline *spline, int count)
406 {
407         Mask *mask = (Mask *) id;
408         MaskLayer *layer;
409         int active_point_index = -1;
410         int i, spline_shape_index;
411
412         if (count <= 0) {
413                 return;
414         }
415
416         for (layer = mask->masklayers.first; layer; layer = layer->next) {
417                 if (BLI_findindex(&layer->splines, spline) != -1) {
418                         break;
419                 }
420         }
421
422         if (!layer) {
423                 /* Shall not happen actually */
424                 BLI_assert(!"No layer found for the spline");
425                 return;
426         }
427
428         if (layer->act_spline == spline) {
429                 active_point_index = layer->act_point - spline->points;
430         }
431
432         spline->points = MEM_recallocN(spline->points, sizeof(MaskSplinePoint) * (spline->tot_point + count));
433         spline->tot_point += count;
434
435         if (active_point_index >= 0) {
436                 layer->act_point = spline->points + active_point_index;
437         }
438
439         spline_shape_index = BKE_mask_layer_shape_spline_to_index(layer, spline);
440
441         for (i = 0; i < count; i++) {
442                 int point_index = spline->tot_point - count + i;
443                 MaskSplinePoint *new_point = spline->points + point_index;
444                 new_point->bezt.h1 = new_point->bezt.h2 = HD_ALIGN;
445                 BKE_mask_calc_handle_point_auto(spline, new_point, TRUE);
446                 BKE_mask_parent_init(&new_point->parent);
447
448                 /* Not efficient, but there's no other way for now */
449                 BKE_mask_layer_shape_changed_add(layer, spline_shape_index + point_index, true, true);
450         }
451
452         WM_main_add_notifier(NC_MASK | ND_DATA, mask);
453         DAG_id_tag_update(&mask->id, 0);
454 }
455
456 static void rna_MaskSpline_point_remove(ID *id, MaskSpline *spline, ReportList *reports, PointerRNA *point_ptr)
457 {
458         Mask *mask = (Mask *) id;
459         MaskSplinePoint *point = point_ptr->data;
460         MaskSplinePoint *new_point_array;
461         MaskLayer *layer;
462         int active_point_index = -1;
463         int point_index;
464
465         for (layer = mask->masklayers.first; layer; layer = layer->next) {
466                 if (BLI_findindex(&layer->splines, spline) != -1) {
467                         break;
468                 }
469         }
470
471         if (!layer) {
472                 /* Shall not happen actually */
473                 BKE_report(reports, RPT_ERROR, "Mask layer not found for given spline");
474                 return;
475         }
476
477         if (point < spline->points || point >= spline->points + spline->tot_point) {
478                 BKE_report(reports, RPT_ERROR, "Point is not found in given spline");
479                 return;
480         }
481
482         if (layer->act_spline == spline) {
483                 active_point_index = layer->act_point - spline->points;
484         }
485
486         point_index = point - spline->points;
487
488         new_point_array = MEM_mallocN(sizeof(MaskSplinePoint) * (spline->tot_point - 1), "remove mask point");
489
490         memcpy(new_point_array, spline->points, sizeof(MaskSplinePoint) * point_index);
491         memcpy(new_point_array + point_index, spline->points + point_index + 1,
492                sizeof(MaskSplinePoint) * (spline->tot_point - point_index - 1));
493
494         MEM_freeN(spline->points);
495         spline->points = new_point_array;
496         spline->tot_point--;
497
498         if (active_point_index >= 0) {
499                 if (active_point_index == point_index) {
500                         layer->act_point = NULL;
501                 }
502                 else if (active_point_index < point_index) {
503                         layer->act_point = spline->points + active_point_index;
504                 }
505                 else {
506                         layer->act_point = spline->points + active_point_index - 1;
507                 }
508         }
509
510         BKE_mask_layer_shape_changed_remove(layer, BKE_mask_layer_shape_spline_to_index(layer, spline) + point_index, 1);
511
512         WM_main_add_notifier(NC_MASK | ND_DATA, mask);
513         DAG_id_tag_update(&mask->id, 0);
514
515         RNA_POINTER_INVALIDATE(point_ptr);
516 }
517
518 #else
519 static void rna_def_maskParent(BlenderRNA *brna)
520 {
521         StructRNA *srna;
522         PropertyRNA *prop;
523
524         static EnumPropertyItem mask_id_type_items[] = {
525                 {ID_MC, "MOVIECLIP", ICON_SEQUENCE, "Movie Clip", ""},
526                 {0, NULL, 0, NULL, NULL}};
527
528         static EnumPropertyItem parent_type_items[] = {
529                 {MASK_PARENT_POINT_TRACK, "POINT_TRACK", 0, "Point Track", ""},
530                 {MASK_PARENT_PLANE_TRACK, "PLANE_TRACK", 0, "Plane Track", ""},
531                 {0, NULL, 0, NULL, NULL}};
532
533         srna = RNA_def_struct(brna, "MaskParent", NULL);
534         RNA_def_struct_ui_text(srna, "Mask Parent", "Parenting settings for masking element");
535
536         /* Target Properties - ID-block to Drive */
537         prop = RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
538         RNA_def_property_struct_type(prop, "ID");
539         RNA_def_property_flag(prop, PROP_EDITABLE);
540         // RNA_def_property_editable_func(prop, "rna_maskSpline_id_editable");
541         /* note: custom set function is ONLY to avoid rna setting a user for this. */
542         RNA_def_property_pointer_funcs(prop, NULL, "rna_MaskParent_id_set", "rna_MaskParent_id_typef", NULL);
543         RNA_def_property_ui_text(prop, "ID", "ID-block to which masking element would be parented to or to it's property");
544         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
545
546         prop = RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
547         RNA_def_property_enum_sdna(prop, NULL, "id_type");
548         RNA_def_property_enum_items(prop, mask_id_type_items);
549         RNA_def_property_enum_default(prop, ID_MC);
550         RNA_def_property_enum_funcs(prop, NULL, "rna_MaskParent_id_type_set", NULL);
551         //RNA_def_property_editable_func(prop, "rna_MaskParent_id_type_editable");
552         RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used");
553         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
554
555         /* type */
556         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
557         RNA_def_property_enum_items(prop, parent_type_items);
558         RNA_def_property_ui_text(prop, "Parent Type", "Parent Type");
559         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
560
561         /* parent */
562         prop = RNA_def_property(srna, "parent", PROP_STRING, PROP_NONE);
563         RNA_def_property_ui_text(prop, "Parent", "Name of parent object in specified data block to which parenting happens");
564         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
565         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
566
567         /* sub_parent */
568         prop = RNA_def_property(srna, "sub_parent", PROP_STRING, PROP_NONE);
569         RNA_def_property_ui_text(prop, "Sub Parent", "Name of parent sub-object in specified data block to which parenting happens");
570         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
571         RNA_def_property_update(prop, 0, "rna_Mask_update_parent");
572 }
573
574 static void rna_def_maskSplinePointUW(BlenderRNA *brna)
575 {
576         StructRNA *srna;
577         PropertyRNA *prop;
578
579         srna = RNA_def_struct(brna, "MaskSplinePointUW", NULL);
580         RNA_def_struct_ui_text(srna, "Mask Spline UW Point", "Single point in spline segment defining feather");
581
582         /* u */
583         prop = RNA_def_property(srna, "u", PROP_FLOAT, PROP_NONE);
584         RNA_def_property_float_sdna(prop, NULL, "u");
585         RNA_def_property_range(prop, 0.0, 1.0);
586         RNA_def_property_ui_text(prop, "U", "U coordinate of point along spline segment");
587         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
588
589         /* weight */
590         prop = RNA_def_property(srna, "weight", PROP_FLOAT, PROP_NONE);
591         RNA_def_property_float_sdna(prop, NULL, "w");
592         RNA_def_property_range(prop, 0.0, 1.0);
593         RNA_def_property_ui_text(prop, "Weight", "Weight of feather point");
594         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
595
596         /* select */
597         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
598         RNA_def_property_boolean_sdna(prop, NULL, "flag", SELECT);
599         RNA_def_property_ui_text(prop, "Select", "Selection status");
600         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
601 }
602
603 static void rna_def_maskSplinePoint(BlenderRNA *brna)
604 {
605         StructRNA *srna;
606         PropertyRNA *prop;
607
608         static EnumPropertyItem handle_type_items[] = {
609                 {HD_AUTO, "AUTO", 0, "Auto", ""},
610                 {HD_VECT, "VECTOR", 0, "Vector", ""},
611                 {HD_ALIGN, "ALIGNED", 0, "Aligned", ""},
612                 {0, NULL, 0, NULL, NULL}};
613
614         rna_def_maskSplinePointUW(brna);
615
616         srna = RNA_def_struct(brna, "MaskSplinePoint", NULL);
617         RNA_def_struct_ui_text(srna, "Mask Spline Point", "Single point in spline used for defining mask");
618
619         /* Vector values */
620         prop = RNA_def_property(srna, "handle_left", PROP_FLOAT, PROP_TRANSLATION);
621         RNA_def_property_array(prop, 2);
622         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_handle1_get", "rna_MaskSplinePoint_handle1_set", NULL);
623         RNA_def_property_ui_text(prop, "Handle 1", "Coordinates of the first handle");
624         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
625
626         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
627         RNA_def_property_array(prop, 2);
628         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_ctrlpoint_get", "rna_MaskSplinePoint_ctrlpoint_set", NULL);
629         RNA_def_property_ui_text(prop, "Control Point", "Coordinates of the control point");
630         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
631
632         prop = RNA_def_property(srna, "handle_right", PROP_FLOAT, PROP_TRANSLATION);
633         RNA_def_property_array(prop, 2);
634         RNA_def_property_float_funcs(prop, "rna_MaskSplinePoint_handle2_get", "rna_MaskSplinePoint_handle2_set", NULL);
635         RNA_def_property_ui_text(prop, "Handle 2", "Coordinates of the second handle");
636         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
637
638         /* handle_type */
639         prop = RNA_def_property(srna, "handle_type", PROP_ENUM, PROP_NONE);
640         RNA_def_property_enum_funcs(prop, "rna_MaskSplinePoint_handle_type_get", "rna_MaskSplinePoint_handle_type_set", NULL);
641         RNA_def_property_enum_items(prop, handle_type_items);
642         RNA_def_property_ui_text(prop, "Handle Type", "Handle type");
643         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
644
645         /* select */
646         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
647         RNA_def_property_boolean_sdna(prop, NULL, "bezt.f1", SELECT);
648         RNA_def_property_ui_text(prop, "Select", "Selection status");
649         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
650
651         /* parent */
652         prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
653         RNA_def_property_struct_type(prop, "MaskParent");
654
655         /* feather points */
656         prop = RNA_def_property(srna, "feather_points", PROP_COLLECTION, PROP_NONE);
657         RNA_def_property_struct_type(prop, "MaskSplinePointUW");
658         RNA_def_property_collection_sdna(prop, NULL, "uw", "tot_uw");
659         RNA_def_property_ui_text(prop, "Feather Points", "Points defining feather");
660 }
661
662 static void rna_def_mask_splines(BlenderRNA *brna)
663 {
664         StructRNA *srna;
665         FunctionRNA *func;
666         PropertyRNA *prop;
667         PropertyRNA *parm;
668
669         srna = RNA_def_struct(brna, "MaskSplines", NULL);
670         RNA_def_struct_sdna(srna, "MaskLayer");
671         RNA_def_struct_ui_text(srna, "Mask Splines", "Collection of masking splines");
672
673         /* Create new spline */
674         func = RNA_def_function(srna, "new", "rna_MaskLayer_spline_new");
675         RNA_def_function_flag(func, FUNC_USE_SELF_ID);
676         RNA_def_function_ui_description(func, "Add a new spline to the layer");
677         parm = RNA_def_pointer(func, "spline", "MaskSpline", "", "The newly created spline");
678         RNA_def_function_return(func, parm);
679
680         /* Remove the spline */
681         func = RNA_def_function(srna, "remove", "rna_MaskLayer_spline_remove");
682         RNA_def_function_flag(func, FUNC_USE_SELF_ID);
683         RNA_def_function_ui_description(func, "Remove a spline from a layer");
684         RNA_def_function_flag(func, FUNC_USE_REPORTS);
685         parm = RNA_def_pointer(func, "spline", "MaskSpline", "", "The spline to remove");
686         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
687         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
688
689         /* active spline */
690         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
691         RNA_def_property_struct_type(prop, "MaskSpline");
692         RNA_def_property_pointer_funcs(prop, "rna_MaskLayer_active_spline_get", "rna_MaskLayer_active_spline_set", NULL, NULL);
693         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
694         RNA_def_property_ui_text(prop, "Active Spline", "Active spline of masking layer");
695
696         /* active point */
697         prop = RNA_def_property(srna, "active_point", PROP_POINTER, PROP_NONE);
698         RNA_def_property_struct_type(prop, "MaskSplinePoint");
699         RNA_def_property_pointer_funcs(prop, "rna_MaskLayer_active_spline_point_get", "rna_MaskLayer_active_spline_point_set", NULL, NULL);
700         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
701         RNA_def_property_ui_text(prop, "Active Spline", "Active spline of masking layer");
702 }
703
704 static void rna_def_maskSplinePoints(BlenderRNA *brna)
705 {
706         StructRNA *srna;
707         FunctionRNA *func;
708         PropertyRNA *parm;
709
710         srna = RNA_def_struct(brna, "MaskSplinePoints", NULL);
711         RNA_def_struct_sdna(srna, "MaskSpline");
712         RNA_def_struct_ui_text(srna, "Mask Spline Points", "Collection of masking spline points");
713
714         /* Create new point */
715         func = RNA_def_function(srna, "add", "rna_MaskSpline_points_add");
716         RNA_def_function_flag(func, FUNC_USE_SELF_ID);
717         RNA_def_function_ui_description(func, "Add a number of point to this spline");
718         RNA_def_int(func, "count", 1, 0, INT_MAX, "Number", "Number of points to add to the spline", 0, INT_MAX);
719
720         /* Remove the point */
721         func = RNA_def_function(srna, "remove", "rna_MaskSpline_point_remove");
722         RNA_def_function_flag(func, FUNC_USE_SELF_ID);
723         RNA_def_function_ui_description(func, "Remove a point from a spline");
724         RNA_def_function_flag(func, FUNC_USE_REPORTS);
725         parm = RNA_def_pointer(func, "point", "MaskSplinePoint", "", "The point to remove");
726         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
727         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
728 }
729
730 static void rna_def_maskSpline(BlenderRNA *brna)
731 {
732         static EnumPropertyItem spline_interpolation_items[] = {
733                 {MASK_SPLINE_INTERP_LINEAR, "LINEAR", 0, "Linear", ""},
734                 {MASK_SPLINE_INTERP_EASE, "EASE", 0, "Ease", ""},
735                 {0, NULL, 0, NULL, NULL}
736         };
737
738         static EnumPropertyItem spline_offset_mode_items[] = {
739                 {MASK_SPLINE_OFFSET_EVEN, "EVEN", 0, "Even", "Calculate even feather offset"},
740                 {MASK_SPLINE_OFFSET_SMOOTH, "SMOOTH", 0, "Smooth", "Calculate feather offset as a second curve"},
741                 {0, NULL, 0, NULL, NULL}
742         };
743
744         StructRNA *srna;
745         PropertyRNA *prop;
746
747         rna_def_maskSplinePoint(brna);
748
749         srna = RNA_def_struct(brna, "MaskSpline", NULL);
750         RNA_def_struct_ui_text(srna, "Mask spline", "Single spline used for defining mask shape");
751
752         /* offset mode */
753         prop = RNA_def_property(srna, "offset_mode", PROP_ENUM, PROP_NONE);
754         RNA_def_property_enum_sdna(prop, NULL, "offset_mode");
755         RNA_def_property_enum_items(prop, spline_offset_mode_items);
756         RNA_def_property_ui_text(prop, "Feather Offset", "The method used for calculating the feather offset");
757         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
758
759         /* weight interpolation */
760         prop = RNA_def_property(srna, "weight_interpolation", PROP_ENUM, PROP_NONE);
761         RNA_def_property_enum_sdna(prop, NULL, "weight_interp");
762         RNA_def_property_enum_items(prop, spline_interpolation_items);
763         RNA_def_property_ui_text(prop, "Weight Interpolation", "The type of weight interpolation for spline");
764         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
765
766         /* cyclic */
767         prop = RNA_def_property(srna, "use_cyclic", PROP_BOOLEAN, PROP_NONE);
768         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
769         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_SPLINE_CYCLIC);
770         RNA_def_property_ui_text(prop, "Cyclic", "Make this spline a closed loop");
771         RNA_def_property_update(prop, NC_MASK | NA_EDITED, "rna_Mask_update_data");
772
773         /* fill */
774         prop = RNA_def_property(srna, "use_fill", PROP_BOOLEAN, PROP_NONE);
775         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
776         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", MASK_SPLINE_NOFILL);
777         RNA_def_property_ui_text(prop, "Fill", "Make this spline filled");
778         RNA_def_property_update(prop, NC_MASK | NA_EDITED, "rna_Mask_update_data");
779
780         /* self-intersection check */
781         prop = RNA_def_property(srna, "use_self_intersection_check", PROP_BOOLEAN, PROP_NONE);
782         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
783         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_SPLINE_NOINTERSECT);
784         RNA_def_property_ui_text(prop, "Self Intersection Check", "Prevent feather from self-intersections");
785         RNA_def_property_update(prop, NC_MASK | NA_EDITED, "rna_Mask_update_data");
786
787         prop = RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
788         RNA_def_property_struct_type(prop, "MaskSplinePoint");
789         RNA_def_property_collection_sdna(prop, NULL, "points", "tot_point");
790         RNA_def_property_ui_text(prop, "Points", "Collection of points");
791         RNA_def_property_srna(prop, "MaskSplinePoints");
792 }
793
794 static void rna_def_mask_layer(BlenderRNA *brna)
795 {
796         static EnumPropertyItem masklay_blend_mode_items[] = {
797                 {MASK_BLEND_MERGE_ADD, "MERGE_ADD", 0, "Merge Add", ""},
798                 {MASK_BLEND_MERGE_SUBTRACT, "MERGE_SUBTRACT", 0, "Merge Subtract", ""},
799                 {MASK_BLEND_ADD, "ADD", 0, "Add", ""},
800                 {MASK_BLEND_SUBTRACT, "SUBTRACT", 0, "Subtract", ""},
801                 {MASK_BLEND_LIGHTEN, "LIGHTEN", 0, "Lighten", ""},
802                 {MASK_BLEND_DARKEN, "DARKEN", 0, "Darken", ""},
803                 {MASK_BLEND_MUL, "MUL", 0, "Multiply", ""},
804                 {MASK_BLEND_REPLACE, "REPLACE", 0, "Replace", ""},
805                 {MASK_BLEND_DIFFERENCE, "DIFFERENCE", 0, "Difference", ""},
806                 {0, NULL, 0, NULL, NULL}
807         };
808
809         StructRNA *srna;
810         PropertyRNA *prop;
811
812         rna_def_maskSpline(brna);
813         rna_def_mask_splines(brna);
814         rna_def_maskSplinePoints(brna);
815
816         srna = RNA_def_struct(brna, "MaskLayer", NULL);
817         RNA_def_struct_ui_text(srna, "Mask Layer", "Single layer used for masking pixels");
818         RNA_def_struct_path_func(srna, "rna_MaskLayer_path");
819
820         /* name */
821         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
822         RNA_def_property_ui_text(prop, "Name", "Unique name of layer");
823         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_MaskLayer_name_set");
824         RNA_def_property_string_maxlength(prop, MAX_ID_NAME - 2);
825         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
826         RNA_def_struct_name_property(srna, prop);
827
828         /* splines */
829         prop = RNA_def_property(srna, "splines", PROP_COLLECTION, PROP_NONE);
830         RNA_def_property_collection_funcs(prop, "rna_MaskLayer_splines_begin", "rna_iterator_listbase_next", "rna_iterator_listbase_end", "rna_iterator_listbase_get", NULL, NULL, NULL, NULL);
831         RNA_def_property_struct_type(prop, "MaskSpline");
832         RNA_def_property_ui_text(prop, "Splines", "Collection of splines which defines this layer");
833         RNA_def_property_srna(prop, "MaskSplines");
834
835         /* restrict */
836         prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
837         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_VIEW);
838         RNA_def_property_ui_text(prop, "Restrict View", "Restrict visibility in the viewport");
839         RNA_def_property_ui_icon(prop, ICON_RESTRICT_VIEW_OFF, 1);
840         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
841
842         prop = RNA_def_property(srna, "hide_select", PROP_BOOLEAN, PROP_NONE);
843         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_SELECT);
844         RNA_def_property_ui_text(prop, "Restrict Select", "Restrict selection in the viewport");
845         RNA_def_property_ui_icon(prop, ICON_RESTRICT_SELECT_OFF, 1);
846         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
847
848         prop = RNA_def_property(srna, "hide_render", PROP_BOOLEAN, PROP_NONE);
849         RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", MASK_RESTRICT_RENDER);
850         RNA_def_property_ui_text(prop, "Restrict Render", "Restrict renderability");
851         RNA_def_property_ui_icon(prop, ICON_RESTRICT_RENDER_OFF, 1);
852         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
853
854         /* select (for dopesheet)*/
855         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
856         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_LAYERFLAG_SELECT);
857         RNA_def_property_ui_text(prop, "Select", "Layer is selected for editing in the Dope Sheet");
858 //      RNA_def_property_update(prop, NC_SCREEN | ND_MASK, NULL);
859
860         /* render settings */
861         prop = RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
862         RNA_def_property_float_sdna(prop, NULL, "alpha");
863         RNA_def_property_ui_range(prop, 0.0f, 1.0f, 0.1, 3);
864         RNA_def_property_ui_text(prop, "Opacity", "Render Opacity");
865         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
866
867         /* weight interpolation */
868         prop = RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
869         RNA_def_property_enum_sdna(prop, NULL, "blend");
870         RNA_def_property_enum_items(prop, masklay_blend_mode_items);
871         RNA_def_property_ui_text(prop, "Blend", "Method of blending mask layers");
872         RNA_def_property_update(prop, 0, "rna_Mask_update_data");
873         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
874
875         prop = RNA_def_property(srna, "invert", PROP_BOOLEAN, PROP_NONE);
876         RNA_def_property_boolean_sdna(prop, NULL, "blend_flag", MASK_BLENDFLAG_INVERT);
877         RNA_def_property_ui_text(prop, "Restrict View", "Invert the mask black/white");
878         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
879
880         prop = RNA_def_property(srna, "falloff", PROP_ENUM, PROP_NONE);
881         RNA_def_property_enum_sdna(prop, NULL, "falloff");
882         RNA_def_property_enum_items(prop, proportional_falloff_curve_only_items);
883         RNA_def_property_ui_text(prop, "Falloff", "Falloff type the feather");
884         RNA_def_property_translation_context(prop, BLF_I18NCONTEXT_ID_CURVE); /* Abusing id_curve :/ */
885         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
886
887         /* filling options */
888         prop = RNA_def_property(srna, "use_fill_holes", PROP_BOOLEAN, PROP_NONE);
889         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", MASK_LAYERFLAG_FILL_DISCRETE);
890         RNA_def_property_ui_text(prop, "Calculate Holes", "Calculate holes when filling overlapping curves");
891         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
892
893         prop = RNA_def_property(srna, "use_fill_overlap", PROP_BOOLEAN, PROP_NONE);
894         RNA_def_property_boolean_sdna(prop, NULL, "flag", MASK_LAYERFLAG_FILL_OVERLAP);
895         RNA_def_property_ui_text(prop, "Calculate Overlap", "Calculate self intersections and overlap before filling");
896         RNA_def_property_update(prop, NC_MASK | NA_EDITED, NULL);
897 }
898
899 static void rna_def_masklayers(BlenderRNA *brna, PropertyRNA *cprop)
900 {
901         StructRNA *srna;
902         PropertyRNA *prop;
903
904         FunctionRNA *func;
905         PropertyRNA *parm;
906
907         RNA_def_property_srna(cprop, "MaskLayers");
908         srna = RNA_def_struct(brna, "MaskLayers", NULL);
909         RNA_def_struct_sdna(srna, "Mask");
910         RNA_def_struct_ui_text(srna, "Mask Layers", "Collection of layers used by mask");
911
912         func = RNA_def_function(srna, "new", "rna_Mask_layers_new");
913         RNA_def_function_ui_description(func, "Add layer to this mask");
914         RNA_def_string(func, "name", NULL, 0, "Name", "Name of new layer");
915         parm = RNA_def_pointer(func, "layer", "MaskLayer", "", "New mask layer");
916         RNA_def_function_return(func, parm);
917
918         func = RNA_def_function(srna, "remove", "rna_Mask_layers_remove");
919         RNA_def_function_flag(func, FUNC_USE_REPORTS);
920         RNA_def_function_ui_description(func, "Remove layer from this mask");
921         parm = RNA_def_pointer(func, "layer", "MaskLayer", "", "Shape to be removed");
922         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
923         RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
924
925         /* clear all layers */
926         func = RNA_def_function(srna, "clear", "rna_Mask_layers_clear");
927         RNA_def_function_ui_description(func, "Remove all mask layers");
928
929         /* active layer */
930         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
931         RNA_def_property_struct_type(prop, "MaskLayer");
932         RNA_def_property_pointer_funcs(prop, "rna_Mask_layer_active_get", "rna_Mask_layer_active_set", NULL, NULL);
933         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
934         RNA_def_property_ui_text(prop, "Active Shape", "Active layer in this mask");
935 }
936
937 static void rna_def_mask(BlenderRNA *brna)
938 {
939         StructRNA *srna;
940         PropertyRNA *prop;
941
942         rna_def_mask_layer(brna);
943
944         srna = RNA_def_struct(brna, "Mask", "ID");
945         RNA_def_struct_ui_text(srna, "Mask", "Mask datablock defining mask for compositing");
946         RNA_def_struct_ui_icon(srna, ICON_MOD_MASK);
947
948         /* mask layers */
949         prop = RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
950         RNA_def_property_collection_funcs(prop, "rna_Mask_layers_begin", "rna_iterator_listbase_next", "rna_iterator_listbase_end", "rna_iterator_listbase_get", NULL, NULL, NULL, NULL);
951         RNA_def_property_struct_type(prop, "MaskLayer");
952         RNA_def_property_ui_text(prop, "Layers", "Collection of layers which defines this mask");
953         rna_def_masklayers(brna, prop);
954
955         /* active masklay index */
956         prop = RNA_def_property(srna, "active_layer_index", PROP_INT, PROP_NONE);
957         RNA_def_property_int_sdna(prop, NULL, "masklay_act");
958         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
959         RNA_def_property_int_funcs(prop, "rna_Mask_layer_active_index_get", "rna_Mask_layer_active_index_set", "rna_Mask_layer_active_index_range");
960         RNA_def_property_ui_text(prop, "Active Shape Index", "Index of active layer in list of all mask's layers");
961         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
962
963         /* frame range */
964         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
965         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
966         RNA_def_property_int_sdna(prop, NULL, "sfra");
967         RNA_def_property_int_funcs(prop, NULL, "rna_Mask_start_frame_set", NULL);
968         RNA_def_property_range(prop, MINFRAME, MAXFRAME);
969         RNA_def_property_ui_text(prop, "Start Frame", "First frame of the mask (used for sequencer)");
970         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
971
972         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_TIME);
973         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
974         RNA_def_property_int_sdna(prop, NULL, "efra");
975         RNA_def_property_int_funcs(prop, NULL, "rna_Mask_end_frame_set", NULL);
976         RNA_def_property_range(prop, MINFRAME, MAXFRAME);
977         RNA_def_property_ui_text(prop, "End Frame", "Final frame of the mask (used for sequencer)");
978         RNA_def_property_update(prop, NC_MASK | ND_DRAW, NULL);
979
980         /* pointers */
981         rna_def_animdata_common(srna);
982 }
983
984 void RNA_def_mask(BlenderRNA *brna)
985 {
986         rna_def_maskParent(brna);
987         rna_def_mask(brna);
988 }
989
990 #endif