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
This commit is contained in:
Vadim Zeitlin
2009-08-22 13:59:14 +00:00
parent 7a91ad2cee
commit 2e4d0e91bf

View File

@@ -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)