Qt 4.8
qvector2d.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QVECTOR2D_H
43 #define QVECTOR2D_H
44 
45 #include <QtCore/qpoint.h>
46 #include <QtCore/qmetatype.h>
47 
49 
51 
52 QT_MODULE(Gui)
53 
54 class QVector3D;
55 class QVector4D;
56 class QVariant;
57 
58 #ifndef QT_NO_VECTOR2D
59 
61 {
62 public:
63  QVector2D();
64  QVector2D(qreal xpos, qreal ypos);
65  explicit QVector2D(const QPoint& point);
66  explicit QVector2D(const QPointF& point);
67 #ifndef QT_NO_VECTOR3D
68  explicit QVector2D(const QVector3D& vector);
69 #endif
70 #ifndef QT_NO_VECTOR4D
71  explicit QVector2D(const QVector4D& vector);
72 #endif
73 
74  bool isNull() const;
75 
76  qreal x() const;
77  qreal y() const;
78 
79  void setX(qreal x);
80  void setY(qreal y);
81 
82  qreal length() const;
83  qreal lengthSquared() const;
84 
85  QVector2D normalized() const;
86  void normalize();
87 
88  QVector2D &operator+=(const QVector2D &vector);
89  QVector2D &operator-=(const QVector2D &vector);
90  QVector2D &operator*=(qreal factor);
91  QVector2D &operator*=(const QVector2D &vector);
92  QVector2D &operator/=(qreal divisor);
93 
94  static qreal dotProduct(const QVector2D& v1, const QVector2D& v2);
95 
96  friend inline bool operator==(const QVector2D &v1, const QVector2D &v2);
97  friend inline bool operator!=(const QVector2D &v1, const QVector2D &v2);
98  friend inline const QVector2D operator+(const QVector2D &v1, const QVector2D &v2);
99  friend inline const QVector2D operator-(const QVector2D &v1, const QVector2D &v2);
100  friend inline const QVector2D operator*(qreal factor, const QVector2D &vector);
101  friend inline const QVector2D operator*(const QVector2D &vector, qreal factor);
102  friend inline const QVector2D operator*(const QVector2D &v1, const QVector2D &v2);
103  friend inline const QVector2D operator-(const QVector2D &vector);
104  friend inline const QVector2D operator/(const QVector2D &vector, qreal divisor);
105 
106  friend inline bool qFuzzyCompare(const QVector2D& v1, const QVector2D& v2);
107 
108 #ifndef QT_NO_VECTOR3D
109  QVector3D toVector3D() const;
110 #endif
111 #ifndef QT_NO_VECTOR4D
112  QVector4D toVector4D() const;
113 #endif
114 
115  QPoint toPoint() const;
116  QPointF toPointF() const;
117 
118  operator QVariant() const;
119 
120 private:
121  float xp, yp;
122 
123  QVector2D(float xpos, float ypos, int dummy);
124 
125  friend class QVector3D;
126  friend class QVector4D;
127 };
128 
130 
131 inline QVector2D::QVector2D() : xp(0.0f), yp(0.0f) {}
132 
133 inline QVector2D::QVector2D(float xpos, float ypos, int) : xp(xpos), yp(ypos) {}
134 
135 inline QVector2D::QVector2D(qreal xpos, qreal ypos) : xp(xpos), yp(ypos) {}
136 
137 inline QVector2D::QVector2D(const QPoint& point) : xp(point.x()), yp(point.y()) {}
138 
139 inline QVector2D::QVector2D(const QPointF& point) : xp(point.x()), yp(point.y()) {}
140 
141 inline bool QVector2D::isNull() const
142 {
143  return qIsNull(xp) && qIsNull(yp);
144 }
145 
146 inline qreal QVector2D::x() const { return qreal(xp); }
147 inline qreal QVector2D::y() const { return qreal(yp); }
148 
149 inline void QVector2D::setX(qreal aX) { xp = aX; }
150 inline void QVector2D::setY(qreal aY) { yp = aY; }
151 
153 {
154  xp += vector.xp;
155  yp += vector.yp;
156  return *this;
157 }
158 
160 {
161  xp -= vector.xp;
162  yp -= vector.yp;
163  return *this;
164 }
165 
167 {
168  xp *= factor;
169  yp *= factor;
170  return *this;
171 }
172 
174 {
175  xp *= vector.xp;
176  yp *= vector.yp;
177  return *this;
178 }
179 
181 {
182  xp /= divisor;
183  yp /= divisor;
184  return *this;
185 }
186 
187 inline bool operator==(const QVector2D &v1, const QVector2D &v2)
188 {
189  return v1.xp == v2.xp && v1.yp == v2.yp;
190 }
191 
192 inline bool operator!=(const QVector2D &v1, const QVector2D &v2)
193 {
194  return v1.xp != v2.xp || v1.yp != v2.yp;
195 }
196 
197 inline const QVector2D operator+(const QVector2D &v1, const QVector2D &v2)
198 {
199  return QVector2D(v1.xp + v2.xp, v1.yp + v2.yp, 1);
200 }
201 
202 inline const QVector2D operator-(const QVector2D &v1, const QVector2D &v2)
203 {
204  return QVector2D(v1.xp - v2.xp, v1.yp - v2.yp, 1);
205 }
206 
207 inline const QVector2D operator*(qreal factor, const QVector2D &vector)
208 {
209  return QVector2D(vector.xp * factor, vector.yp * factor, 1);
210 }
211 
212 inline const QVector2D operator*(const QVector2D &vector, qreal factor)
213 {
214  return QVector2D(vector.xp * factor, vector.yp * factor, 1);
215 }
216 
217 inline const QVector2D operator*(const QVector2D &v1, const QVector2D &v2)
218 {
219  return QVector2D(v1.xp * v2.xp, v1.yp * v2.yp, 1);
220 }
221 
222 inline const QVector2D operator-(const QVector2D &vector)
223 {
224  return QVector2D(-vector.xp, -vector.yp, 1);
225 }
226 
227 inline const QVector2D operator/(const QVector2D &vector, qreal divisor)
228 {
229  return QVector2D(vector.xp / divisor, vector.yp / divisor, 1);
230 }
231 
232 inline bool qFuzzyCompare(const QVector2D& v1, const QVector2D& v2)
233 {
234  return qFuzzyCompare(v1.xp, v2.xp) && qFuzzyCompare(v1.yp, v2.yp);
235 }
236 
238 {
239  return QPoint(qRound(xp), qRound(yp));
240 }
241 
243 {
244  return QPointF(qreal(xp), qreal(yp));
245 }
246 
247 #ifndef QT_NO_DEBUG_STREAM
248 Q_GUI_EXPORT QDebug operator<<(QDebug dbg, const QVector2D &vector);
249 #endif
250 
251 #ifndef QT_NO_DATASTREAM
254 #endif
255 
256 #endif
257 
259 
261 
262 #endif
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
The QDebug class provides an output stream for debugging information.
Definition: qdebug.h:62
const QVector2D operator-(const QVector2D &v1, const QVector2D &v2)
Definition: qvector2d.h:202
QVector2D & operator*=(qreal factor)
Multiplies this vector&#39;s coordinates by the given factor, and returns a reference to this vector...
Definition: qvector2d.h:166
The QVector3D class represents a vector or vertex in 3D space.
Definition: qvector3d.h:60
double qreal
Definition: qglobal.h:1193
friend const QVector2D operator+(const QVector2D &v1, const QVector2D &v2)
Returns a QVector2D object that is the sum of the given vectors, v1 and v2; each component is added s...
Definition: qvector2d.h:197
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
QPoint toPoint() const
Returns the QPoint form of this 2D vector.
Definition: qvector2d.h:237
friend bool operator!=(const QVector2D &v1, const QVector2D &v2)
Returns true if v1 is not equal to v2; otherwise returns false.
Definition: qvector2d.h:192
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
float xp
Definition: qvector2d.h:121
The QVector4D class represents a vector or vertex in 4D space.
Definition: qvector4d.h:60
The QPointF class defines a point in the plane using floating point precision.
Definition: qpoint.h:214
float yp
Definition: qvector4d.h:129
QVector2D & operator/=(qreal divisor)
Divides this vector&#39;s coordinates by the given divisor, and returns a reference to this vector...
Definition: qvector2d.h:180
friend bool operator==(const QVector2D &v1, const QVector2D &v2)
Returns true if v1 is equal to v2; otherwise returns false.
Definition: qvector2d.h:187
static bool qIsNull(double d)
Definition: qglobal.h:2061
void setX(qreal x)
Sets the x coordinate of this point to the given x coordinate.
Definition: qvector2d.h:149
friend const QVector2D operator/(const QVector2D &vector, qreal divisor)
Returns the QVector2D object formed by dividing all three components of the given vector by the given...
Definition: qvector2d.h:227
bool operator==(const QVector2D &v1, const QVector2D &v2)
Definition: qvector2d.h:187
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QDataStream & operator>>(QDataStream &stream, QVector2D &vector)
Reads a 2D vector from the given stream into the given vector and returns a reference to the stream...
Definition: qvector2d.cpp:530
Q_DECLARE_TYPEINFO(QVector2D, Q_MOVABLE_TYPE)
The QVector2D class represents a vector or vertex in 2D space.
Definition: qvector2d.h:60
qreal x() const
Returns the x coordinate of this point.
Definition: qvector2d.h:146
void setY(qreal y)
Sets the y coordinate of this point to the given y coordinate.
Definition: qvector2d.h:150
const QVector2D operator+(const QVector2D &v1, const QVector2D &v2)
Definition: qvector2d.h:197
QVector2D & operator-=(const QVector2D &vector)
Subtracts the given vector from this vector and returns a reference to this vector.
Definition: qvector2d.h:159
bool operator!=(const QVector2D &v1, const QVector2D &v2)
Definition: qvector2d.h:192
QDataStream & operator<<(QDataStream &stream, const QVector2D &vector)
Writes the given vector to the given stream and returns a reference to the stream.
Definition: qvector2d.cpp:511
const QVector2D operator/(const QVector2D &vector, qreal divisor)
Definition: qvector2d.h:227
friend const QVector2D operator*(qreal factor, const QVector2D &vector)
Definition: qvector2d.h:207
bool qFuzzyCompare(const QVector2D &v1, const QVector2D &v2)
Definition: qvector2d.h:232
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
bool isNull() const
Returns true if the x and y coordinates are set to 0.
Definition: qvector2d.h:141
QPointF toPointF() const
Returns the QPointF form of this 2D vector.
Definition: qvector2d.h:242
qreal y() const
Returns the y coordinate of this point.
Definition: qvector2d.h:147
const QVector2D operator*(qreal factor, const QVector2D &vector)
Definition: qvector2d.h:207
friend bool qFuzzyCompare(const QVector2D &v1, const QVector2D &v2)
Returns true if v1 and v2 are equal, allowing for a small fuzziness factor for floating-point compari...
Definition: qvector2d.h:232
float yp
Definition: qvector2d.h:121
The QDataStream class provides serialization of binary data to a QIODevice.
Definition: qdatastream.h:71
friend const QVector2D operator-(const QVector2D &v1, const QVector2D &v2)
Returns a QVector2D object that is formed by subtracting v2 from v1; each component is subtracted sep...
Definition: qvector2d.h:202
timeval & operator+=(timeval &t1, const timeval &t2)
Definition: qcore_unix_p.h:120
#define QT_END_HEADER
Definition: qglobal.h:137
float xp
Definition: qvector4d.h:129
static void normalize(double &x, double &y)
Q_DECL_CONSTEXPR int qRound(qreal d)
Definition: qglobal.h:1203
static bool isNull(const QVariant::Private *d)
Definition: qvariant.cpp:300
QVector2D()
Constructs a null vector, i.
Definition: qvector2d.h:131
QVector2D & operator+=(const QVector2D &vector)
Adds the given vector to this vector and returns a reference to this vector.
Definition: qvector2d.h:152