API reference - Class DSimplePolygon

Notation used in Ruby API documentation

Module: db

Description: A simple polygon class

A simple polygon consists of an outer hull only. To support polygons with holes, use DPolygon. The contour consists of several points. The point list is normalized such that the leftmost, lowest point is the first one. The orientation is normalized such that the orientation of the hull contour is clockwise.

It is in no way checked that the contours are not over- lapping. This must be ensured by the user of the object when filling the contours.

The DSimplePolygon class stores coordinates in floating-point format which gives a higher precision for some operations. A class that stores integer coordinates is SimplePolygon.

See The Database API for more details about the database objects.

Public constructors

new DSimplePolygon ptrnew(const SimplePolygon polygon)Creates a floating-point coordinate polygon from an integer coordinate polygon
new DSimplePolygon ptrnewDefault constructor: creates an empty (invalid) polygon
new DSimplePolygon ptrnew(DPoint[] pts,
bool raw = false)
Constructor given the points of the simple polygon
new DSimplePolygon ptrnew(const DBox box)Constructor converting a box to a polygon

Public methods

[const]bool!=(const DSimplePolygon p)Returns a value indicating whether self is not equal to p
[const]DSimplePolygon*(double f)Scales the polygon by some factor
[const]bool<(const DSimplePolygon p)Returns a value indicating whether self is less than p
[const]bool==(const DSimplePolygon p)Returns a value indicating whether self is equal to p
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]doubleareaGets the area of the polygon
[const]doublearea2Gets the double area of the polygon
voidassign(const DSimplePolygon other)Assigns another object to self
[const]DBoxbboxReturns the bounding box of the simple polygon
voidcompress(bool remove_reflected)Compressed the simple polygon.
[const]new DSimplePolygon ptrdupCreates a copy of self
[const,iter]DEdgeeach_edgeIterates over the edges that make up the simple polygon
[const,iter]DPointeach_pointIterates over the points that make up the simple polygon
[const]variant[]extract_radExtracts the corner radii from a rounded polygon
[const]unsigned longhashComputes a hash value
[const]boolinside?(DPoint p)Gets a value indicating whether the given point is inside the polygon
[const]boolis_box?Returns a value indicating whether the polygon is a simple box.
boolis_empty?Returns a value indicating whether the polygon is empty
[const]boolis_halfmanhattan?Returns a value indicating whether the polygon is half-manhattan
[const]boolis_rectilinear?Returns a value indicating whether the polygon is rectilinear
DSimplePolygonmove(const DVector p)Moves the simple polygon.
DSimplePolygonmove(double x,
double y)
Moves the polygon.
[const]DSimplePolygonmoved(const DVector p)Returns the moved simple polygon
[const]DSimplePolygonmoved(double x,
double y)
Returns the moved polygon (does not modify self)
unsigned longnum_pointsGets the number of points
[const]doubleperimeterGets the perimeter of the polygon
DPointpoint(unsigned long p)Gets a specific point of the contour@param p The index of the point to get
voidpoints=(DPoint[] pts)Sets the points of the simple polygon
[const]DSimplePolygonround_corners(double rinner,
double router,
unsigned int n)
Rounds the corners of the polygon
voidset_points(DPoint[] pts,
bool raw = false)
Sets the points of the simple polygon
[const]DSimplePolygon[]splitSplits the polygon into two or more parts
[const]SimplePolygonto_itype(double dbu = 1)Converts the polygon to an integer coordinate polygon
[const]stringto_sReturns a string representing the polygon
[const]booltouches?(const DBox box)Returns true, if the polygon touches the given box.
[const]booltouches?(const DEdge edge)Returns true, if the polygon touches the given edge.
[const]booltouches?(const DPolygon polygon)Returns true, if the polygon touches the other polygon.
[const]booltouches?(const DSimplePolygon simple_polygon)Returns true, if the polygon touches the other polygon.
DSimplePolygon ptrtransform(const DCplxTrans t)Transforms the simple polygon with a complex transformation (in-place)
DSimplePolygon ptrtransform(const DTrans t)Transforms the simple polygon (in-place)
[const]SimplePolygontransformed(const VCplxTrans t)Transforms the polygon with the given complex transformation
[const]DSimplePolygontransformed(const DTrans t)Transforms the simple polygon.
[const]DSimplePolygontransformed(const DCplxTrans t)Transforms the simple polygon.

Public static methods and constants

new DSimplePolygon ptrellipse(const DBox box,
int n)
Creates a simple polygon approximating an ellipse
new DSimplePolygon ptrfrom_s(string s)Creates an object from a string

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
[static]new DSimplePolygon ptrfrom_ipoly(const SimplePolygon polygon)Use of this method is deprecated. Use new instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead
[const]DSimplePolygontransformed_cplx(const DCplxTrans t)Use of this method is deprecated. Use transformed instead

Detailed description

!=

Signature: [const] bool != (const DSimplePolygon p)

Description: Returns a value indicating whether self is not equal to p

p:The object to compare against

*

Signature: [const] DSimplePolygon * (double f)

Description: Scales the polygon by some factor

Returns the scaled object. All coordinates are multiplied with the given factor and if necessary rounded.

Python specific notes:
This method is also available as '__rmul__'

<

Signature: [const] bool < (const DSimplePolygon p)

Description: Returns a value indicating whether self is less than p

p:The object to compare against

This operator is provided to establish some, not necessarily a certain sorting order

This method has been introduced in version 0.25.

==

Signature: [const] bool == (const DSimplePolygon p)

Description: Returns a value indicating whether self is equal to p

p:The object to compare against

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

area

Signature: [const] double area

Description: Gets the area of the polygon

The area is correct only if the polygon is not self-overlapping and the polygon is oriented clockwise.

area2

Signature: [const] double area2

Description: Gets the double area of the polygon

This method is provided because the area for an integer-type polygon is a multiple of 1/2. Hence the double area can be expresses precisely as an integer for these types.

This method has been introduced in version 0.26.1

assign

Signature: void assign (const DSimplePolygon other)

Description: Assigns another object to self

bbox

Signature: [const] DBox bbox

Description: Returns the bounding box of the simple polygon

compress

Signature: void compress (bool remove_reflected)

Description: Compressed the simple polygon.

remove_reflected:See description of the functionality.

This method removes redundant points from the polygon, such as points being on a line formed by two other points. If remove_reflected is true, points are also removed if the two adjacent edges form a spike.

This method was introduced in version 0.18.

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

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__'

each_edge

Signature: [const,iter] DEdge each_edge

Description: Iterates over the edges that make up the simple polygon

each_point

Signature: [const,iter] DPoint each_point

Description: Iterates over the points that make up the simple polygon

ellipse

Signature: [static] new DSimplePolygon ptr ellipse (const DBox box, int n)

Description: Creates a simple polygon approximating an ellipse

box:The bounding box of the ellipse
n:The number of points that will be used to approximate the ellipse

This method has been introduced in version 0.23.

extract_rad

Signature: [const] variant[] extract_rad

Description: Extracts the corner radii from a rounded polygon

Attempts to extract the radii of rounded corner polygon. This is essentially the inverse of the round_corners method. If this method succeeds, if will return an array of four elements:

  • The polygon with the rounded corners replaced by edgy ones
  • The radius of the inner corners
  • The radius of the outer corners
  • The number of points per full circle

This method is based on some assumptions and may fail. In this case, an empty array is returned.

If successful, the following code will more or less render the original polygon and parameters

p = ...   # some polygon
p.round_corners(ri, ro, n)
(p2, ri2, ro2, n2) = p.extract_rad
# -> p2 == p, ro2 == ro, ri2 == ri, n2 == n (within some limits)

This method was introduced in version 0.25.

from_ipoly

Signature: [static] new DSimplePolygon ptr from_ipoly (const SimplePolygon polygon)

Description: Creates a floating-point coordinate polygon from an integer coordinate polygon

Use of this method is deprecated. Use new instead

This constructor has been introduced in version 0.25 and replaces the previous static method 'from_ipoly'.

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

from_s

Signature: [static] new DSimplePolygon ptr from_s (string s)

Description: Creates an object from a string

Creates the object from a string representation (as returned by to_s)

This method has been added in version 0.23.

hash

Signature: [const] unsigned long hash

Description: Computes a hash value

Returns a hash value for the given polygon. This method enables polygons as hash keys.

This method has been introduced in version 0.25.

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

inside?

Signature: [const] bool inside? (DPoint p)

Description: Gets a value indicating whether the given point is inside the polygon

If the given point is inside or on the edge the polygon, true is returned. This tests works well only if the polygon is not self-overlapping and oriented clockwise.

is_box?

Signature: [const] bool is_box?

Description: Returns a value indicating whether the polygon is a simple box.

Returns:True if the polygon is a box.

A polygon is a box if it is identical to it's bounding box.

This method was introduced in version 0.23.

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.

is_empty?

Signature: bool is_empty?

Description: Returns a value indicating whether the polygon is empty

is_halfmanhattan?

Signature: [const] bool is_halfmanhattan?

Description: Returns a value indicating whether the polygon is half-manhattan

Half-manhattan polygons have edges which are multiples of 45 degree. These polygons can be clipped at a rectangle without potential grid snapping.

This predicate was introduced in version 0.27.

is_rectilinear?

Signature: [const] bool is_rectilinear?

Description: Returns a value indicating whether the polygon is rectilinear

move

(1) Signature: DSimplePolygon move (const DVector p)

Description: Moves the simple polygon.

p:The distance to move the simple polygon.
Returns:The moved simple polygon.

Moves the simple polygon by the given offset and returns the moved simple polygon. The polygon is overwritten.

(2) Signature: DSimplePolygon move (double x, double y)

Description: Moves the polygon.

x:The x distance to move the polygon.
y:The y distance to move the polygon.
Returns:The moved polygon (self).

Moves the polygon by the given offset and returns the moved polygon. The polygon is overwritten.

moved

(1) Signature: [const] DSimplePolygon moved (const DVector p)

Description: Returns the moved simple polygon

p:The distance to move the simple polygon.
Returns:The moved simple polygon.

Moves the simple polygon by the given offset and returns the moved simple polygon. The polygon is not modified.

(2) Signature: [const] DSimplePolygon moved (double x, double y)

Description: Returns the moved polygon (does not modify self)

x:The x distance to move the polygon.
y:The y distance to move the polygon.
Returns:The moved polygon.

Moves the polygon by the given offset and returns the moved polygon. The polygon is not modified.

This method has been introduced in version 0.23.

new

(1) Signature: [static] new DSimplePolygon ptr new (const SimplePolygon polygon)

Description: Creates a floating-point coordinate polygon from an integer coordinate polygon

This constructor has been introduced in version 0.25 and replaces the previous static method 'from_ipoly'.

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

(2) Signature: [static] new DSimplePolygon ptr new

Description: Default constructor: creates an empty (invalid) polygon

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

(3) Signature: [static] new DSimplePolygon ptr new (DPoint[] pts, bool raw = false)

Description: Constructor given the points of the simple polygon

pts:The points forming the simple polygon
raw:If true, the points are taken as they are (see below)

If the 'raw' argument is set to true, the points are taken as they are. Specifically no removal of redundant points or joining of coincident edges will take place. In effect, polygons consisting of a single point or two points can be constructed as well as polygons with duplicate points. Note that such polygons may cause problems in some applications.

Regardless of raw mode, the point list will be adjusted such that the first point is the lowest-leftmost one and the orientation is clockwise always.

The 'raw' argument has been added in version 0.24.

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

(4) Signature: [static] new DSimplePolygon ptr new (const DBox box)

Description: Constructor converting a box to a polygon

box:The box to convert to a polygon

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

num_points

Signature: unsigned long num_points

Description: Gets the number of points

perimeter

Signature: [const] double perimeter

Description: Gets the perimeter of the polygon

The perimeter is sum of the lengths of all edges making up the polygon.

point

Signature: DPoint point (unsigned long p)

Description: Gets a specific point of the contour@param p The index of the point to get

If the index of the point is not a valid index, a default value is returned. This method was introduced in version 0.18.

points=

Signature: void points= (DPoint[] pts)

Description: Sets the points of the simple polygon

pts:An array of points to assign to the simple polygon

See the constructor description for details about raw mode.

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

round_corners

Signature: [const] DSimplePolygon round_corners (double rinner, double router, unsigned int n)

Description: Rounds the corners of the polygon

rinner:The circle radius of inner corners (in database units).
router:The circle radius of outer corners (in database units).
n:The number of points per full circle.
Returns:The new polygon.

Replaces the corners of the polygon with circle segments.

This method was introduced in version 0.22 for integer coordinates and in 0.25 for all coordinate types.

set_points

Signature: void set_points (DPoint[] pts, bool raw = false)

Description: Sets the points of the simple polygon

pts:An array of points to assign to the simple polygon
raw:If true, the points are taken as they are

See the constructor description for details about raw mode.

This method has been added in version 0.24.

split

Signature: [const] DSimplePolygon[] split

Description: Splits the polygon into two or more parts

This method will break the polygon into parts. The exact breaking algorithm is unspecified, the result are smaller polygons of roughly equal number of points and 'less concave' nature. Usually the returned polygon set consists of two polygons, but there can be more. The merged region of the resulting polygons equals the original polygon with the exception of small snapping effects at new vertexes.

The intended use for this method is a iteratively split polygons until the satisfy some maximum number of points limit.

This method has been introduced in version 0.25.3.

to_itype

Signature: [const] SimplePolygon to_itype (double dbu = 1)

Description: Converts the polygon to an integer coordinate polygon

The database unit can be specified to translate the floating-point coordinate polygon in micron units to an integer-coordinate polygon in database units. The polygon's' coordinates will be divided by the database unit.

This method has been introduced in version 0.25.

to_s

Signature: [const] string to_s

Description: Returns a string representing the polygon

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

touches?

(1) Signature: [const] bool touches? (const DBox box)

Description: Returns true, if the polygon touches the given box.

The box and the polygon touch if they overlap or their contours share at least one point.

This method was introduced in version 0.25.1.

(2) Signature: [const] bool touches? (const DEdge edge)

Description: Returns true, if the polygon touches the given edge.

The edge and the polygon touch if they overlap or the edge shares at least one point with the polygon's contour.

This method was introduced in version 0.25.1.

(3) Signature: [const] bool touches? (const DPolygon polygon)

Description: Returns true, if the polygon touches the other polygon.

The polygons touch if they overlap or their contours share at least one point.

This method was introduced in version 0.25.1.

(4) Signature: [const] bool touches? (const DSimplePolygon simple_polygon)

Description: Returns true, if the polygon touches the other polygon.

The polygons touch if they overlap or their contours share at least one point.

This method was introduced in version 0.25.1.

transform

(1) Signature: DSimplePolygon ptr transform (const DCplxTrans t)

Description: Transforms the simple polygon with a complex transformation (in-place)

t:The transformation to apply.

Transforms the simple polygon with the given complex transformation. Modifies self and returns self. An out-of-place version which does not modify self is transformed.

This method has been introduced in version 0.24.

(2) Signature: DSimplePolygon ptr transform (const DTrans t)

Description: Transforms the simple polygon (in-place)

t:The transformation to apply.

Transforms the simple polygon with the given transformation. Modifies self and returns self. An out-of-place version which does not modify self is transformed.

This method has been introduced in version 0.24.

transformed

(1) Signature: [const] SimplePolygon transformed (const VCplxTrans t)

Description: Transforms the polygon with the given complex transformation

t:The magnifying transformation to apply
Returns:The transformed polygon (in this case an integer coordinate polygon)

This method has been introduced in version 0.25.

(2) Signature: [const] DSimplePolygon transformed (const DTrans t)

Description: Transforms the simple polygon.

t:The transformation to apply.
Returns:The transformed simple polygon.

Transforms the simple polygon with the given transformation. Does not modify the simple polygon but returns the transformed polygon.

(3) Signature: [const] DSimplePolygon transformed (const DCplxTrans t)

Description: Transforms the simple polygon.

t:The transformation to apply.
Returns:The transformed simple polygon.

Transforms the simple polygon with the given complex transformation. Does not modify the simple polygon but returns the transformed polygon.

With version 0.25, the original 'transformed_cplx' method is deprecated and 'transformed' takes both simple and complex transformations.

transformed_cplx

Signature: [const] DSimplePolygon transformed_cplx (const DCplxTrans t)

Description: Transforms the simple polygon.

t:The transformation to apply.
Returns:The transformed simple polygon.

Use of this method is deprecated. Use transformed instead

Transforms the simple polygon with the given complex transformation. Does not modify the simple polygon but returns the transformed polygon.

With version 0.25, the original 'transformed_cplx' method is deprecated and 'transformed' takes both simple and complex transformations.