API reference - Class QPointF

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QPointF

Public constructors

new QPointFnewConstructor QPointF::QPointF()
new QPointFnew(const QPoint p)Constructor QPointF::QPointF(const QPoint &p)
new QPointFnew(double xpos,
double ypos)
Constructor QPointF::QPointF(double xpos, double ypos)

Public methods

[const]bool!=(const QPointF p2)Operator bool ::operator!=(const QPointF &p1, const QPointF &p2)
[const]QPointF*(double c)Operator const QPointF ::operator*(const QPointF &p, qreal c)
QPointF*=(double c)Method QPointF &QPointF::operator*=(double c)
[const]QPointF+(const QPointF p2)Operator const QPointF ::operator+(const QPointF &p1, const QPointF &p2)
[const]QPointF+Operator const QPointF ::operator+(const QPointF &p)
QPointF+=(const QPointF p)Method QPointF &QPointF::operator+=(const QPointF &p)
[const]QPointF-(const QPointF p2)Operator const QPointF ::operator-(const QPointF &p1, const QPointF &p2)
[const]QPointF-Operator const QPointF ::operator-(const QPointF &p)
QPointF-=(const QPointF p)Method QPointF &QPointF::operator-=(const QPointF &p)
[const]QPointF/(double divisor)Operator const QPointF ::operator/(const QPointF &p, qreal divisor)
QPointF/=(double c)Method QPointF &QPointF::operator/=(double c)
[const]bool==(const QPointF p2)Operator bool ::operator==(const QPointF &p1, const QPointF &p2)
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const QPointF other)Assigns another object to self
[const]new QPointF ptrdupCreates a copy of self
[const]boolisNull?Method bool QPointF::isNull()
[const]doublemanhattanLengthMethod double QPointF::manhattanLength()
doublerxMethod double &QPointF::rx()
doubleryMethod double &QPointF::ry()
voidsetX(double x)Method void QPointF::setX(double x)
voidsetY(double y)Method void QPointF::setY(double y)
[const]QPointtoPointMethod QPoint QPointF::toPoint()
[const]doublexMethod double QPointF::x()
voidx=(double x)Method void QPointF::setX(double x)
[const]doubleyMethod double QPointF::y()
voidy=(double y)Method void QPointF::setY(double y)

Public static methods and constants

doubledotProduct(const QPointF p1,
const QPointF p2)
Static method double QPointF::dotProduct(const QPointF &p1, const QPointF &p2)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QPointF p2)

Description: Operator bool ::operator!=(const QPointF &p1, const QPointF &p2)

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

*

Signature: [const] QPointF * (double c)

Description: Operator const QPointF ::operator*(const QPointF &p, qreal c)

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

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

*=

Signature: QPointF *= (double c)

Description: Method QPointF &QPointF::operator*=(double c)

+

(1) Signature: [const] QPointF + (const QPointF p2)

Description: Operator const QPointF ::operator+(const QPointF &p1, const QPointF &p2)

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

(2) Signature: [const] QPointF +

Description: Operator const QPointF ::operator+(const QPointF &p)

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

+=

Signature: QPointF += (const QPointF p)

Description: Method QPointF &QPointF::operator+=(const QPointF &p)

-

(1) Signature: [const] QPointF - (const QPointF p2)

Description: Operator const QPointF ::operator-(const QPointF &p1, const QPointF &p2)

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

(2) Signature: [const] QPointF -

Description: Operator const QPointF ::operator-(const QPointF &p)

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

-=

Signature: QPointF -= (const QPointF p)

Description: Method QPointF &QPointF::operator-=(const QPointF &p)

/

Signature: [const] QPointF / (double divisor)

Description: Operator const QPointF ::operator/(const QPointF &p, qreal divisor)

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

/=

Signature: QPointF /= (double c)

Description: Method QPointF &QPointF::operator/=(double c)

==

Signature: [const] bool == (const QPointF p2)

Description: Operator bool ::operator==(const QPointF &p1, const QPointF &p2)

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

_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 QPointF 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.

dotProduct

Signature: [static] double dotProduct (const QPointF p1, const QPointF p2)

Description: Static method double QPointF::dotProduct(const QPointF &p1, const QPointF &p2)

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

dup

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

manhattanLength

Signature: [const] double manhattanLength

Description: Method double QPointF::manhattanLength()

new

(1) Signature: [static] new QPointF new

Description: Constructor QPointF::QPointF()

This method creates an object of class QPointF.

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

(2) Signature: [static] new QPointF new (const QPoint p)

Description: Constructor QPointF::QPointF(const QPoint &p)

This method creates an object of class QPointF.

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

(3) Signature: [static] new QPointF new (double xpos, double ypos)

Description: Constructor QPointF::QPointF(double xpos, double ypos)

This method creates an object of class QPointF.

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

rx

Signature: double rx

Description: Method double &QPointF::rx()

ry

Signature: double ry

Description: Method double &QPointF::ry()

setX

Signature: void setX (double x)

Description: Method void QPointF::setX(double x)

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

setY

Signature: void setY (double y)

Description: Method void QPointF::setY(double y)

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

toPoint

Signature: [const] QPoint toPoint

Description: Method QPoint QPointF::toPoint()

x

Signature: [const] double x

Description: Method double QPointF::x()

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

x=

Signature: void x= (double x)

Description: Method void QPointF::setX(double x)

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

y

Signature: [const] double y

Description: Method double QPointF::y()

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

y=

Signature: void y= (double y)

Description: Method void QPointF::setY(double y)

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