Clipping for plot area + style parameter plot.overflow.

simzer · simzer · commit e49826f58c21 · 2021-10-06T15:30:34.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 
+- Parts of markers outside of plot area are getting clipped. This behaviour can 
+  be controlled by style.plot.overflow parameter.
+
 ## [0.3.1] - 2021-09-24
 
 ### Fixed
diff --git a/src/apps/qutils/canvas.cpp b/src/apps/qutils/canvas.cpp
@@ -186,6 +186,13 @@ void BaseCanvas::setClipRect(const Geom::Rect &rect)
 	painter.setClipRect(toQRect(rect));
 }
 
+void BaseCanvas::setClipCircle(const Geom::Circle &circle)
+{
+	QPainterPath path;
+	path.addEllipse(toQRect(circle.boundary()));
+	painter.setClipPath(path);
+}
+
 void BaseCanvas::setClipPolygon() {
 	painter.setClipping(true);
 	painter.setClipPath(polygon);
diff --git a/src/apps/qutils/canvas.h b/src/apps/qutils/canvas.h
@@ -28,6 +28,7 @@ class BaseCanvas :
 
 	Geom::Rect getClipRect() const override;
 	void setClipRect(const Geom::Rect &rect) override;
+	void setClipCircle(const Geom::Circle &circle) override;
 	void setClipPolygon() override;
 	void setBrushColor(const Gfx::Color &color) override;
 	void setLineColor(const Gfx::Color &color) override;
diff --git a/src/apps/weblib/interface.js b/src/apps/weblib/interface.js
@@ -20,8 +20,15 @@ mergeInto(LibraryManager.library, {
 		dc.rect(x, y, sizex, sizey);
 		dc.clip();
 	},
+	canvas_setClipCircle: function(x, y, radius) {
+		var dc = Module.render.dc();
+		dc.beginPath();
+		dc.arc(x, y, radius, 0, 6.28318530718);
+		dc.clip();
+	},
 	canvas_setClipPolygon: function() {
 		var dc = Module.render.dc();
+		dc.closePath();
 		dc.clip();
 		Module.render.endPolygonNotification();
 	},
@@ -98,7 +105,7 @@ mergeInto(LibraryManager.library, {
 	canvas_circle: function(x, y, radius) {
 		var dc = Module.render.dc();
 		dc.beginPath();
-		dc.arc(x, y, radius, 0, 6.283);
+		dc.arc(x, y, radius, 0, 6.28318530718);
 		dc.fill();
 		if (Module.render.noneZeroLineWidth())
 			dc.stroke();
diff --git a/src/apps/weblib/js-api/vizzu.d.ts b/src/apps/weblib/js-api/vizzu.d.ts
@@ -443,6 +443,9 @@ interface Plot extends Padding, Box {
 	xAxis?: Axis|null;
 	/** Style settings for the y-axis - or the radius when using polar coordinates. */
 	yAxis?: Axis|null;
+	/** Controls drawing outside of the plot area. If hidden, clipping will be
+	    set for the boundary of the coordinate system. */
+	overflow?: 'hidden'|'visible';
 }
 
 interface LegendMarker {
diff --git a/src/apps/weblib/jscriptcanvas.cpp b/src/apps/weblib/jscriptcanvas.cpp
@@ -18,6 +18,7 @@ struct CanvasRuntime : public ElapsedTime<CanvasRuntime> {
 extern "C" {
     extern void canvas_textBoundary(const char*, double*, double*);
     extern void canvas_setClipRect(double, double, double, double);
+	extern void canvas_setClipCircle(double, double, double);
 	extern void canvas_setClipPolygon();
     extern void canvas_setBrushColor(double, double, double, double);
     extern void canvas_setLineColor(double, double, double, double);
@@ -82,6 +83,13 @@ void JScriptOutputCanvas::setClipRect(const Geom::Rect &rect)
 	}
 }
 
+void JScriptOutputCanvas::setClipCircle(const Geom::Circle &circle)
+{
+	_measure_runtime(CanvasRuntime);
+	clipRect = circle.boundary();
+	::canvas_setClipCircle(circle.center.x, circle.center.y, circle.radius);
+}
+
 void JScriptOutputCanvas::setClipPolygon() {
 	_measure_runtime(CanvasRuntime);
 	::canvas_setClipPolygon();
diff --git a/src/apps/weblib/jscriptcanvas.h b/src/apps/weblib/jscriptcanvas.h
@@ -24,6 +24,7 @@ class JScriptOutputCanvas : public Gfx::ICanvas
 
 	Geom::Rect getClipRect() const override;
 	void setClipRect(const Geom::Rect &rect) override;
+	void setClipCircle(const Geom::Circle &circle) override;
 	void setClipPolygon() override;
 	void setBrushColor(const Gfx::Color &color) override;
 	void setLineColor(const Gfx::Color &color) override;
diff --git a/src/base/gfx/canvas.h b/src/base/gfx/canvas.h
@@ -35,6 +35,7 @@ struct ICanvas
 	virtual Geom::Size textBoundary(const std::string &string) = 0;
 	virtual Geom::Rect getClipRect() const = 0;
 	virtual void setClipRect(const Geom::Rect &rect) = 0;
+	virtual void setClipCircle(const Geom::Circle &circle) = 0;
 	virtual void setClipPolygon() = 0;
 	virtual void setBrushColor(const Gfx::Color &color) = 0;
 	virtual void setLineColor(const Gfx::Color &color) = 0;
diff --git a/src/base/gfx/nullcanvas.h b/src/base/gfx/nullcanvas.h
@@ -16,6 +16,7 @@ struct NullCanvas : public ICanvas
 
 	Geom::Rect getClipRect() const override { return Geom::Rect(); }
 	void setClipRect(const Geom::Rect &) override {}
+	void setClipCircle(const Geom::Circle &) override {}
 	void setClipPolygon() override {}
 	void setBrushColor(const Color &) override {}
 	void setLineColor(const Color &) override {}
diff --git a/src/chart/main/style.cpp b/src/chart/main/style.cpp
@@ -277,7 +277,9 @@ Chart Chart::def()
 				.interlacing = {
 					.color = Gfx::Color::Gray(0.97)
 				}
-			}
+			},
+			.overflow = ::Anim::Interpolated<Overflow>
+				(Overflow::hidden)
 		},
 		.legend = {
 			{
diff --git a/src/chart/main/style.h b/src/chart/main/style.h
@@ -432,6 +432,7 @@ struct Plot : Padding, Box
 	Marker marker;
 	Axis xAxis;
 	Axis yAxis;
+	Param<Anim::Interpolated<Overflow>> overflow;
 
 	const Axis &getAxis(Diag::ScaleId id) const {
 		return id == Diag::ScaleId::x ? xAxis : yAxis;
@@ -444,7 +445,8 @@ struct Plot : Padding, Box
 		visitor
 			(marker, "marker")
 			(xAxis, "xAxis")
-			(yAxis, "yAxis");
+			(yAxis, "yAxis")
+			(overflow, "overflow");
 	}
 };
 
diff --git a/src/chart/rendering/drawdiagram.cpp b/src/chart/rendering/drawdiagram.cpp
@@ -27,12 +27,33 @@ drawDiagram::drawDiagram(const Geom::Rect &rect,
 		drawBackground(rect, canvas, style.plot, events.plot.background);
 
 		drawAxes(*this, guides).drawBase();
+	}
+
+	auto clip = style.plot.overflow == Styles::Overflow::hidden;
+
+	if (clip)
+	{
+		canvas.save();
+		
+		std::array<Geom::Point, 4> points =
+		{
+			Geom::Point(0.0, 0.0), 
+			Geom::Point(0.0, 1.0), 
+			Geom::Point(1.0, 1.0), 
+			Geom::Point(1.0, 0.0) 
+		};
+		painter.drawPolygon(points, true);
+	}
 
+	if (!drawOptions.onlyEssentials())
+	{
 		drawMarkerGuides();
 	}
 
 	drawMarkers();
 
+	if (clip) canvas.restore();
+
 	if (!drawOptions.onlyEssentials())
 	{
 		drawMarkerLabels();
diff --git a/src/chart/rendering/painter/adaptivepainter.cpp b/src/chart/rendering/painter/adaptivepainter.cpp
@@ -28,10 +28,12 @@ void AdaptivePainter::drawStraightLine(const Geom::Line &line,
 	Draw::drawLine(line, widths, endColor, lineColor, system, getCanvas());
 }
 
-void AdaptivePainter::drawPolygon(const std::array<Geom::Point, 4> &ps)
+void AdaptivePainter::drawPolygon(
+	const std::array<Geom::Point, 4> &ps, 
+	bool clip)
 {
 	Draw::drawPolygon::Options options(system);
 	options.circ = polygonOptions.toCircleFactor;
 	options.linear = polygonOptions.straightFactor;
-	Draw::drawPolygon(ps, options, getCanvas());
+	Draw::drawPolygon(ps, options, getCanvas(), clip);
 }
diff --git a/src/chart/rendering/painter/adaptivepainter.h b/src/chart/rendering/painter/adaptivepainter.h
@@ -28,7 +28,7 @@ class AdaptivePainter : public IPainter
 	void setPolygonToCircleFactor(double factor) override { polygonOptions.toCircleFactor = factor; }
 	void setPolygonStraightFactor(double factor) override { polygonOptions.straightFactor = factor; }
 
-	void drawPolygon(const std::array<Geom::Point, 4> &ps) override;
+	void drawPolygon(const std::array<Geom::Point, 4> &ps, bool clip) override;
 
 private:
 	struct PolygonOptions {
diff --git a/src/chart/rendering/painter/drawpolygon.cpp b/src/chart/rendering/painter/drawpolygon.cpp
@@ -11,7 +11,11 @@ using namespace Gfx;
 using namespace Vizzu;
 using namespace Vizzu::Draw;
 
-drawPolygon::drawPolygon(const std::array<Point, 4> &ps, const Options &options, ICanvas &canvas)
+drawPolygon::drawPolygon(
+	const std::array<Point, 4> &ps, 
+	const Options &options, 
+	ICanvas &canvas,
+	bool clip)
 {
 	center = Math::mean(ps);
 	boundary = Rect::Boundary(ps).size;
@@ -25,7 +29,9 @@ drawPolygon::drawPolygon(const std::array<Point, 4> &ps, const Options &options,
 	{
 		auto centerConv = options.coordSys.convert(center);
 		auto radius = fabs(linSize.x) / 2.0;
-		canvas.circle(Geom::Circle(centerConv,radius));
+		Geom::Circle circle(centerConv,radius);
+		if (clip) canvas.setClipCircle(circle);
+		else canvas.circle(circle);
 	}
 	else
 	{
@@ -36,7 +42,8 @@ drawPolygon::drawPolygon(const std::array<Point, 4> &ps, const Options &options,
 		Path(ps[2], ps[3], center, linSize, canvas, options).calc();
 		Path(ps[3], ps[0], center, linSize, canvas, options).calc();
 
-		canvas.endPolygon();
+		if (clip) canvas.setClipPolygon();
+		else canvas.endPolygon();
 	}
 }
 
diff --git a/src/chart/rendering/painter/drawpolygon.h b/src/chart/rendering/painter/drawpolygon.h
@@ -32,7 +32,8 @@ class drawPolygon
 
 	drawPolygon(const std::array<Geom::Point, 4> &ps,
 				const Options &options,
-				Gfx::ICanvas &canvas);
+				Gfx::ICanvas &canvas,
+				bool clip);
 
 private:
 
diff --git a/src/chart/rendering/painter/painter.h b/src/chart/rendering/painter/painter.h
@@ -34,7 +34,9 @@ class IPainter
 	virtual void setPolygonToCircleFactor(double factor) = 0;
 	virtual void setPolygonStraightFactor(double factor) = 0;
 
-	virtual void drawPolygon(const std::array<Geom::Point, 4> &ps) = 0;
+	virtual void drawPolygon(
+		const std::array<Geom::Point, 4> &ps,
+		bool clip = false) = 0;
 };
 
 }
diff --git a/test/integration/test_cases.json b/test/integration/test_cases.json

Original file line number	Diff line number	Diff line change
`@@ -443,6 +443,9 @@ interface Plot extends Padding, Box {`
`443`	`443`	`xAxis?: Axis\|null;`
`444`	`444`	`/** Style settings for the y-axis - or the radius when using polar coordinates. */`
`445`	`445`	`yAxis?: Axis\|null;`
	`446`	`+ /** Controls drawing outside of the plot area. If hidden, clipping will be`
	`447`	`+ set for the boundary of the coordinate system. */`
	`448`	`+ overflow?: 'hidden'\|'visible';`
`446`	`449`	`}`
`447`	`450`
`448`	`451`	`interface LegendMarker {`
Original file line number	Diff line number	Diff line change
`@@ -277,7 +277,9 @@ Chart Chart::def()`
`277`	`277`	`.interlacing = {`
`278`	`278`	`.color = Gfx::Color::Gray(0.97)`
`279`	`279`	`}`
`280`		`- }`
	`280`	`+ },`
	`281`	`+ .overflow = ::Anim::Interpolated<Overflow>`
	`282`	`+ (Overflow::hidden)`
`281`	`283`	`},`
`282`	`284`	`.legend = {`
`283`	`285`	`{`