KLayout Manual: Main Index » Class Index » API reference - Class SimplePolygonAPI reference - Class SimplePolygonNotation used in Ruby API documentation Description: A simple polygon class
A simple polygon consists of an outer hull only. The hull 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 overlapping This must be ensured by the user of the object when filling the contours. Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] bool !=(const SimplePolygon arg1)Description: Inequality test [const] bool ==(const SimplePolygon arg1)Description: Equality test [const] long long areaDescription: The area of the polygon The area is correct only if the polygon is not self-overlapping and the polygon is oriented clockwise. [const] void assign(const SimplePolygon other)Description: Assign the contents of another object to self This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content. [const] Box bboxDescription: Return the bounding box of the simple polygon void compress(bool remove_reflected)Description: Compress the simple polygon.
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. void createDescription: 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. void destroyDescription: Explicitly destroy the object Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing. [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. [const] SimplePolygon dupDescription: Creates a copy of self [iter] Edge each_edgeDescription: Iterate over the edges that make up the simple polygon [const,iter] Point each_pointDescription: Iterate over the points that make up the simple polygon [static] SimplePolygon from_dpoly(const DSimplePolygon double_poly)Description: Construct an integer-coordinate polygon from a floating-point coordinate one This method has been added in version 0.15. [const] bool inside(Point p)Description: Test, if the given point is inside the polygon This method is deprecated. Use method 'inside?' instead [const] bool inside?(Point p)Description: Test, if the given point is inside the polygon If the given point is inside the polygon, true is returned. This tests works well only if the polygon is not self-overlapping and oriented clockwise. [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. [const] Polygon minkowsky_sum(const Edge a,bool b)Description: Compute the Minkowsky sum of a polygon and an edge
This method was introduced in version 0.22. [const] Polygon minkowsky_sum(const SimplePolygon a,bool b)Description: Compute the Minkowsky sum of a polygon and a polygon
This method was introduced in version 0.22. [const] Polygon minkowsky_sum(const Box a,bool b)Description: Compute the Minkowsky sum of a polygon and a box
This method was introduced in version 0.22. [const] Polygon minkowsky_sum(Point[] a,bool b)Description: Compute the Minkowsky sum of a polygon and a contour of points (a trace)
This method was introduced in version 0.22. SimplePolygon move(const Point p)Description: Moves the simple polygon.
Moves the simple polygon by the given offset and returns the moved simple polygon. The polygon is overwritten. [const] SimplePolygon moved(const Point p)Description: Returns the moved simple polygon
Moves the simple polygon by the given offset and returns the moved simple polygon. The polygon is not modified. [static] new SimplePolygon newDescription: Default constructor: creates an empty (invalid) polygon [static] new SimplePolygon new(Point[] pts)Description: Constructor given the points of the simple polygon
[static] new SimplePolygon new(const Box box)Description: Constructor converting a box to a polygon
[static] new SimplePolygon new_b(const Box box)Description: Constructor converting a box to a polygon
This method is deprecated. Use method 'new' instead [static] new SimplePolygon new_p(Point[] pts)Description: Constructor given the points of the simple polygon
This method is deprecated. Use method 'new' instead unsigned int num_pointsDescription: Get the number of points Point point(unsigned int arg1)Description: Get a specific point of the contour@args p
If the index of the point is not a valid index, a default value is returned. This method was introduced in version 0.18. unsigned int pointsDescription: Get the number of points This method is deprecated. Use method 'num_points' instead void points=(Point[] p)Description: Set the points of the simple polygon
[const] Polygon round_corners(double rinner,double router,unsigned int n)Description: Round the corners of the polygon
Replaces the corners of the polygon with circle segments. This method was introduced in version 0.22. [const] string to_sDescription: Convert to a string [const] SimplePolygon transformed(const Trans t)Description: Transform the simple polygon.
Transforms the simple polygon with the given transformation. Does not modify the simple polygon but returns the transformed polygon. [const] DSimplePolygon transformed_cplx(const CplxTrans t)Description: Transform the simple polygon.
Transforms the simple polygon with the given complex transformation. Does not modify the simple polygon but returns the transformed polygon. [const] SimplePolygon transformed_cplx(const ICplxTrans t)Description: Transform the simple polygon.
Transforms the simple polygon with the given complex transformation. Does not modify the simple polygon but returns the transformed polygon. This method has been introduced in version 0.18. |