PySide6.QtGui.QVector3D¶

class QVector3D¶

The QVector3D class represents a vector or vertex in 3D space.

Details

Vectors are one of the main building blocks of 3D representation and drawing. They consist of three finite floating-point coordinates, traditionally called x, y, and z.

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

See also

QVector2D QVector4D QQuaternion

Synopsis¶

Methods¶

def __init__()
def __reduce__()
def __repr__()
def distanceToLine()
def distanceToPlane()
def distanceToPoint()
def isNull()
def length()
def lengthSquared()
def normalize()
def normalized()
def __ne__()
def __mul__()
def __imul__()
def __add__()
def __iadd__()
def __sub__()
def __isub__()
def __div__()
def operator/=()
def __eq__()
def operator[]()
def project()
def setX()
def setY()
def setZ()
def toPoint()
def toPointF()
def toTuple()
def toVector2D()
def toVector4D()
def unproject()
def x()
def y()
def z()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()¶

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

__init__(point)

Parameters:: point – QPoint

Constructs a vector with x and y coordinates from a 2D point, and a z coordinate of 0.

__init__(point)

Parameters:: point – QPointF

Constructs a vector with x and y coordinates from a 2D point, and a z coordinate of 0.

__init__(vector)

Parameters:: vector – QVector2D

Constructs a 3D vector from the specified 2D vector. The z coordinate is set to zero.

See also

toVector2D()

__init__(vector)

Parameters:: vector – QVector4D

Constructs a 3D vector from the specified 4D vector. The w coordinate is dropped.

See also

toVector4D()

__init__(vector, zpos)

Parameters:

vector – QVector2D
zpos – float

Constructs a 3D vector from the specified 2D vector. The z coordinate is set to zpos, which must be finite.

See also

toVector2D()

__init__(xpos, ypos, zpos)

Parameters:

xpos – float
ypos – float
zpos – float

Constructs a vector with coordinates (xpos, ypos, zpos). All parameters must be finite.

__reduce__()¶

Return type:: str

__repr__()¶

Return type:: str

static crossProduct(v1, v2)¶

Parameters:

v1 – QVector3D
v2 – QVector3D

Return type:

QVector3D

Returns the cross-product of vectors v1 and v2, which is normal to the plane spanned by v1 and v2. It will be zero if the two vectors are parallel.

See also

normal()

distanceToLine(point, direction)¶

Parameters:

point – QVector3D
direction – QVector3D

Return type:

float

Returns the distance that this vertex is from a line defined by point and the unit vector direction.

If direction is a null vector, then it does not define a line. In that case, the distance from point to this vertex is returned.

See also

distanceToPlane()

distanceToPlane(plane, normal)¶

Parameters:

plane – QVector3D
normal – QVector3D

Return type:

float

Returns the distance from this vertex to a plane defined by the vertex plane and a normal unit vector. The normal parameter is assumed to have been normalized to a unit vector.

The return value will be negative if the vertex is below the plane, or zero if it is on the plane.

See also

normal() distanceToLine()

distanceToPlane(plane1, plane2, plane3)

Parameters:

plane1 – QVector3D
plane2 – QVector3D
plane3 – QVector3D

Return type:

float

Returns the distance from this vertex to a plane defined by the vertices plane1, plane2 and plane3.

The return value will be negative if the vertex is below the plane, or zero if it is on the plane.

The two vectors that define the plane are plane2 - plane1 and plane3 - plane1.

See also

normal() distanceToLine()

distanceToPoint(point)¶

Parameters:: point – QVector3D
Return type:: float

Returns the distance from this vertex to a point defined by the vertex point.

See also

distanceToPlane() distanceToLine()

static dotProduct(v1, v2)¶

Parameters:

v1 – QVector3D
v2 – QVector3D

Return type:

float

Returns the dot product of v1 and v2.

isNull()¶

Return type:: bool

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

length()¶

Return type:: float

Returns the length of the vector from the origin.

See also

lengthSquared() normalized()

lengthSquared()¶

Return type:: float

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

static normal(v1, v2)¶

Parameters:

v1 – QVector3D
v2 – QVector3D

Return type:

QVector3D

Returns the unit normal vector of a plane spanned by vectors v1 and v2, which must not be parallel to one another.

Use crossProduct() to compute the cross-product of v1 and v2 if you do not need the result to be normalized to a unit vector.

See also

crossProduct() distanceToPlane()

static normal(v1, v2, v3)

Parameters:

v1 – QVector3D
v2 – QVector3D
v3 – QVector3D

Return type:

QVector3D

Returns the unit normal vector of a plane spanned by vectors v2 - v1 and v3 - v1, which must not be parallel to one another.

Use crossProduct() to compute the cross-product of v2 - v1 and v3 - v1 if you do not need the result to be normalized to a unit vector.

See also

crossProduct() distanceToPlane()

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

normalized()¶

Return type:: QVector3D

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

__ne__(v2)¶

Parameters:: v2 – QVector3D
Return type:: bool

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

__mul__(v2)¶

Parameters:: v2 – QVector3D
Return type:: QVector3D

Returns the QVector3D object formed by multiplying each component of v1 by the corresponding component of v2.

Note

This is not the same as the crossProduct() of v1 and v2. (Its components add up to the dot product of v1 and v2.)