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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://www.qtsoftware.com/contact.
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qpoint.h"
#include "qdatastream.h"
#include "qdebug.h"
QT_BEGIN_NAMESPACE
/*!
\class QPoint
\ingroup multimedia
\brief The QPoint class defines a point in the plane using integer
precision.
A point is specified by a x coordinate and an y coordinate which
can be accessed using the x() and y() functions. The isNull()
function returns true if both x and y are set to 0. The
coordinates can be set (or altered) using the setX() and setY()
functions, or alternatively the rx() and ry() functions which
return references to the coordinates (allowing direct
manipulation).
Given a point \e p, the following statements are all equivalent:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 0
A QPoint object can also be used as a vector: Addition and
subtraction are defined as for vectors (each component is added
separately). A QPoint object can also be divided or multiplied by
an \c int or a \c qreal.
In addition, the QPoint class provides the manhattanLength()
function which gives an inexpensive approximation of the length of
the QPoint object interpreted as a vector. Finally, QPoint objects
can be streamed as well as compared.
\sa QPointF, QPolygon
*/
/*****************************************************************************
QPoint member functions
*****************************************************************************/
/*!
\fn QPoint::QPoint()
Constructs a null point, i.e. with coordinates (0, 0)
\sa isNull()
*/
/*!
\fn QPoint::QPoint(int x, int y)
Constructs a point with the given coordinates (\a x, \a y).
\sa setX(), setY()
*/
/*!
\fn bool QPoint::isNull() const
Returns true if both the x and y coordinates are set to 0,
otherwise returns false.
*/
/*!
\fn int QPoint::x() const
Returns the x coordinate of this point.
\sa setX(), rx()
*/
/*!
\fn int QPoint::y() const
Returns the y coordinate of this point.
\sa setY(), ry()
*/
/*!
\fn void QPoint::setX(int x)
Sets the x coordinate of this point to the given \a x coordinate.
\sa x() setY()
*/
/*!
\fn void QPoint::setY(int y)
Sets the y coordinate of this point to the given \a y coordinate.
\sa y() setX()
*/
/*!
\fn int &QPoint::rx()
Returns a reference to the x coordinate of this point.
Using a reference makes it possible to directly manipulate x. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 1
\sa x() setX()
*/
/*!
\fn int &QPoint::ry()
Returns a reference to the y coordinate of this point.
Using a reference makes it possible to directly manipulate y. For
example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 2
\sa y(), setY()
*/
/*!
\fn QPoint &QPoint::operator+=(const QPoint &point)
Adds the given \a point to this point and returns a reference to
this point. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 3
\sa operator-=()
*/
/*!
\fn QPoint &QPoint::operator-=(const QPoint &point)
Subtracts the given \a point from this point and returns a
reference to this point. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 4
\sa operator+=()
*/
/*!
\fn QPoint &QPoint::operator*=(qreal factor)
Multiplies this point's coordinates by the given \a factor, and
returns a reference to this point. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 5
Note that the result is rounded to the nearest integer as points are held as
integers. Use QPointF for floating point accuracy.
\sa operator/=()
*/
/*!
\fn bool operator==(const QPoint &p1, const QPoint &p2)
\relates QPoint
Returns true if \a p1 and \a p2 are equal; otherwise returns
false.
*/
/*!
\fn bool operator!=(const QPoint &p1, const QPoint &p2)
\relates QPoint
Returns true if \a p1 and \a p2 are not equal; otherwise returns false.
*/
/*!
\fn const QPoint operator+(const QPoint &p1, const QPoint &p2)
\relates QPoint
Returns a QPoint object that is the sum of the given points, \a p1
and \a p2; each component is added separately.
\sa QPoint::operator+=()
*/
/*!
\fn const QPoint operator-(const QPoint &p1, const QPoint &p2)
\relates QPoint
Returns a QPoint object that is formed by subtracting \a p2 from
\a p1; each component is subtracted separately.
\sa QPoint::operator-=()
*/
/*!
\fn const QPoint operator*(const QPoint &point, qreal factor)
\relates QPoint
Returns a copy of the given \a point multiplied by the given \a factor.
Note that the result is rounded to the nearest integer as points
are held as integers. Use QPointF for floating point accuracy.
\sa QPoint::operator*=()
*/
/*!
\fn const QPoint operator*(qreal factor, const QPoint &point)
\overload
\relates QPoint
Returns a copy of the given \a point multiplied by the given \a factor.
*/
/*!
\fn const QPoint operator-(const QPoint &point)
\overload
\relates QPoint
Returns a QPoint object that is formed by changing the sign of
both components of the given \a point.
Equivalent to \c{QPoint(0,0) - point}.
*/
/*!
\fn QPoint &QPoint::operator/=(qreal divisor)
\overload
Divides both x and y by the given \a divisor, and returns a reference to this
point. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 6
Note that the result is rounded to the nearest integer as points are held as
integers. Use QPointF for floating point accuracy.
\sa operator*=()
*/
/*!
\fn const QPoint operator/(const QPoint &point, qreal divisor)
\relates QPoint
Returns the QPoint formed by dividing both components of the given \a point
by the given \a divisor.
Note that the result is rounded to the nearest integer as points are held as
integers. Use QPointF for floating point accuracy.
\sa QPoint::operator/=()
*/
/*****************************************************************************
QPoint stream functions
*****************************************************************************/
#ifndef QT_NO_DATASTREAM
/*!
\fn QDataStream &operator<<(QDataStream &stream, const QPoint &point)
\relates QPoint
Writes the given \a point to the given \a stream and returns a
reference to the stream.
\sa {Format of the QDataStream Operators}
*/
QDataStream &operator<<(QDataStream &s, const QPoint &p)
{
if (s.version() == 1)
s << (qint16)p.x() << (qint16)p.y();
else
s << (qint32)p.x() << (qint32)p.y();
return s;
}
/*!
\fn QDataStream &operator>>(QDataStream &stream, QPoint &point)
\relates QPoint
Reads a point from the given \a stream into the given \a point
and returns a reference to the stream.
\sa {Format of the QDataStream Operators}
*/
QDataStream &operator>>(QDataStream &s, QPoint &p)
{
if (s.version() == 1) {
qint16 x, y;
s >> x; p.rx() = x;
s >> y; p.ry() = y;
}
else {
qint32 x, y;
s >> x; p.rx() = x;
s >> y; p.ry() = y;
}
return s;
}
#endif // QT_NO_DATASTREAM
/*!
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. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 7
This is a useful, and quick to calculate, approximation to the
true length:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 8
The tradition of "Manhattan length" arises because such distances
apply to travelers who can only travel on a rectangular grid, like
the streets of Manhattan.
*/
int QPoint::manhattanLength() const
{
return qAbs(x())+qAbs(y());
}
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QPoint &p) {
dbg.nospace() << "QPoint(" << p.x() << ',' << p.y() << ')';
return dbg.space();
}
QDebug operator<<(QDebug d, const QPointF &p)
{
d.nospace() << "QPointF(" << p.x() << ", " << p.y() << ')';
return d;
}
#endif
/*!
\class QPointF
\ingroup multimedia
\brief The QPointF class defines a point in the plane using
floating point precision.
A point is specified by a x coordinate and an y coordinate which
can be accessed using the x() and y() functions. The coordinates
of the point are specified using floating point numbers for
accuracy. The isNull() function returns true if both x and y are
set to 0.0. The coordinates can be set (or altered) using the setX()
and setY() functions, or alternatively the rx() and ry() functions which
return references to the coordinates (allowing direct
manipulation).
Given a point \e p, the following statements are all equivalent:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 9
A QPointF object can also be used as a vector: Addition and
subtraction are defined as for vectors (each component is added
separately). A QPointF object can also be divided or multiplied by
an \c int or a \c qreal.
In addition, the QPointF class provides a constructor converting a
QPoint object into a QPointF object, and a corresponding toPoint()
function which returns a QPoint copy of \e this point. Finally,
QPointF objects can be streamed as well as compared.
\sa QPoint, QPolygonF
*/
/*!
\fn QPointF::QPointF()
Constructs a null point, i.e. with coordinates (0.0, 0.0)
\sa isNull()
*/
/*!
\fn QPointF::QPointF(const QPoint &point)
Constructs a copy of the given \a point.
\sa toPoint()
*/
/*!
\fn QPointF::QPointF(qreal x, qreal y)
Constructs a point with the given coordinates (\a x, \a y).
\sa setX(), setY()
*/
/*!
\fn bool QPointF::isNull() const
Returns true if both the x and y coordinates are set to 0.0,
otherwise returns false.
*/
/*!
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.
\sa QPoint::manhattanLength()
*/
qreal QPointF::manhattanLength() const
{
return qAbs(x())+qAbs(y());
}
/*!
\fn qreal QPointF::x() const
Returns the x-coordinate of this point.
\sa setX(), rx()
*/
/*!
\fn qreal QPointF::y() const
Returns the y-coordinate of this point.
\sa setY(), ry()
*/
/*!
\fn void QPointF::setX(qreal x)
Sets the x coordinate of this point to the given \a x coordinate.
\sa x() setY()
*/
/*!
\fn void QPointF::setY(qreal y)
Sets the y coordinate of this point to the given \a y coordinate.
\sa y(), setX()
*/
/*!
\fn qreal& QPointF::rx()
Returns a reference to the x coordinate of this point.
Using a reference makes it possible to directly manipulate x. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 10
\sa x(), setX()
*/
/*!
\fn qreal& QPointF::ry()
Returns a reference to the y coordinate of this point.
Using a reference makes it possible to directly manipulate y. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 11
\sa y() setY()
*/
/*!
\fn QPointF& QPointF::operator+=(const QPointF &point)
Adds the given \a point to this point and returns a reference to
this point. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 12
\sa operator-=()
*/
/*!
\fn QPointF& QPointF::operator-=(const QPointF &point)
Subtracts the given \a point from this point and returns a reference
to this point. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 13
\sa operator+=()
*/
/*!
\fn QPointF& QPointF::operator*=(qreal factor)
Multiplies this point's coordinates by the given \a factor, and
returns a reference to this point. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 14
\sa operator/=()
*/
/*!
\fn QPointF& QPointF::operator/=(qreal divisor)
Divides both x and y by the given \a divisor, and returns a reference
to this point. For example:
\snippet doc/src/snippets/code/src_corelib_tools_qpoint.cpp 15
\sa operator*=()
*/
/*!
\fn const QPointF operator+(const QPointF &p1, const QPointF &p2)
\relates QPointF
Returns a QPointF object that is the sum of the given points, \a p1
and \a p2; each component is added separately.
\sa QPointF::operator+=()
*/
/*!
\fn const QPointF operator-(const QPointF &p1, const QPointF &p2)
\relates QPointF
Returns a QPointF object that is formed by subtracting \a p2 from \a p1;
each component is subtracted separately.
\sa QPointF::operator-=()
*/
/*!
\fn const QPointF operator*(const QPointF &point, qreal factor)
\relates QPointF
Returns a copy of the given \a point, multiplied by the given \a factor.
\sa QPointF::operator*=()
*/
/*!
\fn const QPointF operator*(qreal factor, const QPointF &point)
\relates QPointF
\overload
Returns a copy of the given \a point, multiplied by the given \a factor.
*/
/*!
\fn const QPointF operator-(const QPointF &point)
\relates QPointF
\overload
Returns a QPointF object that is formed by changing the sign of
both components of the given \a point.
Equivalent to \c {QPointF(0,0) - point}.
*/
/*!
\fn const QPointF operator/(const QPointF &point, qreal divisor)
\relates QPointF
Returns the QPointF object formed by dividing both components of
the given \a point by the given \a divisor.
\sa QPointF::operator/=()
*/
/*!
\fn QPoint QPointF::toPoint() const
Rounds the coordinates of this point to the nearest integer, and
returns a QPoint object with the rounded coordinates.
\sa QPointF()
*/
/*!
\fn bool operator==(const QPointF &p1, const QPointF &p2)
\relates QPointF
Returns true if \a p1 is equal to \a p2; otherwise returns false.
*/
/*!
\fn bool operator!=(const QPointF &p1, const QPointF &p2);
\relates QPointF
Returns true if \a p1 is not equal to \a p2; otherwise returns false.
*/
#ifndef QT_NO_DATASTREAM
/*!
\fn QDataStream &operator<<(QDataStream &stream, const QPointF &point)
\relates QPointF
Writes the given \a point to the given \a stream and returns a
reference to the stream.
\sa {Format of the QDataStream Operators}
*/
QDataStream &operator<<(QDataStream &s, const QPointF &p)
{
s << double(p.x()) << double(p.y());
return s;
}
/*!
\fn QDataStream &operator>>(QDataStream &stream, QPointF &point)
\relates QPointF
Reads a point from the given \a stream into the given \a point
and returns a reference to the stream.
\sa {Format of the QDataStream Operators}
*/
QDataStream &operator>>(QDataStream &s, QPointF &p)
{
double x, y;
s >> x;
s >> y;
p.setX(qreal(x));
p.setY(qreal(y));
return s;
}
#endif // QT_NO_DATASTREAM
QT_END_NAMESPACE
|