QGIS API Documentation  2.99.0-Master (08c2e66)
Public Member Functions | List of all members
QgsVector Class Reference

A class to represent a vector. More...

#include <qgspoint.h>

Public Member Functions

 QgsVector ()
 Default constructor for QgsVector. More...
 
 QgsVector (double x, double y)
 Constructor for QgsVector taking x and y component values. More...
 
double angle () const
 Returns the angle of the vector in radians. More...
 
double angle (QgsVector v) const
 Returns the angle between this vector and another vector in radians. More...
 
double length () const
 Returns the length of the vector. More...
 
QgsVector normalized () const
 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
 Returns a vector where the components have been multiplied by a scalar value. More...
 
double operator* (QgsVector v) const
 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
 Adds another vector to this vector. More...
 
QgsVectoroperator+= (QgsVector other)
 Adds another vector to this vector in place. More...
 
QgsVector operator- () const
 Swaps the sign of the x and y components of the vector. More...
 
QgsVector operator- (QgsVector other) const
 Subtracts another vector to this vector. More...
 
QgsVectoroperator-= (QgsVector other)
 Subtracts another vector to this vector in place. More...
 
QgsVector operator/ (double scalar) const
 Returns a vector where the components have been divided by a scalar value. More...
 
bool operator== (QgsVector other) const
 Equality operator. More...
 
QgsVector perpVector () const
 Returns the perpendicular vector to this vector (rotated 90 degrees counter-clockwise) More...
 
QgsVector rotateBy (double rot) const
 Rotates the vector by a specified angle. More...
 
double x () const
 Returns the vector's x-component. More...
 
double y () const
 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 33 of file qgspoint.h.

Constructor & Destructor Documentation

QgsVector::QgsVector ( )

Default constructor for QgsVector.

Creates a vector with length of 0.0.

Definition at line 31 of file qgspoint.cpp.

QgsVector::QgsVector ( double  x,
double  y 
)

Constructor for QgsVector taking x and y component values.

Parameters
xx-component
yy-component

Definition at line 37 of file qgspoint.cpp.

Member Function Documentation

double QgsVector::angle ( ) const

Returns the angle of the vector in radians.

Definition at line 107 of file qgspoint.cpp.

double QgsVector::angle ( QgsVector  v) const

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

Definition at line 113 of file qgspoint.cpp.

double QgsVector::length ( ) const

Returns the length of the vector.

Definition at line 87 of file qgspoint.cpp.

QgsVector QgsVector::normalized ( ) const

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

Will throw an exception if called on a vector with length of 0.

Definition at line 125 of file qgspoint.cpp.

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

Inequality operator.

Definition at line 142 of file qgspoint.cpp.

QgsVector QgsVector::operator* ( double  scalar) const

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

Parameters
scalarfactor to multiply by

Definition at line 48 of file qgspoint.cpp.

double QgsVector::operator* ( QgsVector  v) const

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 58 of file qgspoint.cpp.

QgsVector QgsVector::operator+ ( QgsVector  other) const

Adds another vector to this vector.

Note
added in QGIS 3.0

Definition at line 63 of file qgspoint.cpp.

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

Adds another vector to this vector in place.

Note
added in QGIS 3.0

Definition at line 68 of file qgspoint.cpp.

QgsVector QgsVector::operator- ( ) const

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

Definition at line 43 of file qgspoint.cpp.

QgsVector QgsVector::operator- ( QgsVector  other) const

Subtracts another vector to this vector.

Note
added in QGIS 3.0

Definition at line 75 of file qgspoint.cpp.

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

Subtracts another vector to this vector in place.

Note
added in QGIS 3.0

Definition at line 80 of file qgspoint.cpp.

QgsVector QgsVector::operator/ ( double  scalar) const

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

Parameters
scalarfactor to divide by

Definition at line 53 of file qgspoint.cpp.

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

Equality operator.

Definition at line 137 of file qgspoint.cpp.

QgsVector QgsVector::perpVector ( ) const

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

Definition at line 102 of file qgspoint.cpp.

QgsVector QgsVector::rotateBy ( double  rot) const

Rotates the vector by a specified angle.

Parameters
rotangle in radians

Definition at line 118 of file qgspoint.cpp.

double QgsVector::x ( ) const

Returns the vector's x-component.

See also
y()

Definition at line 92 of file qgspoint.cpp.

double QgsVector::y ( ) const

Returns the vector's y-component.

See also
x()

Definition at line 97 of file qgspoint.cpp.


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