API reference - Class SimplePolygonNotation used in Ruby API documentation Description: A simple polygon class
A simple polygon consists of an outer hull only. To support polygons with holes, use Polygon. 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. The SimplePolygon class stores coordinates in integer format. A class that stores floating-point coordinates is DSimplePolygon. See The Database API for more details about the database objects. Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] bool !=(const SimplePolygon p)Description: Inequality test
[const] SimplePolygon *(double f)Description: Scaling by some factor Returns the scaled object. All coordinates are multiplied with the given factor and if necessary rounded. [const] bool ==(const SimplePolygon p)Description: Equality test
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 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. [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] 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. void _manageDescription: 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. void _unmanageDescription: 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. [const] 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. void assign(const SimplePolygon other)Description: Assigns another object to self [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 of this method is deprecated. Use _create instead void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] new SimplePolygon ptr 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] new SimplePolygon ptr ellipse(const Box box,int n)Description: Creates a simple polygon appoximating an ellipse
This method has been introduced in version 0.23. [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. [static] new SimplePolygon 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. [const] bool inside?(Point p)Description: Test, if 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. [const] bool is_box?Description: Returns true, if the polygon is a simple box.
A polygon is a box if it is identical to it's bounding box. This method was introduced in version 0.23. [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 [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. SimplePolygon move(int x,int y)Description: Moves the polygon.
Moves the polygon by the given offset and returns the moved 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. [const] SimplePolygon moved(int x,int y)Description: Returns the moved polygon (does not modify self)
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. [static] new SimplePolygon ptr newDescription: Default constructor: creates an empty (invalid) polygon Python specific notes:This method is the default initializer of the object [static] new SimplePolygon ptr new(Point[] pts,bool raw = false)Description: Constructor given the points of the simple polygon
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 [static] new SimplePolygon ptr new(const Box box)Description: Constructor converting a box to a polygon
Python specific notes:This method is the default initializer of the object [static] new SimplePolygon ptr new_b(const Box box)Description: Constructor converting a box to a polygon
Use of this method is deprecated. Use new instead [static] new SimplePolygon ptr new_p(Point[] pts,bool raw = false)Description: Constructor given the points of the simple polygon
Use of this method is deprecated. Use new instead unsigned long num_pointsDescription: Get the number of points Python specific notes:The object exposes a readable attribute 'points'. This is the getter. [const] int perimeterDescription: The perimeter of the polygon The perimeter is sum of the lengths of all edges making up the polygon. Point point(unsigned long 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 long pointsDescription: Get the number of points Use of this method is deprecated. Use num_points instead void points=(Point[] pts)Description: Set the points of 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. [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. void set_points(Point[] pts,bool raw = false)Description: Set the points of the simple polygon
See the constructor description for details about raw mode. This method has been added in version 0.24. [const] string to_sDescription: Convert to a string Python specific notes:This method is also available as 'str(object)' SimplePolygon ptr transform(const Trans t)Description: Transforms the simple polygon (in-place)
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. SimplePolygon ptr transform(const ICplxTrans t)Description: Transforms the simple polygon with a complex transformation (in-place)
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. SimplePolygon ptr transform_cplx(const ICplxTrans t)Description: Transforms the simple polygon with a complex transformation (in-place)
Use of this method is deprecated. Use transform instead [const] SimplePolygon transformed(const Trans t)Description: Transforms 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(const CplxTrans t)Description: Transforms 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(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. [const] DSimplePolygon transformed_cplx(const CplxTrans t)Description: Transforms the simple polygon.
Use of this method is deprecated. Use transformed instead [const] SimplePolygon transformed_cplx(const ICplxTrans t)Description: Transform the simple polygon.
Use of this method is deprecated. Use transformed instead |