Class: QgsVector

Represent a 2-dimensional vector.

No Z axis / 2.5D support is implemented. See QgsVector3D for a 3D equivalent.

class qgis.core.QgsVector

Bases: object

__init__()

Default constructor for QgsVector. Creates a vector with length of 0.0.

__init__(x: float, y: float)

Constructor for QgsVector taking x and y component values.

Parameters:

• x (float) – x-component

• y (float) – y-component

__init__(a0: QgsVector)

Parameters:

a0 (QgsVector)

angle(self) → float

Returns the angle of the vector in radians.

angle(self, v: QgsVector) -> float Returns the angle between this vector and another vector in radians.

Return type:

float

crossProduct(self, v: QgsVector) → float

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).

Added in version 3.2.

Parameters:

v (QgsVector)

Return type:

float

length(self) → float

Returns the length of the vector.

See also

lengthSquared()

Return type:

float

lengthSquared(self) → float

Returns the length of the vector.

See also

length()

Added in version 3.2.

Return type:

float

normalized(self) → QgsVector

Returns the vector’s normalized (or “unit”) vector (ie same angle but length of 1.0).

Raises:

QgsException – if called on a vector with length of 0.

Return type:

QgsVector

perpVector(self) → QgsVector

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

Return type:

QgsVector

rotateBy(self, rot: float) → QgsVector

Rotates the vector by a specified angle.

Parameters:

rot (float) – angle in radians

Return type:

QgsVector

toString(self, precision: int = 17) → str

Returns a string representation of the vector. Members will be truncated to the specified precision.

Parameters:

precision (int = 17)

Return type:

str

x(self) → float

Returns the vector’s x-component.

See also

y

Return type:

float

y(self) → float

Returns the vector’s y-component.

See also

x

Return type:

float