API reference - Class QVector3D

!=

Signature: [const] bool != (const QVector3D v2)

Description: Operator bool ::operator!=(const QVector3D &v1, const QVector3D &v2)

This is the mapping of the global operator to the instance method.

*

(1) Signature: [const] QVector3D * (float factor)

Description: Operator const QVector3D ::operator*(const QVector3D &vector, float factor)

This is the mapping of the global operator to the instance method.

Python specific notes:
This method also implements '__rmul__'.

(2) Signature: [const] QVector3D * (const QVector3D v2)

Description: Operator const QVector3D ::operator*(const QVector3D &v1, const QVector3D &v2)

This is the mapping of the global operator to the instance method.

Python specific notes:
This method also implements '__rmul__'.

(3) Signature: [const] QVector3D * (const QMatrix4x4 matrix)

Description: Operator QVector3D ::operator*(const QVector3D &vector, const QMatrix4x4 &matrix)

This is the mapping of the global operator to the instance method.

Python specific notes:
This method also implements '__rmul__'.

*=

(1) Signature: QVector3D *= (float factor)

Description: Method QVector3D &QVector3D::operator*=(float factor)

(2) Signature: QVector3D *= (const QVector3D vector)

Description: Method QVector3D &QVector3D::operator*=(const QVector3D &vector)

+

Signature: [const] QVector3D + (const QVector3D v2)

Description: Operator const QVector3D ::operator+(const QVector3D &v1, const QVector3D &v2)

This is the mapping of the global operator to the instance method.

+=

Signature: QVector3D += (const QVector3D vector)

Description: Method QVector3D &QVector3D::operator+=(const QVector3D &vector)

-

(1) Signature: [const] QVector3D - (const QVector3D v2)

Description: Operator const QVector3D ::operator-(const QVector3D &v1, const QVector3D &v2)

This is the mapping of the global operator to the instance method.

(2) Signature: [const] QVector3D -

Description: Operator const QVector3D ::operator-(const QVector3D &vector)

This is the mapping of the global operator to the instance method.

-=

Signature: QVector3D -= (const QVector3D vector)

Description: Method QVector3D &QVector3D::operator-=(const QVector3D &vector)

/

(1) Signature: [const] QVector3D / (float divisor)

Description: Operator const QVector3D ::operator/(const QVector3D &vector, float divisor)

This is the mapping of the global operator to the instance method.

(2) Signature: [const] QVector3D / (const QVector3D divisor)

Description: Operator const QVector3D ::operator/(const QVector3D &vector, const QVector3D &divisor)

This is the mapping of the global operator to the instance method.

/=

(1) Signature: QVector3D /= (float divisor)

Description: Method QVector3D &QVector3D::operator/=(float divisor)

(2) Signature: QVector3D /= (const QVector3D vector)

Description: Method QVector3D &QVector3D::operator/=(const QVector3D &vector)

==

Signature: [const] bool == (const QVector3D v2)

Description: Operator bool ::operator==(const QVector3D &v1, const QVector3D &v2)

This is the mapping of the global operator to the instance method.

[]

(1) Signature: float [] (int i)

Description: Method float &QVector3D::operator[](int i)

(2) Signature: [const] float [] (int i)

Description: Method float QVector3D::operator[](int i)

_const_cast

Signature: [const] QVector3D ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QVector3D other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

crossProduct

Signature: [static] QVector3D crossProduct (const QVector3D v1, const QVector3D v2)

Description: Static method QVector3D QVector3D::crossProduct(const QVector3D &v1, const QVector3D &v2)

This method is static and can be called without an instance.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

distanceToLine

Signature: [const] float distanceToLine (const QVector3D point, const QVector3D direction)

Description: Method float QVector3D::distanceToLine(const QVector3D &point, const QVector3D &direction)

distanceToPlane

(1) Signature: [const] float distanceToPlane (const QVector3D plane, const QVector3D normal)

Description: Method float QVector3D::distanceToPlane(const QVector3D &plane, const QVector3D &normal)

(2) Signature: [const] float distanceToPlane (const QVector3D plane1, const QVector3D plane2, const QVector3D plane3)

Description: Method float QVector3D::distanceToPlane(const QVector3D &plane1, const QVector3D &plane2, const QVector3D &plane3)

distanceToPoint

Signature: [const] float distanceToPoint (const QVector3D point)

Description: Method float QVector3D::distanceToPoint(const QVector3D &point)

dotProduct

Signature: [static] float dotProduct (const QVector3D v1, const QVector3D v2)

Description: Static method float QVector3D::dotProduct(const QVector3D &v1, const QVector3D &v2)

This method is static and can be called without an instance.

dup

Signature: [const] new QVector3D ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

isNull?

Signature: [const] bool isNull?

Description: Method bool QVector3D::isNull()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

length

Signature: [const] float length

Description: Method float QVector3D::length()

lengthSquared

Signature: [const] float lengthSquared

Description: Method float QVector3D::lengthSquared()

new

(1) Signature: [static] new QVector3D new

Description: Constructor QVector3D::QVector3D()

This method creates an object of class QVector3D.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QVector3D new (float xpos, float ypos, float zpos)

Description: Constructor QVector3D::QVector3D(float xpos, float ypos, float zpos)

This method creates an object of class QVector3D.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QVector3D new (const QPoint point)

Description: Constructor QVector3D::QVector3D(const QPoint &point)

This method creates an object of class QVector3D.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QVector3D new (const QPointF point)

Description: Constructor QVector3D::QVector3D(const QPointF &point)

This method creates an object of class QVector3D.

Python specific notes:
This method is the default initializer of the object.

(5) Signature: [static] new QVector3D new (const QVector2D vector)

Description: Constructor QVector3D::QVector3D(const QVector2D &vector)

This method creates an object of class QVector3D.

Python specific notes:
This method is the default initializer of the object.

(6) Signature: [static] new QVector3D new (const QVector2D vector, float zpos)

Description: Constructor QVector3D::QVector3D(const QVector2D &vector, float zpos)

This method creates an object of class QVector3D.

Python specific notes:
This method is the default initializer of the object.

(7) Signature: [static] new QVector3D new (const QVector4D vector)

Description: Constructor QVector3D::QVector3D(const QVector4D &vector)

This method creates an object of class QVector3D.

Python specific notes:
This method is the default initializer of the object.

normal

(1) Signature: [static] QVector3D normal (const QVector3D v1, const QVector3D v2)

Description: Static method QVector3D QVector3D::normal(const QVector3D &v1, const QVector3D &v2)

This method is static and can be called without an instance.

(2) Signature: [static] QVector3D normal (const QVector3D v1, const QVector3D v2, const QVector3D v3)

Description: Static method QVector3D QVector3D::normal(const QVector3D &v1, const QVector3D &v2, const QVector3D &v3)

This method is static and can be called without an instance.

normalize

Signature: void normalize

Description: Method void QVector3D::normalize()

normalized

Signature: [const] QVector3D normalized

Description: Method QVector3D QVector3D::normalized()

project

Signature: [const] QVector3D project (const QMatrix4x4 modelView, const QMatrix4x4 projection, const QRect viewport)

Description: Method QVector3D QVector3D::project(const QMatrix4x4 &modelView, const QMatrix4x4 &projection, const QRect &viewport)

setX

Signature: void setX (float x)

Description: Method void QVector3D::setX(float x)

Python specific notes:
The object exposes a writable attribute 'x'. This is the setter.

setY

Signature: void setY (float y)

Description: Method void QVector3D::setY(float y)

Python specific notes:
The object exposes a writable attribute 'y'. This is the setter.

setZ

Signature: void setZ (float z)

Description: Method void QVector3D::setZ(float z)

Python specific notes:
The object exposes a writable attribute 'z'. This is the setter.

toPoint

Signature: [const] QPoint toPoint

Description: Method QPoint QVector3D::toPoint()

toPointF

Signature: [const] QPointF toPointF

Description: Method QPointF QVector3D::toPointF()

toVector2D

Signature: [const] QVector2D toVector2D

Description: Method QVector2D QVector3D::toVector2D()

toVector4D

Signature: [const] QVector4D toVector4D

Description: Method QVector4D QVector3D::toVector4D()

unproject

Signature: [const] QVector3D unproject (const QMatrix4x4 modelView, const QMatrix4x4 projection, const QRect viewport)

Description: Method QVector3D QVector3D::unproject(const QMatrix4x4 &modelView, const QMatrix4x4 &projection, const QRect &viewport)

x

Signature: [const] float x

Description: Method float QVector3D::x()

Python specific notes:
The object exposes a readable attribute 'x'. This is the getter.

x=

Signature: void x= (float x)

Description: Method void QVector3D::setX(float x)

Python specific notes:
The object exposes a writable attribute 'x'. This is the setter.

y

Signature: [const] float y

Description: Method float QVector3D::y()

Python specific notes:
The object exposes a readable attribute 'y'. This is the getter.

y=

Signature: void y= (float y)

Description: Method void QVector3D::setY(float y)

Python specific notes:
The object exposes a writable attribute 'y'. This is the setter.

z

Signature: [const] float z

Description: Method float QVector3D::z()

Python specific notes:
The object exposes a readable attribute 'z'. This is the getter.

z=

Signature: void z= (float z)

Description: Method void QVector3D::setZ(float z)

Python specific notes:
The object exposes a writable attribute 'z'. This is the setter.