API reference - Class DPolygonNotation used in Ruby API documentation Description: A polygon class
A polygon consists of an outer hull and zero to many holes. Each 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, while the orientation of the holes is counterclockwise. 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. A polygon can be asked for the number of holes using the holes method. each_point_hull delivers the points of the hull contour. each_point_hole delivers the points of a specific hole. each_edge delivers the edges (point-to-point connections) of both hull and holes. bbox delivers the bounding box, area the area and perimeter the perimeter of the polygon. Here's an example of how to create a polygon:
hull = [ RBA::DPoint::new(0, 0), RBA::DPoint::new(6000, 0),
RBA::DPoint::new(6000, 3000), RBA::DPoint::new(0, 3000) ]
hole1 = [ RBA::DPoint::new(1000, 1000), RBA::DPoint::new(2000, 1000),
RBA::DPoint::new(2000, 2000), RBA::DPoint::new(1000, 2000) ]
hole2 = [ RBA::DPoint::new(3000, 1000), RBA::DPoint::new(4000, 1000),
RBA::DPoint::new(4000, 2000), RBA::DPoint::new(3000, 2000) ]
poly = RBA::DPolygon::new(hull)
poly.insert_hole(hole1)
poly.insert_hole(hole2)
# ask the polygon for some properties
poly.holes # -> 2
poly.area # -> 16000000.0
poly.perimeter # -> 26000.0
poly.bbox # -> (0,0;6000,3000)
The DPolygon class stores coordinates in floating-point format which gives a higher precision for some operations. A class that stores integer coordinates is Polygon. 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 DPolygon p)Description: Inequality test
[const] DPolygon *(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 DPolygon p)Description: Less operator
This operator is provided to establish some, not necessarily a certain sorting order [const] bool ==(const DPolygon p)Description: Equality test
[const] double areaDescription: The area of the polygon The area is correct only if the polygon is not self-overlapping and the polygon is oriented clockwise.Orientation is ensured automatically in most cases. [const] void assign(const DPolygon 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. void assign_hole(unsigned int n,DPoint[] p)Description: Set the points of the given hole of the polygon
If the hole index is not valid, this method does nothing. This method was introduced in version 0.18. void assign_hole(unsigned int n,const DBox b)Description: Set the box as the given hole of the polygon
If the hole index is not valid, this method does nothing. This method was introduced in version 0.23. void assign_hull(DPoint[] p)Description: Set the points of the hull of polygon
The 'assign_hull' variant is provided in analogy to 'assign_hole'. [const] DBox bboxDescription: Return the bounding box of the polygon The bounding box is the box enclosing all points of the polygon. void compress(bool remove_reflected)Description: Compress the 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] DPolygon dupDescription: Creates a copy of self [iter] DEdge each_edgeDescription: Iterate over the edges that make up the polygon This iterator will deliver all edges, including those of the holes. Hole edges are oriented counterclockwise while hull egdes are oriented clockwise. [const,iter] DPoint each_point_hole(unsigned int n)Description: Iterate over the points that make up the nth hole The hole number must be less than the number of holes (see holes) [const,iter] DPoint each_point_hullDescription: Iterate over the points that make up the hull [static] new DPolygon ellipse(const DBox box,int n)Description: Creates a simple polygon appoximating an ellipse
This method has been introduced in version 0.23. [static] DPolygon from_ipoly(const Polygon int_poly)Description: Construct a floating-point coordinate polygon from an integer coordinate one This method has been added in version 0.15. [static] new DPolygon 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] unsigned int holesDescription: Returns the number of holes void hull=(DPoint[] p)Description: Set the points of the hull of polygon
The 'assign_hull' variant is provided in analogy to 'assign_hole'. void insert_hole(DPoint[] p)Description: Insert a hole with the given points
void insert_hole(const DBox b)Description: Insert a hole from the given box
This method was introduced in version 0.23. [const] bool inside(DPoint p)Description: Test, if the given point is inside the polygon This method is deprecated. Use method 'inside?' instead [const] bool inside?(DPoint p)Description: Test, if the given point is inside the polygon If the given point is inside or on the edge of 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 This method returns true, if self is a const reference. In that case, only const methods may be called on self. DPolygon move(const DPoint p)Description: Moves the polygon.
Moves the polygon by the given offset and returns the moved polygon. The polygon is overwritten. This method has been introduced in version 0.23. DPolygon move(double x,double y)Description: Moves the polygon.
Moves the polygon by the given offset and returns the moved polygon. The polygon is overwritten. [const] DPolygon moved(const DPoint p)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. [const] DPolygon moved(double x,double 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 DPolygon newDescription: Default constructor: creates an empty (invalid) polygon [static] new DPolygon new(const DSimplePolygon sp)Description: Constructor from a simple polygon
This method was introduced in version 0.22. [static] new DPolygon new(DPoint[] pts)Description: Constructor given the points of the polygon hull
[static] new DPolygon new(const DBox box)Description: Constructor converting a box to a polygon
[static] new DPolygon new_b(const DBox box)Description: Constructor converting a box to a polygon
This method is deprecated. Use method 'new' instead [static] new DPolygon new_p(DPoint[] pts)Description: Constructor given the points of the polygon hull
This method is deprecated. Use method 'new' instead unsigned int num_pointsDescription: Get the total number of points (hull plus holes) This method was introduced in version 0.18. unsigned int num_points_hole(unsigned int n)Description: Get the number of points of the given hole The argument gives the index of the hole of which the number of points are requested. The index must be less than the number of holes (see holes). unsigned int num_points_hullDescription: Get the number of points of the hull [const] double perimeterDescription: The perimeter of the polygon The perimeter is sum of the lengths of all edges making up the polygon. This method has been introduce in version 0.23. DPoint point_hole(unsigned int n,unsigned int p)Description: Get a specific point of a hole
If the index of the point or of the hole is not valid, a default value is returned. This method was introduced in version 0.18. DPoint point_hull(unsigned int p)Description: Get a specific point of the hull
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 total number of points (hull plus holes) This method is deprecated. Use method 'num_points' instead unsigned int points_hole(unsigned int n)Description: Get the number of points of the given hole This method is deprecated. Use method 'num_points_hole' instead unsigned int points_hullDescription: Get the number of points of the hull This method is deprecated. Use method 'num_points_hull' instead void size(double dx,double dy,unsigned int mode)Description: Sizing (biasing) Shifts the contour outwards (dx,dy>0) or inwards (dx,dy<0). dx is the sizing in x-direction and dy is the sizing in y-direction. The sign of dx and dy should be identical. The sizing operation create invalid (self-overlapping, reverse oriented) contours. The mode defines at which bending angle cutoff occurs (0:>0, 1:>45, 2:>90, 3:>135, 4:>approx. 168, other:>approx. 179) In order to obtain a proper polygon in the general case, the sized polygon must be merged in 'greater than zero' wrap count mode. This is necessary since in the general case, sizing can be complicated operation which lets a single polygon fall apart into disjoint pieces for example. This can be achieved using the EdgeProcessor class for example: poly = ... # a RBA::Polygon poly.size(-50, 2) ep = RBA::EdgeProcessor::new # result is an array of RBA::Polygon objects result = ep.simple_merge_p2p([ poly ], false, false, 1) void size(double d,unsigned int mode)Description: Sizing (biasing) Shifts the contour outwards (d>0) or inwards (d<0). This method is equivalent to size(d, d, mode) See size for a detailed description. This method has been introduced in version 0.23. void size(double d)Description: Sizing (biasing) Shifts the contour outwards (d>0) or inwards (d<0). This method is equivalent to size(d, d, 2) See size for a detailed description. [const] DPolygon sized(double dx,double dy,unsigned int mode)Description: Sizing (biasing) without modifying self This method applies sizing to the polygon but does not modify self. Instead a sized copy is returned. See size for a description of the operation. This method has been introduced in version 0.23. [const] DPolygon sized(double d,unsigned int mode)Description: Sizing (biasing) without modifying self Shifts the contour outwards (d>0) or inwards (d<0). This method is equivalent to sized(d, d, mode) See size and sized for a detailed description. [const] DPolygon sized(double d)Description: Sizing (biasing) without modifying self This method is equivalent to sized(d, d, 2) See size and sized for a detailed description. [const] string to_sDescription: Convert to a string [const] DPolygon transformed(const DTrans t)Description: Transform the polygon
Transforms the polygon with the given transformation. Does not modify the polygon but returns the transformed polygon. [const] DPolygon transformed(const DCplxTrans t)Description: Transform the polygon with a complex transformation
Transforms the polygon with the given complex transformation. Does not modify the polygon but returns the transformed polygon. [const] DPolygon transformed_cplx(const DCplxTrans t)Description: Transform the polygon with a complex transformation
This method is deprecated. Use method 'transformed' instead |