summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/qpoint.3qt
blob: 1d6413f7fee8ee759c49622f34135359bc2828c2 (plain)
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
'\" t
.TH QPoint 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QPoint \- Defines a point in the plane
.SH SYNOPSIS
\fC#include <ntqpoint.h>\fR
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQPoint\fR ()"
.br
.ti -1c
.BI "\fBQPoint\fR ( int xpos, int ypos )"
.br
.ti -1c
.BI "bool \fBisNull\fR () const"
.br
.ti -1c
.BI "int \fBx\fR () const"
.br
.ti -1c
.BI "int \fBy\fR () const"
.br
.ti -1c
.BI "void \fBsetX\fR ( int x )"
.br
.ti -1c
.BI "void \fBsetY\fR ( int y )"
.br
.ti -1c
.BI "int \fBmanhattanLength\fR () const"
.br
.ti -1c
.BI "QCOORD & \fBrx\fR ()"
.br
.ti -1c
.BI "QCOORD & \fBry\fR ()"
.br
.ti -1c
.BI "QPoint & \fBoperator+=\fR ( const QPoint & p )"
.br
.ti -1c
.BI "QPoint & \fBoperator-=\fR ( const QPoint & p )"
.br
.ti -1c
.BI "QPoint & \fBoperator*=\fR ( int c )"
.br
.ti -1c
.BI "QPoint & \fBoperator*=\fR ( double c )"
.br
.ti -1c
.BI "QPoint & \fBoperator/=\fR ( int c )"
.br
.ti -1c
.BI "QPoint & \fBoperator/=\fR ( double c )"
.br
.in -1c
.SH RELATED FUNCTION DOCUMENTATION
.in +1c
.ti -1c
.BI "bool \fBoperator==\fR ( const QPoint & p1, const QPoint & p2 )"
.br
.ti -1c
.BI "bool \fBoperator!=\fR ( const QPoint & p1, const QPoint & p2 )"
.br
.ti -1c
.BI "const QPoint \fBoperator+\fR ( const QPoint & p1, const QPoint & p2 )"
.br
.ti -1c
.BI "const QPoint \fBoperator-\fR ( const QPoint & p1, const QPoint & p2 )"
.br
.ti -1c
.BI "const QPoint \fBoperator*\fR ( const QPoint & p, int c )"
.br
.ti -1c
.BI "const QPoint \fBoperator*\fR ( int c, const QPoint & p )"
.br
.ti -1c
.BI "const QPoint \fBoperator*\fR ( const QPoint & p, double c )"
.br
.ti -1c
.BI "const QPoint \fBoperator*\fR ( double c, const QPoint & p )"
.br
.ti -1c
.BI "const QPoint \fBoperator-\fR ( const QPoint & p )"
.br
.ti -1c
.BI "const QPoint \fBoperator/\fR ( const QPoint & p, int c )"
.br
.ti -1c
.BI "const QPoint \fBoperator/\fR ( const QPoint & p, double c )"
.br
.ti -1c
.BI "QDataStream & \fBoperator<<\fR ( QDataStream & s, const QPoint & p )"
.br
.ti -1c
.BI "QDataStream & \fBoperator>>\fR ( QDataStream & s, QPoint & p )"
.br
.in -1c
.SH DESCRIPTION
The QPoint class defines a point in the plane.
.PP
A point is specified by an x coordinate and a y coordinate.
.PP
The coordinate type is \fCQCOORD\fR (a 32-bit integer). The minimum value of \fCQCOORD\fR is \fCQCOORD_MIN\fR (-2147483648) and the maximum value is \fCQCOORD_MAX\fR (2147483647).
.PP
The coordinates are accessed by the functions x() and y(); they can be set by setX() and setY() or by the reference functions rx() and ry().
.PP
Given a point \fIp\fR, the following statements are all equivalent:
.PP
.nf
.br
        p.setX( p.x() + 1 );
.br
        p += QPoint( 1, 0 );
.br
        p.rx()++;
.br
.fi
.PP
A QPoint can also be used as a vector. Addition and subtraction of QPoints are defined as for vectors (each component is added separately). You can divide or multiply a QPoint by an \fCint\fR or a \fCdouble\fR. The function manhattanLength() gives an inexpensive approximation of the length of the QPoint interpreted as a vector.
.PP
Example:
.PP
.nf
.br
        //QPoint oldPos is defined somewhere else
.br
        MyWidget::mouseMoveEvent( QMouseEvent *e )
.br
        {
.br
            QPoint vector = e->pos() - oldPos;
.br
            if ( vector.manhattanLength() > 3 )
.br
            ... //mouse has moved more than 3 pixels since oldPos
.br
        }
.br
.fi
.PP
QPoints can be compared for equality or inequality, and they can be written to and read from a QStream.
.PP
See also QPointArray, QSize, QRect, Graphics Classes, and Image Processing Classes.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QPoint::QPoint ()"
Constructs a point with coordinates (0, 0) (isNull() returns TRUE).
.SH "QPoint::QPoint ( int xpos, int ypos )"
Constructs a point with x value \fIxpos\fR and y value \fIypos\fR.
.SH "bool QPoint::isNull () const"
Returns TRUE if both the x value and the y value are 0; otherwise returns FALSE.
.SH "int QPoint::manhattanLength () const"
Returns the sum of the absolute values of x() and y(), traditionally known as the "Manhattan length" of the vector from the origin to the point. The tradition arises because such distances apply to travelers who can only travel on a rectangular grid, like the streets of Manhattan.
.PP
This is a useful, and tquick to calculate, approximation to the true length: sqrt(pow(x(),2)+pow(y(),2)).
.SH "QPoint & QPoint::operator*= ( int c )"
Multiplies this point's x and y by \fIc\fR, and returns a reference to this point.
.PP
Example:
.PP
.nf
.br
        QPoint p( -1, 4 );
.br
        p *= 2;            // p becomes (-2,8)
.br
.fi
.SH "QPoint & QPoint::operator*= ( double c )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Multiplies this point's x and y by \fIc\fR, and returns a reference to this point.
.PP
Example:
.PP
.nf
.br
        QPoint p( -1, 4 );
.br
        p *= 2.5;          // p becomes (-3,10)
.br
.fi
.PP
Note that the result is truncated because points are held as integers.
.SH "QPoint & QPoint::operator+= ( const QPoint & p )"
Adds point \fIp\fR to this point and returns a reference to this point.
.PP
Example:
.PP
.nf
.br
        QPoint p(  3, 7 );
.br
        QPoint q( -1, 4 );
.br
        p += q;            // p becomes (2,11)
.br
.fi
.SH "QPoint & QPoint::operator-= ( const QPoint & p )"
Subtracts point \fIp\fR from this point and returns a reference to this point.
.PP
Example:
.PP
.nf
.br
        QPoint p(  3, 7 );
.br
        QPoint q( -1, 4 );
.br
        p -= q;            // p becomes (4,3)
.br
.fi
.SH "QPoint & QPoint::operator/= ( int c )"
Divides both x and y by \fIc\fR, and returns a reference to this point.
.PP
Example:
.PP
.nf
.br
        QPoint p( -2, 8 );
.br
        p /= 2;            // p becomes (-1,4)
.br
.fi
.SH "QPoint & QPoint::operator/= ( double c )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Divides both x and y by \fIc\fR, and returns a reference to this point.
.PP
Example:
.PP
.nf
.br
        QPoint p( -3, 10 );
.br
        p /= 2.5;           // p becomes (-1,4)
.br
.fi
.PP
Note that the result is truncated because points are held as integers.
.SH "QCOORD & QPoint::rx ()"
Returns a reference to the x coordinate of the point.
.PP
Using a reference makes it possible to directly manipulate x.
.PP
Example:
.PP
.nf
.br
        QPoint p( 1, 2 );
.br
        p.rx()--;         // p becomes (0, 2)
.br
.fi
.PP
See also ry().
.SH "QCOORD & QPoint::ry ()"
Returns a reference to the y coordinate of the point.
.PP
Using a reference makes it possible to directly manipulate y.
.PP
Example:
.PP
.nf
.br
        QPoint p( 1, 2 );
.br
        p.ry()++;         // p becomes (1, 3)
.br
.fi
.PP
See also rx().
.SH "void QPoint::setX ( int x )"
Sets the x coordinate of the point to \fIx\fR.
.PP
See also x() and setY().
.PP
Example: t14/cannon.cpp.
.SH "void QPoint::setY ( int y )"
Sets the y coordinate of the point to \fIy\fR.
.PP
See also y() and setX().
.PP
Example: t14/cannon.cpp.
.SH "int QPoint::x () const"
Returns the x coordinate of the point.
.PP
See also setX() and y().
.PP
Examples:
.)l canvas/canvas.cpp, chart/canvasview.cpp, dirview/dirview.cpp, fileiconview/qfileiconview.cpp, helpsystem/tooltip.cpp, life/life.cpp, and t14/cannon.cpp.
.SH "int QPoint::y () const"
Returns the y coordinate of the point.
.PP
See also setY() and x().
.PP
Examples:
.)l canvas/canvas.cpp, chart/canvasview.cpp, fileiconview/qfileiconview.cpp, helpsystem/tooltip.cpp, life/life.cpp, t14/cannon.cpp, and themes/wood.cpp.
.SH RELATED FUNCTION DOCUMENTATION
.SH "bool operator!= ( const QPoint & p1, const QPoint & p2 )"
Returns TRUE if \fIp1\fR and \fIp2\fR are not equal; otherwise returns FALSE.
.SH "const QPoint operator* ( const QPoint & p, int c )"
Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR.
.SH "const QPoint operator* ( int c, const QPoint & p )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR.
.SH "const QPoint operator* ( const QPoint & p, double c )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR.
.PP
Note that the result is truncated because points are held as integers.
.SH "const QPoint operator* ( double c, const QPoint & p )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Returns the QPoint formed by multiplying both components of \fIp\fR by \fIc\fR.
.PP
Note that the result is truncated because points are held as integers.
.SH "const QPoint operator+ ( const QPoint & p1, const QPoint & p2 )"
Returns the sum of \fIp1\fR and \fIp2\fR; each component is added separately.
.SH "const QPoint operator- ( const QPoint & p1, const QPoint & p2 )"
Returns \fIp2\fR subtracted from \fIp1\fR; each component is subtracted separately.
.SH "const QPoint operator- ( const QPoint & p )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Returns the QPoint formed by changing the sign of both components of \fIp\fR, equivalent to \fCQPoint(0,0) - p\fR.
.SH "const QPoint operator/ ( const QPoint & p, int c )"
Returns the QPoint formed by dividing both components of \fIp\fR by \fIc\fR.
.SH "const QPoint operator/ ( const QPoint & p, double c )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Returns the QPoint formed by dividing both components of \fIp\fR by \fIc\fR.
.PP
Note that the result is truncated because points are held as integers.
.SH "QDataStream & operator<< ( QDataStream & s, const QPoint & p )"
Writes point \fIp\fR to the stream \fIs\fR and returns a reference to the stream.
.PP
See also Format of the QDataStream operators.
.SH "bool operator== ( const QPoint & p1, const QPoint & p2 )"
Returns TRUE if \fIp1\fR and \fIp2\fR are equal; otherwise returns FALSE.
.SH "QDataStream & operator>> ( QDataStream & s, QPoint & p )"
Reads a QPoint from the stream \fIs\fR into point \fIp\fR and returns a reference to the stream.
.PP
See also Format of the QDataStream operators.

.SH "SEE ALSO"
.BR http://doc.trolltech.com/ntqpoint.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR [email protected] .
Please include the name of the manual page (qpoint.3qt) and the Qt
version (3.3.8).