API reference - Class QPolygon

*

(1) Signature: [const] QPolygon * (const QMatrix m)

Description: Operator QPolygon ::operator *(const QPolygon &a, const QMatrix &m)

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

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

(2) Signature: [const] QPolygon * (const QTransform m)

Description: Operator QPolygon ::operator *(const QPolygon &a, const QTransform &m)

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

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

[]

Signature: [const] QPoint [] (int index)

Description: Gets the point at the given position

_assign

Signature: void _assign (const QPolygon other)

Description: Assigns another object to self

_const_cast

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

Description: Method QPolygon &QPolygon::operator=(const QPolygon &other)

back

Signature: [const] QPoint back

Description: Gets the last point

boundingRect

Signature: [const] QRect boundingRect

Description: Method QRect QPolygon::boundingRect()

clear

Signature: void clear

Description: Empties the polygon

containsPoint

Signature: [const] bool containsPoint (const QPoint pt, const Qt_FillRule fillRule)

Description: Method bool QPolygon::containsPoint(const QPoint &pt, Qt::FillRule fillRule)

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 QPolygon ptr dup

Description: Creates a copy of self

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

each

Signature: [const,iter] QPoint each

Description: Iterates over all points of the polygon.

Python specific notes:
This method enables iteration of the object.

fill

Signature: void fill (const QPoint p, int l)

Description: Resizes the polygon to l points and sets all elements to the given point

front

Signature: [const] QPoint front

Description: Gets the first point

insert

Signature: void insert (int p, const QPoint p)

Description: Inserts the point after the given position

intersected

Signature: [const] QPolygon intersected (const QPolygon r)

Description: Method QPolygon QPolygon::intersected(const QPolygon &r)

intersects

Signature: [const] bool intersects (const QPolygon r)

Description: Method bool QPolygon::intersects(const QPolygon &r)

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.

new

(1) Signature: [static] new QPolygon ptr new (const Polygon p)

Description: Creates a polygon from the given KLayout Polygon

Remark: holes are not transferred into the QPolygon.

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

(2) Signature: [static] new QPolygon ptr new (const SimplePolygon p)

Description: Creates a polygon from the given KLayout SimplePolygon

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

(3) Signature: [static] new QPolygon new

Description: Constructor QPolygon::QPolygon()

This method creates an object of class QPolygon.

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

(4) Signature: [static] new QPolygon new (int size)

Description: Constructor QPolygon::QPolygon(int size)

This method creates an object of class QPolygon.

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

(5) Signature: [static] new QPolygon new (QPoint[] v)

Description: Constructor QPolygon::QPolygon(const QVector<QPoint> &v)

This method creates an object of class QPolygon.

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

(6) Signature: [static] new QPolygon new (const QRect r, bool closed = false)

Description: Constructor QPolygon::QPolygon(const QRect &r, bool closed)

This method creates an object of class QPolygon.

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

(7) Signature: [static] new QPolygon new (const QPolygon other)

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

This method creates an object of class QPolygon.

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

point

(1) Signature: [const] void point (int i, int ptr x, int ptr y)

Description: Method void QPolygon::point(int i, int *x, int *y)

(2) Signature: [const] QPoint point (int i)

Description: Method QPoint QPolygon::point(int i)

pop_back

Signature: void pop_back

Description: Removes the point at the end of the list

pop_front

Signature: void pop_front

Description: Removes the point at the beginning of the list

push_back

Signature: void push_back (const QPoint p)

Description: Inserts the point at the end of the list

push_front

Signature: void push_front (const QPoint p)

Description: Inserts the point at the beginning of the list

putPoints

(1) Signature: void putPoints (int index, int nPoints, int firstx, int firsty)

Description: Method void QPolygon::putPoints(int index, int nPoints, int firstx, int firsty, ...)

(2) Signature: void putPoints (int index, int nPoints, const QPolygon from, int fromIndex = 0)

Description: Method void QPolygon::putPoints(int index, int nPoints, const QPolygon &from, int fromIndex)

remove

Signature: void remove (int index)

Description: Removes the point at the given position

replace

Signature: void replace (int p, const QPoint p)

Description: Replaces the point at the given position

reserve

Signature: void reserve (int n)

Description: Reserve memory for the given number of points

resize

Signature: void resize (int l)

Description: Sets the number of points to the given length

setPoint

(1) Signature: void setPoint (int index, int x, int y)

Description: Method void QPolygon::setPoint(int index, int x, int y)

(2) Signature: void setPoint (int index, const QPoint p)

Description: Method void QPolygon::setPoint(int index, const QPoint &p)

setPoints

Signature: void setPoints (int nPoints, int firstx, int firsty)

Description: Method void QPolygon::setPoints(int nPoints, int firstx, int firsty, ...)

size

Signature: [const] int size

Description: Gets the number of points in the polygon

Python specific notes:
This method is also available as 'len(object)'.

subtracted

Signature: [const] QPolygon subtracted (const QPolygon r)

Description: Method QPolygon QPolygon::subtracted(const QPolygon &r)

swap

Signature: void swap (QPolygon other)

Description: Method void QPolygon::swap(QPolygon &other)

translate

(1) Signature: void translate (int dx, int dy)

Description: Method void QPolygon::translate(int dx, int dy)

(2) Signature: void translate (const QPoint offset)

Description: Method void QPolygon::translate(const QPoint &offset)

translated

(1) Signature: [const] QPolygon translated (int dx, int dy)

Description: Method QPolygon QPolygon::translated(int dx, int dy)

(2) Signature: [const] QPolygon translated (const QPoint offset)

Description: Method QPolygon QPolygon::translated(const QPoint &offset)

united

Signature: [const] QPolygon united (const QPolygon r)

Description: Method QPolygon QPolygon::united(const QPolygon &r)