API reference - Class EdgePairsNotation used in Ruby API documentation Description: EdgePairs (a collection of edge pairs)
Edge pairs are used mainly in the context of the DRC functions (width_check, space_check etc.) of Region and Edges. A single edge pair represents two edges participating in a DRC violation. In the two-layer checks (inside, overlap) The first edge represents an edge from the first layer and the second edge an edge from the second layer. For single-layer checks (width, space) the order of the edges is arbitrary. This class has been introduced in version 0.23. Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] const EdgePair ptr [](unsigned int n)Description: Returns the nth edge pair This method returns nil if the index is out of range. [const] void assign(const EdgePairs 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 edge pair collection The bounding box is the box enclosing all points of all edge pairs. void clearDescription: Clears the edge pair collection 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. void disable_progressDescription: Disable progress reporting Calling this method will disable progress reporting. See enable_progress. [const] EdgePairs dupDescription: Creates a copy of self [const,iter] EdgePair eachDescription: Returns each edge pair of the edge pair collection [const] Edges edgesDescription: Decomposes the edge pairs into single edges
void enable_progress(string label)Description: Enable progress reporting After calling this method, the edge pair collection will report the progress through a progress bar while expensive operations are running. The label is a text which is put in front of the progress bar. Using a progress bar will imply a performance penalty of a few percent typically. [const] Region extentsDescription: Returns a region with the bounding boxes of the edge pairs This method will return a region consisting of the bounding boxes of the edge pairs. The boxes will not be merged, so it is possible to determine overlaps of these boxes for example. [const] Region extents(int d)Description: Returns a region with the enlarged bounding boxes of the edge pairs This method will return a region consisting of the bounding boxes of the edge pairs enlarged by the given distance d. The enlargement is specified per edge, i.e the width and height will be increased by 2*d. The boxes will not be merged, so it is possible to determine overlaps of these boxes for example. [const] Region extents(int dx,int dy)Description: Returns a region with the enlarged bounding boxes of the edge pairs This method will return a region consisting of the bounding boxes of the edge pairs enlarged by the given distance dx in x direction and dy in y direction. The enlargement is specified per edge, i.e the width will be increased by 2*dx. The boxes will not be merged, so it is possible to determine overlaps of these boxes for example. [const] Edges first_edgesDescription: Returns the first one of all edges
void insert(const Edge first,const Edge second)Description: Inserts an edge pair into the collection void insert(const EdgePair edge_pair)Description: Inserts an edge pair into the collection [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] bool is_empty?Description: Returns true if the collection is empty EdgePairs move(const Point p)Description: Moves the edge pair collection
Moves the edge pairs by the given offset and returns the moved edge pair collection. The edge pair collection is overwritten. EdgePairs move(int x,int y)Description: Moves the edge pair collection
Moves the edge pairs by the given offset and returns the moved edge pairs. The edge pair collection is overwritten. [const] EdgePairs moved(const Point p)Description: Returns the moved edge pair collection (does not modify self)
Moves the edge pairs by the given offset and returns the moved edge pairs. The edge pair collection is not modified. [const] EdgePairs moved(int x,int y)Description: Returns the moved edge pair collection (does not modify self)
Moves the edge pairs by the given offset and returns the moved edge pairs. The edge pair collection is not modified. [static] new EdgePairs newDescription: Default constructor This constructor creates an empty edge pair collection. [const] Region polygonsDescription: Converts the edge pairs to polygons This method creates polygons from the edge pairs. Each polygon will be a triangle or quadrangle which connects the start and end points of the edges forming the edge pair. [const] Region polygons(int e)Description: Converts the edge pairs to polygons This method creates polygons from the edge pairs. Each polygon will be a triangle or quadrangle which connects the start and end points of the edges forming the edge pair. This version allows to specify an enlargement which is applied to the edges. The length of the edges is modified by applying the enlargement and the edges are shifted by the enlargement. By specifying an enlargement it is possible to give edge pairs an area which otherwise would not have one (coincident edges, two point-like edges). [const] Edges second_edgesDescription: Returns the second one of all edges
[const] unsigned int sizeDescription: Returns the number of edge pairs in this collection void swap(EdgePairs other)Description: Swap the contents of this collection with the contents of another collection This method is useful to avoid excessive memory allocation in some cases. For managed memory languages such as Ruby, those cases will be rare. [const] string to_sDescription: Converts the edge pair collection to a string The length of the output is limited to 20 edge pairs to avoid giant strings on large regions. For full output use "to_s" with a maximum count parameter. [const] string to_s(unsigned int max_count)Description: Converts the edge pair collection to a string This version allows specification of the maximum number of edge pairs contained in the string. EdgePairs transform(const Trans t)Description: Transform the edge pair collection (modifies self)
Transforms the edge pair collection with the given transformation. This version modifies the edge pair collection and returns a reference to self. EdgePairs transform(const ICplxTrans t)Description: Transform the edge pair collection with a complex transformation (modifies self)
Transforms the edge pair collection with the given transformation. This version modifies the edge pair collection and returns a reference to self. EdgePairs transform_icplx(const ICplxTrans t)Description: Transform the edge pair collection with a complex transformation (modifies self)
This method is deprecated. Use method 'transform' instead [const] EdgePairs transformed(const Trans t)Description: Transform the edge pair collection
Transforms the edge pairs with the given transformation. Does not modify the edge pair collection but returns the transformed edge pairs. [const] EdgePairs transformed(const ICplxTrans t)Description: Transform the edge pair collection with a complex transformation
Transforms the edge pairs with the given complex transformation. Does not modify the edge pair collection but returns the transformed edge pairs. [const] EdgePairs transformed_icplx(const ICplxTrans t)Description: Transform the edge pair collection with a complex transformation
This method is deprecated. Use method 'transformed' instead |