A class to represent a vector. More...

#include <qgsvector.h>

Public Member Functions
	QgsVector ()=default
	Default constructor for QgsVector. More...

	QgsVector (double x, double y)
	Constructor for QgsVector taking x and y component values. More...

double	angle () const SIP_HOLDGIL
	Returns the angle of the vector in radians. More...

double	angle (QgsVector v) const SIP_HOLDGIL
	Returns the angle between this vector and another vector in radians. More...

double	crossProduct (QgsVector v) const SIP_HOLDGIL
	Returns the 2D cross product of this vector and another vector v. More...

double	length () const SIP_HOLDGIL
	Returns the length of the vector. More...

double	lengthSquared () const SIP_HOLDGIL
	Returns the length of the vector. More...

QgsVector	normalized () const SIP_THROW(QgsException)
	Returns the vector's normalized (or "unit") vector (ie same angle but length of 1.0). More...

bool	operator!= (QgsVector other) const
	Inequality operator. More...

QgsVector	operator* (double scalar) const SIP_HOLDGIL
	Returns a vector where the components have been multiplied by a scalar value. More...

double	operator* (QgsVector v) const SIP_HOLDGIL
	Returns the dot product of two vectors, which is the sum of the x component of this vector multiplied by the x component of another vector plus the y component of this vector multiplied by the y component of another vector. More...

QgsVector	operator+ (QgsVector other) const SIP_HOLDGIL
	Adds another vector to this vector. More...

QgsVector &	operator+= (QgsVector other) SIP_HOLDGIL
	Adds another vector to this vector in place. More...

QgsVector	operator- () const SIP_HOLDGIL
	Swaps the sign of the x and y components of the vector. More...

QgsVector	operator- (QgsVector other) const SIP_HOLDGIL
	Subtracts another vector to this vector. More...

QgsVector &	operator-= (QgsVector other) SIP_HOLDGIL
	Subtracts another vector to this vector in place. More...

QgsVector	operator/ (double scalar) const SIP_HOLDGIL
	Returns a vector where the components have been divided by a scalar value. More...

bool	operator== (QgsVector other) const SIP_HOLDGIL
	Equality operator. More...

QgsVector	perpVector () const SIP_HOLDGIL
	Returns the perpendicular vector to this vector (rotated 90 degrees counter-clockwise) More...

QgsVector	rotateBy (double rot) const SIP_HOLDGIL
	Rotates the vector by a specified angle. More...

QString	toString (int precision=17) const SIP_HOLDGIL
	Returns a string representation of the vector. More...

double	x () const SIP_HOLDGIL
	Returns the vector's x-component. More...

double	y () const SIP_HOLDGIL
	Returns the vector's y-component. More...

Detailed Description

A class to represent a vector.

Currently no Z axis / 2.5D support is implemented.

Definition at line 29 of file qgsvector.h.

Constructor & Destructor Documentation

◆ QgsVector() [1/2]

QgsVector::QgsVector ( )

default

Default constructor for QgsVector.

Creates a vector with length of 0.0.

◆ QgsVector() [2/2]

QgsVector::QgsVector	(	double	x,
		double	y
	)

inline

Constructor for QgsVector taking x and y component values.

Parameters

x	x-component
y	y-component

Definition at line 44 of file qgsvector.h.

Member Function Documentation

◆ angle() [1/2]

double QgsVector::angle ( ) const

inline

Returns the angle of the vector in radians.

Definition at line 172 of file qgsvector.h.

◆ angle() [2/2]

double QgsVector::angle ( QgsVector v ) const

inline

Returns the angle between this vector and another vector in radians.

Definition at line 181 of file qgsvector.h.

◆ crossProduct()

double QgsVector::crossProduct ( QgsVector v ) const

inline

Returns the 2D cross product of this vector and another vector v.

(This is sometimes referred to as a "perpendicular dot product", and equals x1 * y1 - y1 * x2).

Since: QGIS 3.2

Definition at line 192 of file qgsvector.h.

◆ length()

double QgsVector::length ( ) const

inline

Returns the length of the vector.

See also: lengthSquared()

Definition at line 128 of file qgsvector.h.

◆ lengthSquared()

double QgsVector::lengthSquared ( ) const

inline

Returns the length of the vector.

See also: length()

Since: QGIS 3.2

Definition at line 138 of file qgsvector.h.

◆ normalized()

QgsVector QgsVector::normalized ( ) const

Returns the vector's normalized (or "unit") vector (ie same angle but length of 1.0).

Exceptions

QgsException if called on a vector with length of 0.

Definition at line 28 of file qgsvector.cpp.

◆ operator!=()

bool QgsVector::operator!= ( QgsVector other ) const

inline

Inequality operator.

Definition at line 217 of file qgsvector.h.

◆ operator*() [1/2]

QgsVector QgsVector::operator* ( double scalar ) const

inline

Returns a vector where the components have been multiplied by a scalar value.

Parameters

scalar factor to multiply by

Definition at line 60 of file qgsvector.h.

◆ operator*() [2/2]

double QgsVector::operator* ( QgsVector v ) const

inline

Returns the dot product of two vectors, which is the sum of the x component of this vector multiplied by the x component of another vector plus the y component of this vector multiplied by the y component of another vector.

Definition at line 79 of file qgsvector.h.

◆ operator+()

QgsVector QgsVector::operator+ ( QgsVector other ) const

inline

Adds another vector to this vector.

Since: QGIS 3.0

Definition at line 88 of file qgsvector.h.

◆ operator+=()

QgsVector& QgsVector::operator+= ( QgsVector other )

inline

Adds another vector to this vector in place.

Since: QGIS 3.0

Definition at line 97 of file qgsvector.h.

◆ operator-() [1/2]

QgsVector QgsVector::operator- ( ) const

inline

Swaps the sign of the x and y components of the vector.

Definition at line 51 of file qgsvector.h.

◆ operator-() [2/2]

QgsVector QgsVector::operator- ( QgsVector other ) const

inline

Subtracts another vector to this vector.

Since: QGIS 3.0

Definition at line 108 of file qgsvector.h.

◆ operator-=()

QgsVector& QgsVector::operator-= ( QgsVector other )

inline

Subtracts another vector to this vector in place.

Since: QGIS 3.0

Definition at line 117 of file qgsvector.h.

◆ operator/()

QgsVector QgsVector::operator/ ( double scalar ) const

inline

Returns a vector where the components have been divided by a scalar value.

Parameters

scalar factor to divide by

Definition at line 69 of file qgsvector.h.

◆ operator==()

bool QgsVector::operator== ( QgsVector other ) const

inline

Equality operator.

Definition at line 211 of file qgsvector.h.

◆ perpVector()

QgsVector QgsVector::perpVector ( ) const

inline

Returns the perpendicular vector to this vector (rotated 90 degrees counter-clockwise)

Definition at line 164 of file qgsvector.h.

◆ rotateBy()

QgsVector QgsVector::rotateBy ( double rot ) const

Rotates the vector by a specified angle.

Parameters

rot	angle in radians

Definition at line 21 of file qgsvector.cpp.

◆ toString()

QString QgsVector::toString ( int precision = 17 ) const

inline

Returns a string representation of the vector.

Members will be truncated to the specified precision.

Definition at line 226 of file qgsvector.h.

◆ x()

double QgsVector::x ( ) const

inline

Returns the vector's x-component.

See also: y()

Definition at line 147 of file qgsvector.h.

◆ y()

double QgsVector::y ( ) const

inline

Returns the vector's y-component.

See also: x()

Definition at line 156 of file qgsvector.h.

The documentation for this class was generated from the following files:

/build/qgis-3.16.0+99unstable/src/core/qgsvector.h
/build/qgis-3.16.0+99unstable/src/core/qgsvector.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsVector() [1/2]

◆ QgsVector() [2/2]

Member Function Documentation

◆ angle() [1/2]

◆ angle() [2/2]

◆ crossProduct()

◆ length()

◆ lengthSquared()

◆ normalized()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator==()

◆ perpVector()

◆ rotateBy()

◆ toString()

◆ x()

◆ y()