KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QMatrix

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QMatrix

Public constructors

new QMatrixnewConstructor QMatrix::QMatrix()
new QMatrixnew(double m11,
double m12,
double m21,
double m22,
double dx,
double dy)
Constructor QMatrix::QMatrix(double m11, double m12, double m21, double m22, double dx, double dy)
new QMatrixnew(const QMatrix other)Constructor QMatrix::QMatrix(const QMatrix &other)

Public methods

[const]bool!=(const QMatrix arg1)Method bool QMatrix::operator!=(const QMatrix &)
[const]QMatrix*(const QMatrix o)Method QMatrix QMatrix::operator*(const QMatrix &o)
QMatrix*=(const QMatrix arg1)Method QMatrix &QMatrix::operator*=(const QMatrix &)
[const]bool==(const QMatrix arg1)Method bool QMatrix::operator==(const QMatrix &)
void_assign(const QMatrix other)Assigns another object to self
[const]QMatrix ptr_const_castReturns a non-const reference to self.
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.
QMatrixassign(const QMatrix arg1)Method QMatrix &QMatrix::operator=(const QMatrix &)
[const]doubledeterminantMethod double QMatrix::determinant()
[const]new QMatrix ptrdupCreates a copy of self
[const]doubledxMethod double QMatrix::dx()
[const]doubledyMethod double QMatrix::dy()
[const]QMatrixinverted(bool ptr invertible = nullptr)Method QMatrix QMatrix::inverted(bool *invertible)
[const]boolisIdentity?Method bool QMatrix::isIdentity()
[const]boolisInvertible?Method bool QMatrix::isInvertible()
[const]doublem11Method double QMatrix::m11()
[const]doublem12Method double QMatrix::m12()
[const]doublem21Method double QMatrix::m21()
[const]doublem22Method double QMatrix::m22()
[const]voidmap(int x,
int y,
int ptr tx,
int ptr ty)
Method void QMatrix::map(int x, int y, int *tx, int *ty)
[const]voidmap(double x,
double y,
double ptr tx,
double ptr ty)
Method void QMatrix::map(double x, double y, double *tx, double *ty)
[const]QPointmap(const QPoint p)Method QPoint QMatrix::map(const QPoint &p)
[const]QPointFmap(const QPointF p)Method QPointF QMatrix::map(const QPointF &p)
[const]QLinemap(const QLine l)Method QLine QMatrix::map(const QLine &l)
[const]QLineFmap(const QLineF l)Method QLineF QMatrix::map(const QLineF &l)
[const]QPolygonFmap(const QPolygonF a)Method QPolygonF QMatrix::map(const QPolygonF &a)
[const]QPolygonmap(const QPolygon a)Method QPolygon QMatrix::map(const QPolygon &a)
[const]QRegionmap(const QRegion r)Method QRegion QMatrix::map(const QRegion &r)
[const]QPainterPathmap(const QPainterPath p)Method QPainterPath QMatrix::map(const QPainterPath &p)
[const]QRectmapRect(const QRect arg1)Method QRect QMatrix::mapRect(const QRect &)
[const]QRectFmapRect(const QRectF arg1)Method QRectF QMatrix::mapRect(const QRectF &)
[const]QPolygonmapToPolygon(const QRect r)Method QPolygon QMatrix::mapToPolygon(const QRect &r)
voidresetMethod void QMatrix::reset()
QMatrixrotate(double a)Method QMatrix &QMatrix::rotate(double a)
QMatrixscale(double sx,
double sy)
Method QMatrix &QMatrix::scale(double sx, double sy)
voidsetMatrix(double m11,
double m12,
double m21,
double m22,
double dx,
double dy)
Method void QMatrix::setMatrix(double m11, double m12, double m21, double m22, double dx, double dy)
QMatrixshear(double sh,
double sv)
Method QMatrix &QMatrix::shear(double sh, double sv)
QMatrixtranslate(double dx,
double dy)
Method QMatrix &QMatrix::translate(double dx, double dy)

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 QMatrix arg1)

Description: Method bool QMatrix::operator!=(const QMatrix &)

*

Signature: [const] QMatrix * (const QMatrix o)

Description: Method QMatrix QMatrix::operator*(const QMatrix &o)

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

*=

Signature: QMatrix *= (const QMatrix arg1)

Description: Method QMatrix &QMatrix::operator*=(const QMatrix &)

==

Signature: [const] bool == (const QMatrix arg1)

Description: Method bool QMatrix::operator==(const QMatrix &)

_assign

Signature: void _assign (const QMatrix other)

Description: Assigns another object to self

_const_cast

Signature: [const] QMatrix 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: QMatrix assign (const QMatrix arg1)

Description: Method QMatrix &QMatrix::operator=(const QMatrix &)

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.

determinant

Signature: [const] double determinant

Description: Method double QMatrix::determinant()

dup

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

dy

Signature: [const] double dy

Description: Method double QMatrix::dy()

inverted

Signature: [const] QMatrix inverted (bool ptr invertible = nullptr)

Description: Method QMatrix QMatrix::inverted(bool *invertible)

isIdentity?

Signature: [const] bool isIdentity?

Description: Method bool QMatrix::isIdentity()

isInvertible?

Signature: [const] bool isInvertible?

Description: Method bool QMatrix::isInvertible()

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.

m11

Signature: [const] double m11

Description: Method double QMatrix::m11()

m12

Signature: [const] double m12

Description: Method double QMatrix::m12()

m21

Signature: [const] double m21

Description: Method double QMatrix::m21()

m22

Signature: [const] double m22

Description: Method double QMatrix::m22()

map

(1) Signature: [const] void map (int x, int y, int ptr tx, int ptr ty)

Description: Method void QMatrix::map(int x, int y, int *tx, int *ty)

(2) Signature: [const] void map (double x, double y, double ptr tx, double ptr ty)

Description: Method void QMatrix::map(double x, double y, double *tx, double *ty)

(3) Signature: [const] QPoint map (const QPoint p)

Description: Method QPoint QMatrix::map(const QPoint &p)

(4) Signature: [const] QPointF map (const QPointF p)

Description: Method QPointF QMatrix::map(const QPointF &p)

(5) Signature: [const] QLine map (const QLine l)

Description: Method QLine QMatrix::map(const QLine &l)

(6) Signature: [const] QLineF map (const QLineF l)

Description: Method QLineF QMatrix::map(const QLineF &l)

(7) Signature: [const] QPolygonF map (const QPolygonF a)

Description: Method QPolygonF QMatrix::map(const QPolygonF &a)

(8) Signature: [const] QPolygon map (const QPolygon a)

Description: Method QPolygon QMatrix::map(const QPolygon &a)

(9) Signature: [const] QRegion map (const QRegion r)

Description: Method QRegion QMatrix::map(const QRegion &r)

(10) Signature: [const] QPainterPath map (const QPainterPath p)

Description: Method QPainterPath QMatrix::map(const QPainterPath &p)

mapRect

(1) Signature: [const] QRect mapRect (const QRect arg1)

Description: Method QRect QMatrix::mapRect(const QRect &)

(2) Signature: [const] QRectF mapRect (const QRectF arg1)

Description: Method QRectF QMatrix::mapRect(const QRectF &)

mapToPolygon

Signature: [const] QPolygon mapToPolygon (const QRect r)

Description: Method QPolygon QMatrix::mapToPolygon(const QRect &r)

new

(1) Signature: [static] new QMatrix new

Description: Constructor QMatrix::QMatrix()

This method creates an object of class QMatrix.

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

(2) Signature: [static] new QMatrix new (double m11, double m12, double m21, double m22, double dx, double dy)

Description: Constructor QMatrix::QMatrix(double m11, double m12, double m21, double m22, double dx, double dy)

This method creates an object of class QMatrix.

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

(3) Signature: [static] new QMatrix new (const QMatrix other)

Description: Constructor QMatrix::QMatrix(const QMatrix &other)

This method creates an object of class QMatrix.

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

reset

Signature: void reset

Description: Method void QMatrix::reset()

rotate

Signature: QMatrix rotate (double a)

Description: Method QMatrix &QMatrix::rotate(double a)

scale

Signature: QMatrix scale (double sx, double sy)

Description: Method QMatrix &QMatrix::scale(double sx, double sy)

setMatrix

Signature: void setMatrix (double m11, double m12, double m21, double m22, double dx, double dy)

Description: Method void QMatrix::setMatrix(double m11, double m12, double m21, double m22, double dx, double dy)

shear

Signature: QMatrix shear (double sh, double sv)

Description: Method QMatrix &QMatrix::shear(double sh, double sv)

translate

Signature: QMatrix translate (double dx, double dy)

Description: Method QMatrix &QMatrix::translate(double dx, double dy)