From 2e4d0e91bf92fb9b6f7c8382dcbcd763a89ca9f1 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sat, 22 Aug 2009 13:59:14 +0000 Subject: [PATCH] Document wxGraphicsPath::AddArc() better. The angles passed to it are measured clockwise from the horizontal axis, contrary to the usual mathematical convention so take care to mention this in the documentation. Closes #11112. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61732 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/graphics.h | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/interface/wx/graphics.h b/interface/wx/graphics.h index 6bea40c644..10c2ea7485 100644 --- a/interface/wx/graphics.h +++ b/interface/wx/graphics.h @@ -22,18 +22,24 @@ class wxGraphicsPath : public wxGraphicsObject { public: /** - Adds an arc of a circle centering at (@a x,@a y) with radius (@a r) - from @a startAngle to @a endAngle. + Adds an arc of a circle. + + The circle is defined by the coordinates of its centre (@a x, @a y) or + @a c and its radius @a r. The arc goes from the starting angle @a + startAngle to @a endAngle either clockwise or counter-clockwise + depending on the value of @a clockwise argument. + + The angles are measured in radians but, contrary to the usual + mathematical convention, are always @e clockwise from the horizontal + axis. */ + //@{ virtual void AddArc(wxDouble x, wxDouble y, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise); - /** - Adds an arc of a circle centering at @a c with radius (@a r) - from @a startAngle to @a endAngle. - */ void AddArc(const wxPoint2DDouble& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise); + //@} /** Appends a an arc to two tangents connecting (current) to (@a x1,@a y1) -- 2.45.2