QVector3D¶

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

New in version 4.6.

Synopsis¶

Functions¶

def __add__ (, v2)
def __div__ (, divisor)
def __div__ (, divisor)
def __eq__ (, v2)
def __iadd__ (vector)
def __idiv__ (divisor)
def __idiv__ (vector)
def __imul__ (factor)
def __imul__ (vector)
def __isub__ (vector)
def __mul__ (, factor)
def __mul__ (, matrix)
def __mul__ (, v2)
def __mul__ (factor)
def __mul__ (matrix)
def __mul__ (quaternion)
def __ne__ (, v2)
def __reduce__ ()
def __repr__ ()
def __sub__ ()
def __sub__ (, v2)
def distanceToLine (point, direction)
def distanceToPlane (plane, normal)
def distanceToPlane (plane1, plane2, plane3)
def distanceToPoint (point)
def isNull ()
def length ()
def lengthSquared ()
def normalize ()
def normalized ()
def operator[] (i)
def project (modelView, projection, viewport)
def setX (x)
def setY (y)
def setZ (z)
def toPoint ()
def toPointF ()
def toTuple ()
def toVector2D ()
def toVector4D ()
def unproject (modelView, projection, viewport)
def x ()
def y ()
def z ()

Static functions¶

def crossProduct (v1, v2)
def dotProduct (v1, v2)
def normal (v1, v2)
def normal (v1, v2, v3)

Detailed Description¶

Vectors are one of the main building blocks of 3D representation and drawing. They consist of three 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

class PySide2.QtGui.QVector3D¶

PySide2.QtGui.QVector3D(point)

PySide2.QtGui.QVector3D(point)

PySide2.QtGui.QVector3D(vector)

PySide2.QtGui.QVector3D(vector, zpos)

PySide2.QtGui.QVector3D(vector)

PySide2.QtGui.QVector3D(xpos, ypos, zpos)

param ypos:

float

param point:

PySide2.QtCore.QPoint

param zpos:

float

param vector:

PySide2.QtGui.QVector2D

param xpos:

float

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

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

See also

toVector2D()

Constructs a vector with coordinates (xpos , ypos , zpos ).

PySide2.QtGui.QVector3D.__reduce__()¶

Return type:: object

PySide2.QtGui.QVector3D.__repr__()¶

Return type:: object

static PySide2.QtGui.QVector3D.crossProduct(v1, v2)¶

Parameters:

v1 – PySide2.QtGui.QVector3D
v2 – PySide2.QtGui.QVector3D

Return type:

PySide2.QtGui.QVector3D

Returns the cross-product of vectors v1 and v2 , which corresponds to the normal vector of a plane defined by v1 and v2 .

See also

normal()

PySide2.QtGui.QVector3D.distanceToLine(point, direction)¶

Parameters:

point – PySide2.QtGui.QVector3D
direction – PySide2.QtGui.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()

PySide2.QtGui.QVector3D.distanceToPlane(plane, normal)¶

Parameters:

plane – PySide2.QtGui.QVector3D
normal – PySide2.QtGui.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()

PySide2.QtGui.QVector3D.distanceToPlane(plane1, plane2, plane3)

Parameters:

plane1 – PySide2.QtGui.QVector3D
plane2 – PySide2.QtGui.QVector3D
plane3 – PySide2.QtGui.QVector3D

Return type:

float

This is an overloaded function.

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

PySide2.QtGui.QVector3D.distanceToPoint(point)¶

Parameters:: point – PySide2.QtGui.QVector3D
Return type:: float

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

See also

distanceToPlane() distanceToLine()

static PySide2.QtGui.QVector3D.dotProduct(v1, v2)¶

Parameters:

v1 – PySide2.QtGui.QVector3D
v2 – PySide2.QtGui.QVector3D

Return type:

float

Returns the dot product of v1 and v2 .

PySide2.QtGui.QVector3D.isNull()¶

Return type:: bool

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

PySide2.QtGui.QVector3D.length()¶

Return type:: float

Returns the length of the vector from the origin.

See also

lengthSquared() normalized()

PySide2.QtGui.QVector3D.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 PySide2.QtGui.QVector3D.normal(v1, v2)¶

Parameters:

v1 – PySide2.QtGui.QVector3D
v2 – PySide2.QtGui.QVector3D

Return type:

PySide2.QtGui.QVector3D

Returns the normal vector of a plane defined by vectors v1 and v2 , normalized to be a unit vector.

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 PySide2.QtGui.QVector3D.normal(v1, v2, v3)

Parameters:

v1 – PySide2.QtGui.QVector3D
v2 – PySide2.QtGui.QVector3D
v3 – PySide2.QtGui.QVector3D

Return type:

PySide2.QtGui.QVector3D

This is an overloaded function.

Returns the normal vector of a plane defined by vectors v2 - v1 and v3 - v1 , normalized to be a unit vector.

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

PySide2.QtGui.QVector3D.normalize()¶: Normalizes the currect 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()

PySide2.QtGui.QVector3D.normalized()¶

Return type:: PySide2.QtGui.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()

PySide2.QtGui.QVector3D.__ne__(v2)¶

Parameters:: v2 – PySide2.QtGui.QVector3D
Return type:: bool

PySide2.QtGui.QVector3D.__mul__(factor)¶

Parameters:: factor – float
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__mul__(factor)

Parameters:: factor – float
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__mul__(v2)

Parameters:: v2 – PySide2.QtGui.QVector3D
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__mul__(matrix)

Parameters:: matrix – PySide2.QtGui.QMatrix4x4
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__mul__(matrix)

Parameters:: matrix – PySide2.QtGui.QMatrix4x4
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__mul__(quaternion)

Parameters:: quaternion – PySide2.QtGui.QQuaternion
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__imul__(vector)¶

Parameters:: vector – PySide2.QtGui.QVector3D
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__imul__(factor)

Parameters:: factor – float
Return type:: PySide2.QtGui.QVector3D

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

See also

operator/=()

PySide2.QtGui.QVector3D.__add__(v2)¶

Parameters:: v2 – PySide2.QtGui.QVector3D
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__iadd__(vector)¶

Parameters:: vector – PySide2.QtGui.QVector3D
Return type:: PySide2.QtGui.QVector3D

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

See also

operator-=()

PySide2.QtGui.QVector3D.__sub__()¶

Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__sub__(v2)

Parameters:: v2 – PySide2.QtGui.QVector3D
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__isub__(vector)¶

Parameters:: vector – PySide2.QtGui.QVector3D
Return type:: PySide2.QtGui.QVector3D

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

See also

operator+=()

PySide2.QtGui.QVector3D.__div__(divisor)¶

Parameters:: divisor – PySide2.QtGui.QVector3D
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__div__(divisor)

Parameters:: divisor – float
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__idiv__(vector)¶

Parameters:: vector – PySide2.QtGui.QVector3D
Return type:: PySide2.QtGui.QVector3D

PySide2.QtGui.QVector3D.__idiv__(divisor)

Parameters:: divisor – float
Return type:: PySide2.QtGui.QVector3D

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

See also

operator*=()

PySide2.QtGui.QVector3D.__eq__(v2)¶

Parameters:: v2 – PySide2.QtGui.QVector3D
Return type:: bool

PySide2.QtGui.QVector3D.operator[](i)

Parameters:: i – int
Return type:: float

Returns the component of the vector at index position i .

i must be a valid index position in the vector (i.e., 0 <= i < 3).

PySide2.QtGui.QVector3D.project(modelView, projection, viewport)¶

Parameters:

modelView – PySide2.QtGui.QMatrix4x4
projection – PySide2.QtGui.QMatrix4x4
viewport – PySide2.QtCore.QRect

Return type:

PySide2.QtGui.QVector3D

Returns the window coordinates of this vector initially in object/model coordinates using the model view matrix modelView , the projection matrix projection and the viewport dimensions viewport .

When transforming from clip to normalized space, a division by the w component on the vector components takes place. To prevent dividing by 0 if w equals to 0, it is set to 1.

Note

the returned y coordinates are in OpenGL orientation. OpenGL expects the bottom to be 0 whereas for Qt top is 0.

See also

unproject()

PySide2.QtGui.QVector3D.setX(x)¶

Parameters:: x – float

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

See also

x() setY() setZ()

PySide2.QtGui.QVector3D.setY(y)¶

Parameters:: y – float

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

See also

y() setX() setZ()

PySide2.QtGui.QVector3D.setZ(z)¶

Parameters:: z – float

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

See also

z() setX() setY()

PySide2.QtGui.QVector3D.toPoint()¶

Return type:: PySide2.QtCore.QPoint

Returns the QPoint form of this 3D vector. The z coordinate is dropped.

See also

toPointF() toVector2D()

PySide2.QtGui.QVector3D.toPointF()¶

Return type:: PySide2.QtCore.QPointF

Returns the QPointF form of this 3D vector. The z coordinate is dropped.

See also

toPoint() toVector2D()

PySide2.QtGui.QVector3D.toTuple()¶

Return type:: object

PySide2.QtGui.QVector3D.toVector2D()¶

Return type:: PySide2.QtGui.QVector2D

Returns the 2D vector form of this 3D vector, dropping the z coordinate.

See also

toVector4D() toPoint()

PySide2.QtGui.QVector3D.toVector4D()¶

Return type:: PySide2.QtGui.QVector4D

Returns the 4D form of this 3D vector, with the w coordinate set to zero.

See also

toVector2D() toPoint()

PySide2.QtGui.QVector3D.unproject(modelView, projection, viewport)¶

Parameters:

modelView – PySide2.QtGui.QMatrix4x4
projection – PySide2.QtGui.QMatrix4x4
viewport – PySide2.QtCore.QRect

Return type:

PySide2.QtGui.QVector3D

Returns the object/model coordinates of this vector initially in window coordinates using the model view matrix modelView , the projection matrix projection and the viewport dimensions viewport .

When transforming from clip to normalized space, a division by the w component of the vector components takes place. To prevent dividing by 0 if w equals to 0, it is set to 1.

Note

y coordinates in viewport should use OpenGL orientation. OpenGL expects the bottom to be 0 whereas for Qt top is 0.

See also

project()

PySide2.QtGui.QVector3D.x()¶

Return type:: float

Returns the x coordinate of this point.

See also

setX() y() z()

PySide2.QtGui.QVector3D.y()¶

Return type:: float

Returns the y coordinate of this point.

See also

setY() x() z()

PySide2.QtGui.QVector3D.z()¶

Return type:: float

Returns the z coordinate of this point.

See also

setZ() x() y()

Table of Contents

Previous topic

Next topic

QVector3D¶

Synopsis¶

Functions¶

Static functions¶

Detailed Description¶