API reference - Class QVector2D

!=

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

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

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

*

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

Description: Operator const QVector2D ::operator*(const QVector2D &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] QVector2D * (const QVector2D v2)

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

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

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

*=

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

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

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

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

+

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

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

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

+=

Signature: QVector2D += (const QVector2D vector)

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

-

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

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

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

(2) Signature: [const] QVector2D -

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

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

-=

Signature: QVector2D -= (const QVector2D vector)

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

/

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

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

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

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

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

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

/=

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

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

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

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

==

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

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

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

[]

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

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

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

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

_const_cast

Signature: [const] QVector2D 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 QVector2D 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.

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 QVector2D point, const QVector2D direction)

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

distanceToPoint

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

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

dotProduct

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

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

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

dup

Signature: [const] new QVector2D 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 QVector2D::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 QVector2D::length()

lengthSquared

Signature: [const] float lengthSquared

Description: Method float QVector2D::lengthSquared()

new

(1) Signature: [static] new QVector2D new

Description: Constructor QVector2D::QVector2D()

This method creates an object of class QVector2D.

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

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

Description: Constructor QVector2D::QVector2D(float xpos, float ypos)

This method creates an object of class QVector2D.

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

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

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

This method creates an object of class QVector2D.

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

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

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

This method creates an object of class QVector2D.

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

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

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

This method creates an object of class QVector2D.

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

(6) Signature: [static] new QVector2D new (const QVector4D vector)

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

This method creates an object of class QVector2D.

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

normalize

Signature: void normalize

Description: Method void QVector2D::normalize()

normalized

Signature: [const] QVector2D normalized

Description: Method QVector2D QVector2D::normalized()

setX

Signature: void setX (float x)

Description: Method void QVector2D::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 QVector2D::setY(float y)

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

toPoint

Signature: [const] QPoint toPoint

Description: Method QPoint QVector2D::toPoint()

toPointF

Signature: [const] QPointF toPointF

Description: Method QPointF QVector2D::toPointF()

toVector3D

Signature: [const] QVector3D toVector3D

Description: Method QVector3D QVector2D::toVector3D()

toVector4D

Signature: [const] QVector4D toVector4D

Description: Method QVector4D QVector2D::toVector4D()

x

Signature: [const] float x

Description: Method float QVector2D::x()

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

x=

Signature: void x= (float x)

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

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

y=

Signature: void y= (float y)

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

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