Mask primitives

Currently only circle and square, might be easily
extended in the future.

New primitives are creating at cursor location.
This also implied adding 2d cursor to space clip.

Also fix set 2D cursor location which didn't work
in image editor's mask mode since 2.67.

TODO: draw_image_cursor better be moved to some
      more generic file, but it's not so much
      important for now and might be solved later.

Thanks Campbell for the review!

4 files changed, 218 insertions, 0 deletions

diff --git a/source/blender/editors/mask/mask_add.c b/source/blender/editors/mask/mask_add.c
index 9c270144a0a..4cc9d3b59b1 100644
--- a/source/blender/editors/mask/mask_add.c
+++ b/source/blender/editors/mask/mask_add.c
@@ -737,3 +737,159 @@ void MASK_OT_add_feather_vertex(wmOperatorType *ot)
 	RNA_def_float_vector(ot->srna, "location", 2, NULL, -FLT_MAX, FLT_MAX,
 	                     "Location", "Location of vertex in normalized space", -1.0f, 1.0f);
 }
+
+/******************** common primitive functions *********************/
+
+static int create_primitive_from_points(bContext *C, wmOperator *op, const float (*points)[2],
+                                        int num_points, char handle_type)
+{
+	ScrArea *sa = CTX_wm_area(C);
+	Scene *scene = CTX_data_scene(C);
+	Mask *mask;
+	MaskLayer *mask_layer;
+	MaskSpline *new_spline;
+	float scale, location[2], frame_size[2];
+	int i, width, height;
+	int size = RNA_float_get(op->ptr, "size");
+
+	ED_mask_get_size(sa, &width, &height);
+	scale = (float)size / max_ii(width, height);
+
+	/* Get location in mask space. */
+	frame_size[0] = width;
+	frame_size[1] = height;
+	RNA_float_get_array(op->ptr, "location", location);
+	location[0] /= width;
+	location[1] /= height;
+	BKE_mask_coord_from_frame(location, location, frame_size);
+
+	/* Make it so new primitive is centered to mouse location. */
+	location[0] -= 0.5f * scale;
+	location[1] -= 0.5f * scale;
+
+	mask_layer = ED_mask_layer_ensure(C);
+	mask = CTX_data_edit_mask(C);
+
+	ED_mask_select_toggle_all(mask, SEL_DESELECT);
+
+	new_spline = BKE_mask_spline_add(mask_layer);
+	new_spline->flag = MASK_SPLINE_CYCLIC | SELECT;
+	new_spline->tot_point = num_points;
+	new_spline->points = MEM_recallocN(new_spline->points,
+	                                   sizeof(MaskSplinePoint) * new_spline->tot_point);
+
+	mask_layer->act_spline = new_spline;
+	mask_layer->act_point = NULL;
+
+	for (i = 0; i < num_points; i++) {
+		MaskSplinePoint *new_point = &new_spline->points[i];
+
+		copy_v2_v2(new_point->bezt.vec[1], points[i]);
+		mul_v2_fl(new_point->bezt.vec[1], scale);
+		add_v2_v2(new_point->bezt.vec[1], location);
+
+		new_point->bezt.h1 = handle_type;
+		new_point->bezt.h2 = handle_type;
+		BKE_mask_point_select_set(new_point, true);
+	}
+
+	WM_event_add_notifier(C, NC_MASK | NA_EDITED, mask);
+
+	/* TODO: only update this spline */
+	BKE_mask_update_display(mask, CFRA);
+
+	return OPERATOR_FINISHED;
+}
+
+static int primitive_add_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
+{
+	ScrArea *sa = CTX_wm_area(C);
+	float cursor[2];
+	int width, height;
+
+	ED_mask_get_size(sa, &width, &height);
+	ED_mask_cursor_location_get(sa, cursor);
+
+	cursor[0] *= width;
+	cursor[1] *= height;
+
+	RNA_float_set_array(op->ptr, "location", cursor);
+
+	return op->type->exec(C, op);
+}
+
+static void define_prinitive_add_properties(wmOperatorType *ot)
+{
+	RNA_def_float(ot->srna, "size", 100, -FLT_MAX, FLT_MAX,
+	                     "Size", "Size of new circle", -FLT_MAX, FLT_MAX);
+	RNA_def_float_vector(ot->srna, "location", 2, NULL, -FLT_MAX, FLT_MAX,
+	                     "Location", "Location of new circle", -FLT_MAX, FLT_MAX);
+}
+
+/******************** primitive add circle *********************/
+
+static int primitive_circle_add_exec(bContext *C, wmOperator *op)
+{
+	const float points[4][2] = {{0.0f, 0.5f},
+	                            {0.5f, 1.0f},
+	                            {1.0f, 0.5f},
+	                            {0.5f, 0.0f}};
+	int num_points = sizeof(points) / (2 * sizeof(float));
+
+	create_primitive_from_points(C, op, points, num_points, HD_AUTO);
+
+	return OPERATOR_FINISHED;
+}
+
+void MASK_OT_primitive_circle_add(wmOperatorType *ot)
+{
+	/* identifiers */
+	ot->name = "Add Circle";
+	ot->description = "Add new circle-shaped spline";
+	ot->idname = "MASK_OT_primitive_circle_add";
+
+	/* api callbacks */
+	ot->exec = primitive_circle_add_exec;
+	ot->invoke = primitive_add_invoke;
+	ot->poll = ED_operator_mask;
+
+	/* flags */
+	ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
+
+	/* properties */
+	define_prinitive_add_properties(ot);
+}
+
+/******************** primitive add suqare *********************/
+
+static int primitive_square_add_exec(bContext *C, wmOperator *op)
+{
+	const float points[4][2] = {{0.0f, 0.0f},
+	                            {0.0f, 1.0f},
+	                            {1.0f, 1.0f},
+	                            {1.0f, 0.0f}};
+	int num_points = sizeof(points) / (2 * sizeof(float));
+
+	create_primitive_from_points(C, op, points, num_points, HD_VECT);
+
+	return OPERATOR_FINISHED;
+}
+
+void MASK_OT_primitive_square_add(wmOperatorType *ot)
+{
+	/* identifiers */
+	ot->name = "Add Square";
+	ot->description = "Add new square-shaped spline";
+	ot->idname = "MASK_OT_primitive_square_add";
+
+	/* api callbacks */
+	ot->exec = primitive_square_add_exec;
+	ot->invoke = primitive_add_invoke;
+	ot->poll = ED_operator_mask;
+
+	/* flags */
+	ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
+
+	/* properties */
+	define_prinitive_add_properties(ot);
+}
diff --git a/source/blender/editors/mask/mask_edit.c b/source/blender/editors/mask/mask_edit.c
index 96cb2d7ccc3..62eb9cc240a 100644
--- a/source/blender/editors/mask/mask_edit.c
+++ b/source/blender/editors/mask/mask_edit.c
@@ -363,6 +363,40 @@ void ED_mask_pixelspace_factor(ScrArea *sa, ARegion *ar, float *scalex, float *s
 	}
 }
 
+void ED_mask_cursor_location_get(ScrArea *sa, float cursor[2])
+{
+	if (sa) {
+		switch (sa->spacetype) {
+			case SPACE_CLIP:
+			{
+				SpaceClip *space_clip = sa->spacedata.first;
+				copy_v2_v2(cursor, space_clip->cursor);
+				break;
+			}
+			case SPACE_SEQ:
+			{
+				zero_v2(cursor);
+				break;
+			}
+			case SPACE_IMAGE:
+			{
+				SpaceImage *space_image = sa->spacedata.first;
+				copy_v2_v2(cursor, space_image->cursor);
+				break;
+			}
+			default:
+				/* possible other spaces from which mask editing is available */
+				BLI_assert(0);
+				zero_v2(cursor);
+				break;
+		}
+	}
+	else {
+		BLI_assert(0);
+		zero_v2(cursor);
+	}
+}
+
 /********************** registration *********************/
 
 void ED_operatortypes_mask(void)
@@ -376,6 +410,8 @@ void ED_operatortypes_mask(void)
 	/* add */
 	WM_operatortype_append(MASK_OT_add_vertex);
 	WM_operatortype_append(MASK_OT_add_feather_vertex);
+	WM_operatortype_append(MASK_OT_primitive_circle_add);
+	WM_operatortype_append(MASK_OT_primitive_square_add);
 
 	/* geometry */
 	WM_operatortype_append(MASK_OT_switch_direction);
@@ -432,6 +468,9 @@ void ED_keymap_mask(wmKeyConfig *keyconf)
 
 	WM_keymap_add_item(keymap, "MASK_OT_new", NKEY, KM_PRESS, KM_ALT, 0);
 
+	/* add menu */
+	WM_keymap_add_menu(keymap, "MASK_MT_add", AKEY, KM_PRESS, KM_SHIFT, 0);
+
 	/* mask mode supports PET now */
 	ED_keymap_proportional_cycle(keyconf, keymap);
 	ED_keymap_proportional_maskmode(keyconf, keymap);
diff --git a/source/blender/editors/mask/mask_intern.h b/source/blender/editors/mask/mask_intern.h
index 9374d970696..51705aa5837 100644
--- a/source/blender/editors/mask/mask_intern.h
+++ b/source/blender/editors/mask/mask_intern.h
@@ -42,9 +42,12 @@ struct wmOperatorType;
 /* mask_add.c */
 void MASK_OT_add_vertex(struct wmOperatorType *ot);
 void MASK_OT_add_feather_vertex(struct wmOperatorType *ot);
+void MASK_OT_primitive_circle_add(struct wmOperatorType *ot);
+void MASK_OT_primitive_square_add(struct wmOperatorType *ot);
 
 /* mask_ops.c */
 struct Mask *ED_mask_new(struct bContext *C, const char *name);
+struct MaskLayer *ED_mask_layer_ensure(struct bContext *C);
 
 void MASK_OT_new(struct wmOperatorType *ot);
 void MASK_OT_layer_new(struct wmOperatorType *ot);
diff --git a/source/blender/editors/mask/mask_ops.c b/source/blender/editors/mask/mask_ops.c
index 3ae7fd67d8a..5ca0d133b0e 100644
--- a/source/blender/editors/mask/mask_ops.c
+++ b/source/blender/editors/mask/mask_ops.c
@@ -292,6 +292,26 @@ Mask *ED_mask_new(bContext *C, const char *name)
 	return mask;
 }
 
+/* Get ative layer. Will create mask/layer to be sure there's an active layer.  */
+MaskLayer *ED_mask_layer_ensure(bContext *C)
+{
+	Mask *mask = CTX_data_edit_mask(C);
+	MaskLayer *mask_layer;
+
+	if (mask == NULL) {
+		/* If there's no active mask, create one. */
+		mask = ED_mask_new(C, NULL);
+	}
+
+	mask_layer = BKE_mask_layer_active(mask);
+	if (mask_layer == NULL) {
+		/* If there's no active mask layer, create one. */
+		mask_layer = BKE_mask_layer_new(mask, "");
+	}
+
+	return mask_layer;
+}
+
 static int mask_new_exec(bContext *C, wmOperator *op)
 {
 	char name[MAX_ID_NAME - 2];