API reference - Class QLineF

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QLineF

Sub-classes: IntersectType, QFlags_IntersectType

Public constructors

new QLineFnewConstructor QLineF::QLineF()
new QLineFnew(const QPointF pt1,
const QPointF pt2)
Constructor QLineF::QLineF(const QPointF &pt1, const QPointF &pt2)
new QLineFnew(double x1,
double y1,
double x2,
double y2)
Constructor QLineF::QLineF(double x1, double y1, double x2, double y2)
new QLineFnew(const QLine line)Constructor QLineF::QLineF(const QLine &line)

Public methods

[const]bool!=(const QLineF d)Method bool QLineF::operator!=(const QLineF &d)
[const]bool==(const QLineF d)Method bool QLineF::operator==(const QLineF &d)
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.
[const]doubleangleMethod double QLineF::angle()
[const]doubleangle(const QLineF l)Method double QLineF::angle(const QLineF &l)
voidangle=(double angle)Method void QLineF::setAngle(double angle)
[const]doubleangleTo(const QLineF l)Method double QLineF::angleTo(const QLineF &l)
voidassign(const QLineF other)Assigns another object to self
[const]new QLineF ptrdupCreates a copy of self
[const]doubledxMethod double QLineF::dx()
[const]doubledyMethod double QLineF::dy()
[const]QLineF_IntersectTypeintersect(const QLineF l,
QPointF ptr intersectionPoint)
Method QLineF::IntersectType QLineF::intersect(const QLineF &l, QPointF *intersectionPoint)
[const]boolisNull?Method bool QLineF::isNull()
[const]doublelengthMethod double QLineF::length()
voidlength=(double len)Method void QLineF::setLength(double len)
[const]QLineFnormalVectorMethod QLineF QLineF::normalVector()
[const]QPointFp1Method QPointF QLineF::p1()
voidp1=(const QPointF p1)Method void QLineF::setP1(const QPointF &p1)
[const]QPointFp2Method QPointF QLineF::p2()
voidp2=(const QPointF p2)Method void QLineF::setP2(const QPointF &p2)
[const]QPointFpointAt(double t)Method QPointF QLineF::pointAt(double t)
voidsetAngle(double angle)Method void QLineF::setAngle(double angle)
voidsetLength(double len)Method void QLineF::setLength(double len)
voidsetLine(double x1,
double y1,
double x2,
double y2)
Method void QLineF::setLine(double x1, double y1, double x2, double y2)
voidsetP1(const QPointF p1)Method void QLineF::setP1(const QPointF &p1)
voidsetP2(const QPointF p2)Method void QLineF::setP2(const QPointF &p2)
voidsetPoints(const QPointF p1,
const QPointF p2)
Method void QLineF::setPoints(const QPointF &p1, const QPointF &p2)
[const]QLinetoLineMethod QLine QLineF::toLine()
voidtranslate(const QPointF p)Method void QLineF::translate(const QPointF &p)
voidtranslate(double dx,
double dy)
Method void QLineF::translate(double dx, double dy)
[const]QLineFtranslated(const QPointF p)Method QLineF QLineF::translated(const QPointF &p)
[const]QLineFtranslated(double dx,
double dy)
Method QLineF QLineF::translated(double dx, double dy)
[const]QLineFunitVectorMethod QLineF QLineF::unitVector()
[const]doublex1Method double QLineF::x1()
[const]doublex2Method double QLineF::x2()
[const]doubley1Method double QLineF::y1()
[const]doubley2Method double QLineF::y2()

Public static methods and constants

[static,const]QLineF_IntersectTypeBoundedIntersectionEnum constant QLineF::BoundedIntersection
[static,const]QLineF_IntersectTypeNoIntersectionEnum constant QLineF::NoIntersection
[static,const]QLineF_IntersectTypeUnboundedIntersectionEnum constant QLineF::UnboundedIntersection
QLineFfromPolar(double length,
double angle)
Static method QLineF QLineF::fromPolar(double length, double angle)

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 QLineF d)

Description: Method bool QLineF::operator!=(const QLineF &d)

==

Signature: [const] bool == (const QLineF d)

Description: Method bool QLineF::operator==(const QLineF &d)

BoundedIntersection

Signature: [static,const] QLineF_IntersectType BoundedIntersection

Description: Enum constant QLineF::BoundedIntersection

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

NoIntersection

Signature: [static,const] QLineF_IntersectType NoIntersection

Description: Enum constant QLineF::NoIntersection

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

UnboundedIntersection

Signature: [static,const] QLineF_IntersectType UnboundedIntersection

Description: Enum constant QLineF::UnboundedIntersection

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

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

angle

(1) Signature: [const] double angle

Description: Method double QLineF::angle()

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

(2) Signature: [const] double angle (const QLineF l)

Description: Method double QLineF::angle(const QLineF &l)

Python specific notes:
This method is available as 'angle_' in Python to distiguish it from the property with the same name.

angle=

Signature: void angle= (double angle)

Description: Method void QLineF::setAngle(double angle)

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

angleTo

Signature: [const] double angleTo (const QLineF l)

Description: Method double QLineF::angleTo(const QLineF &l)

assign

Signature: void assign (const QLineF 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.

dup

Signature: [const] new QLineF ptr dup

Description: Creates a copy of self

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

dx

Signature: [const] double dx

Description: Method double QLineF::dx()

dy

Signature: [const] double dy

Description: Method double QLineF::dy()

fromPolar

Signature: [static] QLineF fromPolar (double length, double angle)

Description: Static method QLineF QLineF::fromPolar(double length, double angle)

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

intersect

Signature: [const] QLineF_IntersectType intersect (const QLineF l, QPointF ptr intersectionPoint)

Description: Method QLineF::IntersectType QLineF::intersect(const QLineF &l, QPointF *intersectionPoint)

isNull?

Signature: [const] bool isNull?

Description: Method bool QLineF::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] double length

Description: Method double QLineF::length()

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

length=

Signature: void length= (double len)

Description: Method void QLineF::setLength(double len)

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

new

(1) Signature: [static] new QLineF new

Description: Constructor QLineF::QLineF()

This method creates an object of class QLineF.

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

(2) Signature: [static] new QLineF new (const QPointF pt1, const QPointF pt2)

Description: Constructor QLineF::QLineF(const QPointF &pt1, const QPointF &pt2)

This method creates an object of class QLineF.

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

(3) Signature: [static] new QLineF new (double x1, double y1, double x2, double y2)

Description: Constructor QLineF::QLineF(double x1, double y1, double x2, double y2)

This method creates an object of class QLineF.

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

(4) Signature: [static] new QLineF new (const QLine line)

Description: Constructor QLineF::QLineF(const QLine &line)

This method creates an object of class QLineF.

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

normalVector

Signature: [const] QLineF normalVector

Description: Method QLineF QLineF::normalVector()

p1

Signature: [const] QPointF p1

Description: Method QPointF QLineF::p1()

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

p1=

Signature: void p1= (const QPointF p1)

Description: Method void QLineF::setP1(const QPointF &p1)

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

p2

Signature: [const] QPointF p2

Description: Method QPointF QLineF::p2()

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

p2=

Signature: void p2= (const QPointF p2)

Description: Method void QLineF::setP2(const QPointF &p2)

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

pointAt

Signature: [const] QPointF pointAt (double t)

Description: Method QPointF QLineF::pointAt(double t)

setAngle

Signature: void setAngle (double angle)

Description: Method void QLineF::setAngle(double angle)

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

setLength

Signature: void setLength (double len)

Description: Method void QLineF::setLength(double len)

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

setLine

Signature: void setLine (double x1, double y1, double x2, double y2)

Description: Method void QLineF::setLine(double x1, double y1, double x2, double y2)

setP1

Signature: void setP1 (const QPointF p1)

Description: Method void QLineF::setP1(const QPointF &p1)

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

setP2

Signature: void setP2 (const QPointF p2)

Description: Method void QLineF::setP2(const QPointF &p2)

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

setPoints

Signature: void setPoints (const QPointF p1, const QPointF p2)

Description: Method void QLineF::setPoints(const QPointF &p1, const QPointF &p2)

toLine

Signature: [const] QLine toLine

Description: Method QLine QLineF::toLine()

translate

(1) Signature: void translate (const QPointF p)

Description: Method void QLineF::translate(const QPointF &p)

(2) Signature: void translate (double dx, double dy)

Description: Method void QLineF::translate(double dx, double dy)

translated

(1) Signature: [const] QLineF translated (const QPointF p)

Description: Method QLineF QLineF::translated(const QPointF &p)

(2) Signature: [const] QLineF translated (double dx, double dy)

Description: Method QLineF QLineF::translated(double dx, double dy)

unitVector

Signature: [const] QLineF unitVector

Description: Method QLineF QLineF::unitVector()

x1

Signature: [const] double x1

Description: Method double QLineF::x1()

x2

Signature: [const] double x2

Description: Method double QLineF::x2()

y1

Signature: [const] double y1

Description: Method double QLineF::y1()

y2

Signature: [const] double y2

Description: Method double QLineF::y2()