API reference - Class QQuaternion

!=

Signature: [const] bool != (const QQuaternion q2)

Description: Operator bool ::operator!=(const QQuaternion &q1, const QQuaternion &q2)

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

*

(1) Signature: [const] QQuaternion * (const QQuaternion q2)

Description: Operator const QQuaternion ::operator*(const QQuaternion &q1, const QQuaternion &q2)

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

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

(2) Signature: [const] QQuaternion * (float factor)

Description: Operator const QQuaternion ::operator*(const QQuaternion &quaternion, float factor)

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 QVector3D vec)

Description: Operator QVector3D ::operator*(const QQuaternion &quaternion, const QVector3D &vec)

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

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

*=

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

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

(2) Signature: QQuaternion *= (const QQuaternion quaternion)

Description: Method QQuaternion &QQuaternion::operator*=(const QQuaternion &quaternion)

+

Signature: [const] QQuaternion + (const QQuaternion q2)

Description: Operator const QQuaternion ::operator+(const QQuaternion &q1, const QQuaternion &q2)

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

+=

Signature: QQuaternion += (const QQuaternion quaternion)

Description: Method QQuaternion &QQuaternion::operator+=(const QQuaternion &quaternion)

-

(1) Signature: [const] QQuaternion - (const QQuaternion q2)

Description: Operator const QQuaternion ::operator-(const QQuaternion &q1, const QQuaternion &q2)

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

(2) Signature: [const] QQuaternion -

Description: Operator const QQuaternion ::operator-(const QQuaternion &quaternion)

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

-=

Signature: QQuaternion -= (const QQuaternion quaternion)

Description: Method QQuaternion &QQuaternion::operator-=(const QQuaternion &quaternion)

/

Signature: [const] QQuaternion / (float divisor)

Description: Operator const QQuaternion ::operator/(const QQuaternion &quaternion, float divisor)

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

/=

Signature: QQuaternion /= (float divisor)

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

==

Signature: [const] bool == (const QQuaternion q2)

Description: Operator bool ::operator==(const QQuaternion &q1, const QQuaternion &q2)

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

_const_cast

Signature: [const] QQuaternion 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 QQuaternion other)

Description: Assigns another object to self

conjugate

Signature: [const] QQuaternion conjugate

Description: Method QQuaternion QQuaternion::conjugate()

conjugated

Signature: [const] QQuaternion conjugated

Description: Method QQuaternion QQuaternion::conjugated()

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.

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.

dotProduct

Signature: [static] float dotProduct (const QQuaternion q1, const QQuaternion q2)

Description: Static method float QQuaternion::dotProduct(const QQuaternion &q1, const QQuaternion &q2)

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

dup

Signature: [const] new QQuaternion ptr dup

Description: Creates a copy of self

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

fromAxes

Signature: [static] QQuaternion fromAxes (const QVector3D xAxis, const QVector3D yAxis, const QVector3D zAxis)

Description: Static method QQuaternion QQuaternion::fromAxes(const QVector3D &xAxis, const QVector3D &yAxis, const QVector3D &zAxis)

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

fromAxisAndAngle

(1) Signature: [static] QQuaternion fromAxisAndAngle (const QVector3D axis, float angle)

Description: Static method QQuaternion QQuaternion::fromAxisAndAngle(const QVector3D &axis, float angle)

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

(2) Signature: [static] QQuaternion fromAxisAndAngle (float x, float y, float z, float angle)

Description: Static method QQuaternion QQuaternion::fromAxisAndAngle(float x, float y, float z, float angle)

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

fromDirection

Signature: [static] QQuaternion fromDirection (const QVector3D direction, const QVector3D up)

Description: Static method QQuaternion QQuaternion::fromDirection(const QVector3D &direction, const QVector3D &up)

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

fromEulerAngles

(1) Signature: [static] QQuaternion fromEulerAngles (const QVector3D eulerAngles)

Description: Static method QQuaternion QQuaternion::fromEulerAngles(const QVector3D &eulerAngles)

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

(2) Signature: [static] QQuaternion fromEulerAngles (float pitch, float yaw, float roll)

Description: Static method QQuaternion QQuaternion::fromEulerAngles(float pitch, float yaw, float roll)

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

getAxes

Signature: [const] void getAxes (QVector3D ptr xAxis, QVector3D ptr yAxis, QVector3D ptr zAxis)

Description: Method void QQuaternion::getAxes(QVector3D *xAxis, QVector3D *yAxis, QVector3D *zAxis)

getAxisAndAngle

(1) Signature: [const] void getAxisAndAngle (QVector3D ptr axis, float ptr angle)

Description: Method void QQuaternion::getAxisAndAngle(QVector3D *axis, float *angle)

(2) Signature: [const] void getAxisAndAngle (float ptr x, float ptr y, float ptr z, float ptr angle)

Description: Method void QQuaternion::getAxisAndAngle(float *x, float *y, float *z, float *angle)

getEulerAngles

Signature: [const] void getEulerAngles (float ptr pitch, float ptr yaw, float ptr roll)

Description: Method void QQuaternion::getEulerAngles(float *pitch, float *yaw, float *roll)

inverted

Signature: [const] QQuaternion inverted

Description: Method QQuaternion QQuaternion::inverted()

isIdentity?

Signature: [const] bool isIdentity?

Description: Method bool QQuaternion::isIdentity()

isNull?

Signature: [const] bool isNull?

Description: Method bool QQuaternion::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 QQuaternion::length()

lengthSquared

Signature: [const] float lengthSquared

Description: Method float QQuaternion::lengthSquared()

new

(1) Signature: [static] new QQuaternion new

Description: Constructor QQuaternion::QQuaternion()

This method creates an object of class QQuaternion.

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

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

Description: Constructor QQuaternion::QQuaternion(float scalar, float xpos, float ypos, float zpos)

This method creates an object of class QQuaternion.

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

(3) Signature: [static] new QQuaternion new (float scalar, const QVector3D vector)

Description: Constructor QQuaternion::QQuaternion(float scalar, const QVector3D &vector)

This method creates an object of class QQuaternion.

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

(4) Signature: [static] new QQuaternion new (const QVector4D vector)

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

This method creates an object of class QQuaternion.

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

nlerp

Signature: [static] QQuaternion nlerp (const QQuaternion q1, const QQuaternion q2, float t)

Description: Static method QQuaternion QQuaternion::nlerp(const QQuaternion &q1, const QQuaternion &q2, float t)

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

normalize

Signature: void normalize

Description: Method void QQuaternion::normalize()

normalized

Signature: [const] QQuaternion normalized

Description: Method QQuaternion QQuaternion::normalized()

rotatedVector

Signature: [const] QVector3D rotatedVector (const QVector3D vector)

Description: Method QVector3D QQuaternion::rotatedVector(const QVector3D &vector)

rotationTo

Signature: [static] QQuaternion rotationTo (const QVector3D from, const QVector3D to)

Description: Static method QQuaternion QQuaternion::rotationTo(const QVector3D &from, const QVector3D &to)

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

scalar

Signature: [const] float scalar

Description: Method float QQuaternion::scalar()

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

scalar=

Signature: void scalar= (float scalar)

Description: Method void QQuaternion::setScalar(float scalar)

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

setScalar

Signature: void setScalar (float scalar)

Description: Method void QQuaternion::setScalar(float scalar)

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

setVector

(1) Signature: void setVector (const QVector3D vector)

Description: Method void QQuaternion::setVector(const QVector3D &vector)

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

(2) Signature: void setVector (float x, float y, float z)

Description: Method void QQuaternion::setVector(float x, float y, float z)

setX

Signature: void setX (float x)

Description: Method void QQuaternion::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 QQuaternion::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 QQuaternion::setZ(float z)

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

slerp

Signature: [static] QQuaternion slerp (const QQuaternion q1, const QQuaternion q2, float t)

Description: Static method QQuaternion QQuaternion::slerp(const QQuaternion &q1, const QQuaternion &q2, float t)

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

toEulerAngles

Signature: [const] QVector3D toEulerAngles

Description: Method QVector3D QQuaternion::toEulerAngles()

toVector4D

Signature: [const] QVector4D toVector4D

Description: Method QVector4D QQuaternion::toVector4D()

vector

Signature: [const] QVector3D vector

Description: Method QVector3D QQuaternion::vector()

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

vector=

Signature: void vector= (const QVector3D vector)

Description: Method void QQuaternion::setVector(const QVector3D &vector)

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

x

Signature: [const] float x

Description: Method float QQuaternion::x()

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

x=

Signature: void x= (float x)

Description: Method void QQuaternion::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 QQuaternion::y()

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

y=

Signature: void y= (float y)

Description: Method void QQuaternion::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 QQuaternion::z()

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

z=

Signature: void z= (float z)

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

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