Implement asymmetric and free handles type for masks

Summary:
The title actually says it all, it's just possible to
have independent free handles for mask splines. Also
it's now possible to have aligned handles displayed
as independent handles.

Required changes in quite a few places, but they're
rather straightforward.

From user perspective there's one really visible change
which is removed Handle Type menu from the panel. With
asymmetric handles it's not clear which handle type to
display there. So now the only way to change handle type
is via V-key menu.

Rewrote normal evaluation function to make it deal
with new type of handles we support. Now it works in
the following way:

- Offset the original spline by maximal weight
- Calculate vector between corresponding U positions
  on offset and original spline
- Normalize this vector.

Seems to be giving more adequate results and doesn't
tend to self-intersect as much as old behavior used to,

There're still some changes which needed to be done, but
which are planned for further patch:

- Support colors and handle size via themes.
- Make handles color-coded, just the same as done for
  regular bezier splines in 3D viewport.

Additional changes to make roto workflow even better:
- Use circles to draw handles
- Support AA for handles
- Change click-create-drag to change curvature of the
  spline instead of adjusting point position.

Reviewers: campbellbarton

CC: sebastian_k, hype, cronk

Differential Revision: http://developer.blender.org/D121

2 files changed, 123 insertions, 21 deletions

diff --git a/source/blender/makesrna/intern/rna_mask.c b/source/blender/makesrna/intern/rna_mask.c
index 31e6b0e48e2..29bc15f1dbe 100644
--- a/source/blender/makesrna/intern/rna_mask.c
+++ b/source/blender/makesrna/intern/rna_mask.c
@@ -312,12 +312,83 @@ static int rna_MaskSplinePoint_handle_type_get(PointerRNA *ptr)
 	return bezt->h1;
 }
 
+static MaskSpline *mask_spline_from_point(Mask *mask, MaskSplinePoint *point)
+{
+	MaskLayer *mask_layer;
+	for (mask_layer = mask->masklayers.first;
+	     mask_layer;
+	     mask_layer = mask_layer->next)
+	{
+		MaskSpline *spline;
+		for (spline = mask_layer->splines.first;
+		     spline;
+		     spline = spline->next)
+		{
+			if (point >= spline->points && point < spline->points + spline->tot_point) {
+				return spline;
+			}
+		}
+	}
+	return NULL;
+}
+
+static void mask_point_check_stick(MaskSplinePoint *point)
+{
+	BezTriple *bezt = &point->bezt;
+	if (bezt->h1 == HD_ALIGN && bezt->h2 == HD_ALIGN) {
+		float vec[3];
+		sub_v3_v3v3(vec, bezt->vec[0], bezt->vec[1]);
+		add_v3_v3v3(bezt->vec[2], bezt->vec[1], vec);
+	}
+}
+
 static void rna_MaskSplinePoint_handle_type_set(PointerRNA *ptr, int value)
 {
 	MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
 	BezTriple *bezt = &point->bezt;
+	MaskSpline *spline = mask_spline_from_point((Mask *) ptr->id.data, point);
 
 	bezt->h1 = bezt->h2 = value;
+	mask_point_check_stick(point);
+	BKE_mask_calc_handle_point(spline, point);
+}
+
+static int rna_MaskSplinePoint_handle_left_type_get(PointerRNA *ptr)
+{
+	MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
+	BezTriple *bezt = &point->bezt;
+
+	return bezt->h1;
+}
+
+static void rna_MaskSplinePoint_handle_left_type_set(PointerRNA *ptr, int value)
+{
+	MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
+	BezTriple *bezt = &point->bezt;
+	MaskSpline *spline = mask_spline_from_point((Mask *) ptr->id.data, point);
+
+	bezt->h1 = value;
+	mask_point_check_stick(point);
+	BKE_mask_calc_handle_point(spline, point);
+}
+
+static int rna_MaskSplinePoint_handle_right_type_get(PointerRNA *ptr)
+{
+	MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
+	BezTriple *bezt = &point->bezt;
+
+	return bezt->h2;
+}
+
+static void rna_MaskSplinePoint_handle_right_type_set(PointerRNA *ptr, int value)
+{
+	MaskSplinePoint *point = (MaskSplinePoint *) ptr->data;
+	BezTriple *bezt = &point->bezt;
+	MaskSpline *spline = mask_spline_from_point((Mask *) ptr->id.data, point);
+
+	bezt->h2 = value;
+	mask_point_check_stick(point);
+	BKE_mask_calc_handle_point(spline, point);
 }
 
 /* ** API **  */
@@ -608,7 +679,9 @@ static void rna_def_maskSplinePoint(BlenderRNA *brna)
 	static EnumPropertyItem handle_type_items[] = {
 		{HD_AUTO, "AUTO", 0, "Auto", ""},
 		{HD_VECT, "VECTOR", 0, "Vector", ""},
-		{HD_ALIGN, "ALIGNED", 0, "Aligned", ""},
+		{HD_ALIGN, "ALIGNED", 0, "Aligned Single", ""},
+		{HD_ALIGN_DOUBLESIDE, "ALIGNED_DOUBLESIDE", 0, "Aligned", ""},
+		{HD_FREE, "FREE", 0, "Free", ""},
 		{0, NULL, 0, NULL, NULL}};
 
 	rna_def_maskSplinePointUW(brna);
@@ -642,6 +715,27 @@ static void rna_def_maskSplinePoint(BlenderRNA *brna)
 	RNA_def_property_ui_text(prop, "Handle Type", "Handle type");
 	RNA_def_property_update(prop, 0, "rna_Mask_update_data");
 
+	/* handle_type */
+	prop = RNA_def_property(srna, "handle_left_type", PROP_ENUM, PROP_NONE);
+	RNA_def_property_enum_funcs(prop, "rna_MaskSplinePoint_handle_left_type_get", "rna_MaskSplinePoint_handle_left_type_set", NULL);
+	RNA_def_property_enum_items(prop, handle_type_items);
+	RNA_def_property_ui_text(prop, "Handle 1 Type", "Handle type");
+	RNA_def_property_update(prop, 0, "rna_Mask_update_data");
+
+	/* handle_right */
+	prop = RNA_def_property(srna, "handle_right_type", PROP_ENUM, PROP_NONE);
+	RNA_def_property_enum_funcs(prop, "rna_MaskSplinePoint_handle_right_type_get", "rna_MaskSplinePoint_handle_right_type_set", NULL);
+	RNA_def_property_enum_items(prop, handle_type_items);
+	RNA_def_property_ui_text(prop, "Handle 2 Type", "Handle type");
+	RNA_def_property_update(prop, 0, "rna_Mask_update_data");
+
+	/* weight */
+	prop = RNA_def_property(srna, "weight", PROP_FLOAT, PROP_NONE);
+	RNA_def_property_float_sdna(prop, NULL, "bezt.weight");
+	RNA_def_property_range(prop, 0.0, 1.0);
+	RNA_def_property_ui_text(prop, "Weight", "Weight of the point");
+	RNA_def_property_update(prop, 0, "rna_Mask_update_data");
+
 	/* select */
 	prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
 	RNA_def_property_boolean_sdna(prop, NULL, "bezt.f1", SELECT);
diff --git a/source/blender/makesrna/intern/rna_userdef.c b/source/blender/makesrna/intern/rna_userdef.c
index 41953fb0239..fd8d8aede87 100644
--- a/source/blender/makesrna/intern/rna_userdef.c
+++ b/source/blender/makesrna/intern/rna_userdef.c
@@ -1292,7 +1292,7 @@ static void rna_def_userdef_theme_spaces_face(StructRNA *srna)
 	RNA_def_property_update(prop, 0, "rna_userdef_update");
 }
 
-static void rna_def_userdef_theme_spaces_curves(StructRNA *srna, short incl_nurbs)
+static void rna_def_userdef_theme_spaces_curves(StructRNA *srna, bool incl_nurbs, bool incl_lastsel, bool incl_vector)
 {
 	PropertyRNA *prop;
 	
@@ -1340,11 +1340,19 @@ static void rna_def_userdef_theme_spaces_curves(StructRNA *srna, short incl_nurb
 	RNA_def_property_ui_text(prop, "Auto handle color", "");
 	RNA_def_property_update(prop, 0, "rna_userdef_update");
 
-	prop = RNA_def_property(srna, "handle_vect", PROP_FLOAT, PROP_COLOR_GAMMA);
-	RNA_def_property_float_sdna(prop, NULL, "handle_vect");
-	RNA_def_property_array(prop, 3);
-	RNA_def_property_ui_text(prop, "Vector handle color", "");
-	RNA_def_property_update(prop, 0, "rna_userdef_update");
+	if (incl_vector) {
+		prop = RNA_def_property(srna, "handle_vect", PROP_FLOAT, PROP_COLOR_GAMMA);
+		RNA_def_property_float_sdna(prop, NULL, "handle_vect");
+		RNA_def_property_array(prop, 3);
+		RNA_def_property_ui_text(prop, "Vector handle color", "");
+		RNA_def_property_update(prop, 0, "rna_userdef_update");
+
+		prop = RNA_def_property(srna, "handle_sel_vect", PROP_FLOAT, PROP_COLOR_GAMMA);
+		RNA_def_property_float_sdna(prop, NULL, "handle_sel_vect");
+		RNA_def_property_array(prop, 3);
+		RNA_def_property_ui_text(prop, "Vector handle selected color", "");
+		RNA_def_property_update(prop, 0, "rna_userdef_update");
+	}
 
 	prop = RNA_def_property(srna, "handle_align", PROP_FLOAT, PROP_COLOR_GAMMA);
 	RNA_def_property_float_sdna(prop, NULL, "handle_align");
@@ -1364,19 +1372,13 @@ static void rna_def_userdef_theme_spaces_curves(StructRNA *srna, short incl_nurb
 	RNA_def_property_ui_text(prop, "Auto handle selected color", "");
 	RNA_def_property_update(prop, 0, "rna_userdef_update");
 
-	prop = RNA_def_property(srna, "handle_sel_vect", PROP_FLOAT, PROP_COLOR_GAMMA);
-	RNA_def_property_float_sdna(prop, NULL, "handle_sel_vect");
-	RNA_def_property_array(prop, 3);
-	RNA_def_property_ui_text(prop, "Vector handle selected color", "");
-	RNA_def_property_update(prop, 0, "rna_userdef_update");
-
 	prop = RNA_def_property(srna, "handle_sel_align", PROP_FLOAT, PROP_COLOR_GAMMA);
 	RNA_def_property_float_sdna(prop, NULL, "handle_sel_align");
 	RNA_def_property_array(prop, 3);
 	RNA_def_property_ui_text(prop, "Align handle selected color", "");
 	RNA_def_property_update(prop, 0, "rna_userdef_update");
 	
-	if (incl_nurbs == 0) {
+	if (incl_nurbs == false) {
 		/* assume that when nurbs are off, this is for 2D (i.e. anim) editors */
 		prop = RNA_def_property(srna, "handle_auto_clamped", PROP_FLOAT, PROP_COLOR_GAMMA);
 		RNA_def_property_float_sdna(prop, NULL, "handle_auto_clamped");
@@ -1391,11 +1393,13 @@ static void rna_def_userdef_theme_spaces_curves(StructRNA *srna, short incl_nurb
 		RNA_def_property_update(prop, 0, "rna_userdef_update");
 	}
 
-	prop = RNA_def_property(srna, "lastsel_point", PROP_FLOAT, PROP_COLOR_GAMMA);
-	RNA_def_property_float_sdna(prop, NULL, "lastsel_point");
-	RNA_def_property_array(prop, 3);
-	RNA_def_property_ui_text(prop, "Last selected point", "");
-	RNA_def_property_update(prop, 0, "rna_userdef_update");
+	if (incl_lastsel) {
+		prop = RNA_def_property(srna, "lastsel_point", PROP_FLOAT, PROP_COLOR_GAMMA);
+		RNA_def_property_float_sdna(prop, NULL, "lastsel_point");
+		RNA_def_property_array(prop, 3);
+		RNA_def_property_ui_text(prop, "Last selected point", "");
+		RNA_def_property_update(prop, 0, "rna_userdef_update");
+	}
 }
 
 static void rna_def_userdef_theme_space_view3d(BlenderRNA *brna)
@@ -1484,7 +1488,7 @@ static void rna_def_userdef_theme_space_view3d(BlenderRNA *brna)
 	rna_def_userdef_theme_spaces_vertex(srna);
 	rna_def_userdef_theme_spaces_edge(srna);
 	rna_def_userdef_theme_spaces_face(srna);
-	rna_def_userdef_theme_spaces_curves(srna, 1);
+	rna_def_userdef_theme_spaces_curves(srna, true, true, true);
 
 	prop = RNA_def_property(srna, "extra_edge_len", PROP_FLOAT, PROP_COLOR_GAMMA);
 	RNA_def_property_array(prop, 3);
@@ -1628,7 +1632,7 @@ static void rna_def_userdef_theme_space_graph(BlenderRNA *brna)
 	RNA_def_property_update(prop, 0, "rna_userdef_update");
 	
 	rna_def_userdef_theme_spaces_vertex(srna);
-	rna_def_userdef_theme_spaces_curves(srna, 0);
+	rna_def_userdef_theme_spaces_curves(srna, false, true, true);
 	
 	prop = RNA_def_property(srna, "handle_vertex", PROP_FLOAT, PROP_COLOR_GAMMA);
 	RNA_def_property_array(prop, 3);
@@ -2247,6 +2251,8 @@ static void rna_def_userdef_theme_space_image(BlenderRNA *brna)
 	RNA_def_property_array(prop, 4);
 	RNA_def_property_ui_text(prop, "Other Object UVs", "");
 	RNA_def_property_update(prop, 0, "rna_userdef_update");
+
+	rna_def_userdef_theme_spaces_curves(srna, false, false, false);
 }
 
 static void rna_def_userdef_theme_space_seq(BlenderRNA *brna)
@@ -2759,6 +2765,8 @@ static void rna_def_userdef_theme_space_clip(BlenderRNA *brna)
 	RNA_def_property_array(prop, 3);
 	RNA_def_property_ui_text(prop, "Strips Selected", "");
 	RNA_def_property_update(prop, 0, "rna_userdef_update");
+
+	rna_def_userdef_theme_spaces_curves(srna, false, false, false);
 }
 
 static void rna_def_userdef_themes(BlenderRNA *brna)