CopperSpice API  1.7.2
QVector2D Class Reference

The QVector2D class represents a vector or vertex in 2D space. More...

Public Methods

 QVector2D ()
 
 QVector2D (const QPoint &point)
 
 QVector2D (const QPointF &point)
 
 QVector2D (const QVector3D &vector)
 
 QVector2D (const QVector4D &vector)
 
 QVector2D (qreal xpos, qreal ypos)
 
bool isNull () const
 
qreal length () const
 
qreal lengthSquared () const
 
void normalize ()
 
QVector2D normalized () const
 
 operator QVariant () const
 
QVector2D & operator*= (const QVector2D &vector)
 
QVector2D & operator*= (qreal factor)
 
QVector2D & operator+= (const QVector2D &vector)
 
QVector2D & operator-= (const QVector2D &vector)
 
QVector2D & operator/= (qreal divisor)
 
void setX (qreal x)
 
void setY (qreal y)
 
QPoint toPoint () const
 
QPointF toPointF () const
 
QVector3D toVector3D () const
 
QVector4D toVector4D () const
 
qreal x () const
 
qreal y () const
 

Static Public Methods

static qreal dotProduct (const QVector2D &v1, const QVector2D &v2)
 

Friends

bool operator!= (const QVector2D &v1, const QVector2D &v2)
 
const QVector2D operator* (const QVector2D &v1, const QVector2D &v2)
 
const QVector2D operator* (const QVector2D &vector, qreal factor)
 
const QVector2D operator* (qreal factor, const QVector2D &vector)
 
const QVector2D operator+ (const QVector2D &v1, const QVector2D &v2)
 
const QVector2D operator- (const QVector2D &v1, const QVector2D &v2)
 
const QVector2D operator- (const QVector2D &vector)
 
const QVector2D operator/ (const QVector2D &vector, qreal divisor)
 
bool operator== (const QVector2D &v1, const QVector2D &v2)
 
bool qFuzzyCompare (const QVector2D &v1, const QVector2D &v2)
 
class QVector3D
 
class QVector4D
 

Related Functions

These are not member functions

QDataStreamoperator<< (QDataStream &stream, const QVector2D &vector)
 
QDataStreamoperator>> (QDataStream &stream, QVector2D &vector)
 

Detailed Description

The QVector2D class represents a vector or vertex in 2D space.

The QVector2D class can also be used to represent vertices in 2D space. We therefore do not need to provide a separate vertex class.

Note
By design values in the QVector2D instance are stored as float. This means that on platforms where the qreal arguments to QVector2D functions are represented by double values, it is possible to lose precision.
See also
QVector3D, QVector4D, QQuaternion

Constructor & Destructor Documentation

QVector2D::QVector2D ( )
inline

Constructs a null vector, i.e. with coordinates (0, 0, 0).

QVector2D::QVector2D ( qreal  xpos,
qreal  ypos 
)
inline

Constructs a vector with coordinates (xpos, ypos).

QVector2D::QVector2D ( const QPoint point)
inlineexplicit

Constructs a vector with x and y coordinates from a 2D point.

QVector2D::QVector2D ( const QPointF point)
inlineexplicit

Constructs a vector with x and y coordinates from a 2D point.

QVector2D::QVector2D ( const QVector3D vector)
explicit

Constructs a vector with x and y coordinates from a 3D vector. The z coordinate of vector is dropped.

See also
toVector3D()
QVector2D::QVector2D ( const QVector4D vector)
explicit

Constructs a vector with x and y coordinates from a 3D vector. The z and w coordinates of vector are dropped.

See also
toVector4D()

Method Documentation

qreal QVector2D::dotProduct ( const QVector2D &  v1,
const QVector2D &  v2 
)
static

Returns the dot product of vi and v2.

bool QVector2D::isNull ( ) const
inline

Returns true if the x and y coordinates are set to 0.0, otherwise returns false.

qreal QVector2D::length ( ) const

Returns the length of the vector from the origin.

See also
lengthSquared(), normalized()
qreal QVector2D::lengthSquared ( ) const

Returns the squared length of the vector from the origin. This is equivalent to the dot product of the vector with itself.

See also
length(), dotProduct()
void QVector2D::normalize ( )

Normalizes the current vector in place. Nothing happens if this vector is a null vector or the length of the vector is very close to 1.

See also
length(), normalized()
QVector2D QVector2D::normalized ( ) const

Returns the normalized unit vector form of this vector.

If this vector is null, then a null vector is returned. If the length of the vector is very close to 1, then the vector will be returned as-is. Otherwise the normalized form of the vector of length 1 will be returned.

See also
length(), normalize()
QVector2D::operator QVariant ( ) const

Returns the 2D vector as a QVariant.

QVector2D & QVector2D::operator*= ( const QVector2D &  vector)
inline

Multiplies the components of this vector by the corresponding components in vector.

QVector2D & QVector2D::operator*= ( qreal  factor)
inline

Multiplies this vector's coordinates by the given factor, and returns a reference to this vector.

See also
operator/=()
QVector2D & QVector2D::operator+= ( const QVector2D &  vector)
inline

Adds the given vector to this vector and returns a reference to this vector.

See also
operator-=()
QVector2D & QVector2D::operator-= ( const QVector2D &  vector)
inline

Subtracts the given vector from this vector and returns a reference to this vector.

See also
operator+=()
QVector2D & QVector2D::operator/= ( qreal  divisor)
inline

Divides this vector's coordinates by the given divisor, and returns a reference to this vector.

See also
operator*=()
void QVector2D::setX ( qreal  x)
inline

Sets the x coordinate of this point to the given x coordinate.

See also
x(), setY()
void QVector2D::setY ( qreal  y)
inline

Sets the y coordinate of this point to the given y coordinate.

See also
y(), setX()
QPoint QVector2D::toPoint ( ) const
inline

Returns the QPoint form of this 2D vector.

See also
toPointF(), toVector3D()
QPointF QVector2D::toPointF ( ) const
inline

Returns the QPointF form of this 2D vector.

See also
toPoint(), toVector3D()
QVector3D QVector2D::toVector3D ( ) const

Returns the 3D form of this 2D vector, with the z coordinate set to zero.

See also
toVector4D(), toPoint()
QVector4D QVector2D::toVector4D ( ) const

Returns the 4D form of this 2D vector, with the z and w coordinates set to zero.

See also
toVector3D(), toPoint()
qreal QVector2D::x ( ) const
inline

Returns the x coordinate of this point.

See also
setX(), y()
qreal QVector2D::y ( ) const
inline

Returns the y coordinate of this point.

See also
setY(), x()

Friends And Related Function Documentation

bool operator!= ( const QVector2D &  v1,
const QVector2D &  v2 
)
friend

Returns true if vi is not equal to v2, otherwise returns false. This operator uses an exact floating-point comparison.

const QVector2D operator* ( const QVector2D &  v1,
const QVector2D &  v2 
)
friend

Multiplies the components of vi by the corresponding components in v2.

const QVector2D operator* ( const QVector2D &  vector,
qreal  factor 
)
friend

Returns a copy of the given vector, multiplied by the given factor.

See also
QVector2D::operator*=()
const QVector2D operator* ( qreal  factor,
const QVector2D &  vector 
)
friend

Returns a copy of the given vector, multiplied by the given factor.

See also
QVector2D::operator*=()
const QVector2D operator+ ( const QVector2D &  v1,
const QVector2D &  v2 
)
friend

Returns a QVector2D object that is the sum of the given vectors, vi and v2, each component is added separately.

See also
QVector2D::operator+=()
const QVector2D operator- ( const QVector2D &  v1,
const QVector2D &  v2 
)
friend

Returns a QVector2D object that is formed by subtracting v2 from vi, each component is subtracted separately.

See also
QVector2D::operator-=()
const QVector2D operator- ( const QVector2D &  vector)
friend

This is an overloaded function.

Returns a QVector2D object that is formed by changing the sign of the components of the given vector.

Equivalent to QVector2D(0,0) - vector.

const QVector2D operator/ ( const QVector2D &  vector,
qreal  divisor 
)
friend

Returns the QVector2D object formed by dividing all three components of the given vector by the given divisor.

See also
QVector2D::operator/=()
QDataStream & operator<< ( QDataStream stream,
const QVector2D &  vector 
)
related

Writes the given vector to the given stream and returns a reference to the stream.

See also
Refer to Serializing Data Types for additional information
bool operator== ( const QVector2D &  v1,
const QVector2D &  v2 
)
friend

Returns true if vi is equal to v2, otherwise returns false. This operator uses an exact floating-point comparison.

QDataStream & operator>> ( QDataStream stream,
QVector2D &  vector 
)
related

Reads a 2D vector from the given stream into the given vector and returns a reference to the stream.

See also
Refer to Serializing Data Types for additional information
bool qFuzzyCompare ( const QVector2D &  v1,
const QVector2D &  v2 
)
friend

Returns true if vi and v2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise.