1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
|
.TH "QwtPointPolar" 3 "Thu Dec 11 2014" "Version 6.1.2" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtPointPolar \-
.PP
A point in polar coordinates\&.
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_point_polar\&.h>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBQwtPointPolar\fP ()"
.br
.ti -1c
.RI "\fBQwtPointPolar\fP (double \fBazimuth\fP, double \fBradius\fP)"
.br
.ti -1c
.RI "\fBQwtPointPolar\fP (const \fBQwtPointPolar\fP &)"
.br
.ti -1c
.RI "\fBQwtPointPolar\fP (const QPointF &)"
.br
.ti -1c
.RI "void \fBsetPoint\fP (const QPointF &)"
.br
.ti -1c
.RI "QPointF \fBtoPoint\fP () const "
.br
.ti -1c
.RI "bool \fBisValid\fP () const "
.br
.RI "\fIReturns true if \fBradius()\fP >= 0\&.0\&. \fP"
.ti -1c
.RI "bool \fBisNull\fP () const "
.br
.RI "\fIReturns true if \fBradius()\fP >= 0\&.0\&. \fP"
.ti -1c
.RI "double \fBradius\fP () const "
.br
.RI "\fIReturns the radius\&. \fP"
.ti -1c
.RI "double \fBazimuth\fP () const "
.br
.RI "\fIReturns the azimuth\&. \fP"
.ti -1c
.RI "double & \fBrRadius\fP ()"
.br
.RI "\fIReturns the radius\&. \fP"
.ti -1c
.RI "double & \fBrAzimuth\fP ()"
.br
.RI "\fIReturns the azimuth\&. \fP"
.ti -1c
.RI "void \fBsetRadius\fP (double)"
.br
.RI "\fISets the radius to radius\&. \fP"
.ti -1c
.RI "void \fBsetAzimuth\fP (double)"
.br
.RI "\fISets the atimuth to atimuth\&. \fP"
.ti -1c
.RI "bool \fBoperator==\fP (const \fBQwtPointPolar\fP &) const "
.br
.RI "\fICompare 2 points\&. \fP"
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBQwtPointPolar\fP &) const "
.br
.ti -1c
.RI "\fBQwtPointPolar\fP \fBnormalized\fP () const "
.br
.in -1c
.SH "Detailed Description"
.PP
A point in polar coordinates\&.
In polar coordinates a point is determined by an angle and a distance\&. See http://en.wikipedia.org/wiki/Polar_coordinate_system
.SH "Constructor & Destructor Documentation"
.PP
.SS "QwtPointPolar::QwtPointPolar ()\fC [inline]\fP"
Constructs a null point, with a radius and azimuth set to 0\&.0\&.
.PP
\fBSee Also:\fP
.RS 4
QPointF::isNull()
.RE
.PP
.SS "QwtPointPolar::QwtPointPolar (doubleazimuth, doubleradius)\fC [inline]\fP"
Constructs a point with coordinates specified by radius and azimuth\&.
.PP
\fBParameters:\fP
.RS 4
\fIazimuth\fP Azimuth
.br
\fIradius\fP Radius
.RE
.PP
.SS "QwtPointPolar::QwtPointPolar (const \fBQwtPointPolar\fP &other)\fC [inline]\fP"
Constructs a point using the values of the point specified\&.
.PP
\fBParameters:\fP
.RS 4
\fIother\fP Other point
.RE
.PP
.SS "QwtPointPolar::QwtPointPolar (const QPointF &p)"
Convert and assign values from a point in Cartesian coordinates
.PP
\fBParameters:\fP
.RS 4
\fIp\fP Point in Cartesian coordinates
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetPoint()\fP, \fBtoPoint()\fP
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "\fBQwtPointPolar\fP QwtPointPolar::normalized () const"
Normalize radius and azimuth
.PP
When the radius is < 0\&.0 it is set to 0\&.0\&. The azimuth is a value >= 0\&.0 and < 2 * M_PI\&.
.PP
\fBReturns:\fP
.RS 4
Normalized point
.RE
.PP
.SS "bool QwtPointPolar::operator!= (const \fBQwtPointPolar\fP &other) const"
Compare 2 points
.PP
Two points are equal to each other if radius and azimuth-coordinates are the same\&. Points are not equal, when the azimuth differs, but other\&.azimuth() == \fBazimuth()\fP % (2 * PI)\&.
.PP
\fBReturns:\fP
.RS 4
True if the point is not equal to other; otherwise return false\&.
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBnormalized()\fP
.RE
.PP
.SS "bool QwtPointPolar::operator== (const \fBQwtPointPolar\fP &other) const"
.PP
Compare 2 points\&. Two points are equal to each other if radius and azimuth-coordinates are the same\&. Points are not equal, when the azimuth differs, but other\&.azimuth() == \fBazimuth()\fP % (2 * PI)\&.
.PP
\fBReturns:\fP
.RS 4
True if the point is equal to other; otherwise return false\&.
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBnormalized()\fP
.RE
.PP
.SS "void QwtPointPolar::setPoint (const QPointF &p)"
Convert and assign values from a point in Cartesian coordinates
.PP
\fBParameters:\fP
.RS 4
\fIp\fP Point in Cartesian coordinates
.RE
.PP
.SS "QPointF QwtPointPolar::toPoint () const"
Convert and return values in Cartesian coordinates
.PP
\fBReturns:\fP
.RS 4
Converted point in Cartesian coordinates
.RE
.PP
\fBNote:\fP
.RS 4
Invalid or null points will be returned as QPointF(0\&.0, 0\&.0)
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBisValid()\fP, \fBisNull()\fP
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.
|