Notation used in Ruby API documentation
Module: db
Description: The shape processor (boolean, sizing, merge on shapes)
The shape processor implements the boolean and edge set operations (size, merge). Because the shape processor might allocate resources which can be reused in later operations, it is implemented as an object that can be used several times. The shape processor is similar to the EdgeProcessor. The latter is specialized on handling polygons and edges directly.
new ShapeProcessor ptr | new | Creates a new object of this class |
[const] | ShapeProcessor ptr | _const_cast | Returns a non-const reference to self. | |
void | _create | Ensures the C++ object is created | ||
void | _destroy | Explicitly 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 | _manage | Marks the object as managed by the script side. | ||
void | _unmanage | Marks the object as no longer owned by the script side. | ||
void | assign | (const ShapeProcessor other) | Assigns another object to self | |
void | boolean | (const Layout layout_a, const Cell cell_a, unsigned int layer_a, const Layout layout_b, const Cell cell_b, unsigned int layer_b, Shapes out, int mode, bool hierarchical, bool resolve_holes, bool min_coherence) | Boolean operation on shapes from layouts | |
Edge[] | boolean | (Shape[] in_a, CplxTrans[] trans_a, Shape[] in_b, CplxTrans[] trans_b, int mode) | Boolean operation on two given shape sets into an edge set | |
Edge[] | boolean | (Shape[] in_a, Shape[] in_b, int mode) | Boolean operation on two given shape sets into an edge set | |
Polygon[] | boolean_to_polygon | (Shape[] in_a, CplxTrans[] trans_a, Shape[] in_b, CplxTrans[] trans_b, int mode, bool resolve_holes, bool min_coherence) | Boolean operation on two given shape sets into a polygon set | |
Polygon[] | boolean_to_polygon | (Shape[] in_a, Shape[] in_b, int mode, bool resolve_holes, bool min_coherence) | Boolean operation on two given shape sets into a polygon set | |
[const] | new ShapeProcessor ptr | dup | Creates a copy of self | |
void | merge | (const Layout layout, const Cell cell, unsigned int layer, Shapes out, bool hierarchical, unsigned int min_wc, bool resolve_holes, bool min_coherence) | Merge the given shapes from a layout into a shapes container | |
Edge[] | merge | (Shape[] in, CplxTrans[] trans, unsigned int min_wc) | Merge the given shapes | |
Edge[] | merge | (Shape[] in, unsigned int min_wc) | Merge the given shapes | |
Polygon[] | merge_to_polygon | (Shape[] in, CplxTrans[] trans, unsigned int min_wc, bool resolve_holes, bool min_coherence) | Merge the given shapes | |
Polygon[] | merge_to_polygon | (Shape[] in, unsigned int min_wc, bool resolve_holes, bool min_coherence) | Merge the given shapes | |
void | size | (const Layout layout, const Cell cell, unsigned int layer, Shapes out, int dx, int dy, unsigned int mode, bool hierarchical, bool resolve_holes, bool min_coherence) | Sizing operation on shapes from layouts | |
void | size | (const Layout layout, const Cell cell, unsigned int layer, Shapes out, int d, unsigned int mode, bool hierarchical, bool resolve_holes, bool min_coherence) | Sizing operation on shapes from layouts | |
Edge[] | size | (Shape[] in, CplxTrans[] trans, int d, unsigned int mode) | Size the given shapes | |
Edge[] | size | (Shape[] in, CplxTrans[] trans, int dx, int dy, unsigned int mode) | Size the given shapes | |
Edge[] | size | (Shape[] in, int d, unsigned int mode) | Size the given shapes | |
Edge[] | size | (Shape[] in, int dx, int dy, unsigned int mode) | Size the given shapes | |
Polygon[] | size_to_polygon | (Shape[] in, CplxTrans[] trans, int d, unsigned int mode, bool resolve_holes, bool min_coherence) | Size the given shapes | |
Polygon[] | size_to_polygon | (Shape[] in, CplxTrans[] trans, int dx, int dy, unsigned int mode, bool resolve_holes, bool min_coherence) | Size the given shapes | |
Polygon[] | size_to_polygon | (Shape[] in, int d, unsigned int mode, bool resolve_holes, bool min_coherence) | Size the given shapes | |
Polygon[] | size_to_polygon | (Shape[] in, int dx, int dy, unsigned int mode, bool resolve_holes, bool min_coherence) | Size the given shapes |
void | create | Use of this method is deprecated. Use _create instead | ||
void | destroy | Use of this method is deprecated. Use _destroy instead | ||
[const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
[const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_const_cast | Signature: [const] ShapeProcessor ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. | ||||||||||||||||||||||
_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. | ||||||||||||||||||||||
assign | Signature: void assign (const ShapeProcessor other) Description: Assigns another object to self | ||||||||||||||||||||||
boolean | (1) Signature: void boolean (const Layout layout_a, const Cell cell_a, unsigned int layer_a, const Layout layout_b, const Cell cell_b, unsigned int layer_b, Shapes out, int mode, bool hierarchical, bool resolve_holes, bool min_coherence) Description: Boolean operation on shapes from layouts
See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes from layout cells (optionally all in hierarchy) and produces new shapes in a shapes container. | ||||||||||||||||||||||
(2) Signature: Edge[] boolean (Shape[] in_a, CplxTrans[] trans_a, Shape[] in_b, CplxTrans[] trans_b, int mode) Description: Boolean operation on two given shape sets into an edge set
See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes rather than polygons for input and produces an edge set. | |||||||||||||||||||||||
(3) Signature: Edge[] boolean (Shape[] in_a, Shape[] in_b, int mode) Description: Boolean operation on two given shape sets into an edge set
See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes rather than polygons for input and produces an edge set. This version does not feature a transformation for each shape (unity is assumed). | |||||||||||||||||||||||
boolean_to_polygon | (1) Signature: Polygon[] boolean_to_polygon (Shape[] in_a, CplxTrans[] trans_a, Shape[] in_b, CplxTrans[] trans_b, int mode, bool resolve_holes, bool min_coherence) Description: Boolean operation on two given shape sets into a polygon set
See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes rather than polygons for input and produces a polygon set. | ||||||||||||||||||||||
(2) Signature: Polygon[] boolean_to_polygon (Shape[] in_a, Shape[] in_b, int mode, bool resolve_holes, bool min_coherence) Description: Boolean operation on two given shape sets into a polygon set
See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes rather than polygons for input and produces a polygon set. This version does not feature a transformation for each shape (unity is assumed). | |||||||||||||||||||||||
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 ShapeProcessor ptr dup Description: Creates a copy of self Python specific notes: | ||||||||||||||||||||||
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. | ||||||||||||||||||||||
merge | (1) Signature: void merge (const Layout layout, const Cell cell, unsigned int layer, Shapes out, bool hierarchical, unsigned int min_wc, bool resolve_holes, bool min_coherence) Description: Merge the given shapes from a layout into a shapes container
See the EdgeProcessor for a description of the merge method. This implementation takes shapes from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container. | ||||||||||||||||||||||
(2) Signature: Edge[] merge (Shape[] in, CplxTrans[] trans, unsigned int min_wc) Description: Merge the given shapes
See the EdgeProcessor for a description of the merge method. This implementation takes shapes rather than polygons for input and produces an edge set. | |||||||||||||||||||||||
(3) Signature: Edge[] merge (Shape[] in, unsigned int min_wc) Description: Merge the given shapes
See the EdgeProcessor for a description of the merge method. This implementation takes shapes rather than polygons for input and produces an edge set. This version does not feature a transformation for each shape (unity is assumed). | |||||||||||||||||||||||
merge_to_polygon | (1) Signature: Polygon[] merge_to_polygon (Shape[] in, CplxTrans[] trans, unsigned int min_wc, bool resolve_holes, bool min_coherence) Description: Merge the given shapes
See the EdgeProcessor for a description of the merge method. This implementation takes shapes rather than polygons for input and produces a polygon set. | ||||||||||||||||||||||
(2) Signature: Polygon[] merge_to_polygon (Shape[] in, unsigned int min_wc, bool resolve_holes, bool min_coherence) Description: Merge the given shapes
See the EdgeProcessor for a description of the merge method. This implementation takes shapes rather than polygons for input and produces a polygon set. This version does not feature a transformation for each shape (unity is assumed). | |||||||||||||||||||||||
new | Signature: [static] new ShapeProcessor ptr new Description: Creates a new object of this class Python specific notes: | ||||||||||||||||||||||
size | (1) Signature: void size (const Layout layout, const Cell cell, unsigned int layer, Shapes out, int dx, int dy, unsigned int mode, bool hierarchical, bool resolve_holes, bool min_coherence) Description: Sizing operation on shapes from layouts
See the EdgeProcessor for a description of the sizing operation. This implementation takes shapes from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container. | ||||||||||||||||||||||
(2) Signature: void size (const Layout layout, const Cell cell, unsigned int layer, Shapes out, int d, unsigned int mode, bool hierarchical, bool resolve_holes, bool min_coherence) Description: Sizing operation on shapes from layouts
See the EdgeProcessor for a description of the sizing operation. This implementation takes shapes from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container. This is the isotropic version which does not allow specification of different sizing values in x and y-direction. | |||||||||||||||||||||||
(3) Signature: Edge[] size (Shape[] in, CplxTrans[] trans, int d, unsigned int mode) Description: Size the given shapes
See the EdgeProcessor for a description of the sizing method. This implementation takes shapes rather than polygons for input and produces an edge set. This is isotropic version that does not allow to specify different values in x and y direction. | |||||||||||||||||||||||
(4) Signature: Edge[] size (Shape[] in, CplxTrans[] trans, int dx, int dy, unsigned int mode) Description: Size the given shapes
See the EdgeProcessor for a description of the sizing method. This implementation takes shapes rather than polygons for input and produces an edge set. | |||||||||||||||||||||||
(5) Signature: Edge[] size (Shape[] in, int d, unsigned int mode) Description: Size the given shapes
See the EdgeProcessor for a description of the sizing method. This implementation takes shapes rather than polygons for input and produces an edge set. This is isotropic version that does not allow to specify different values in x and y direction. This version does not feature a transformation for each shape (unity is assumed). | |||||||||||||||||||||||
(6) Signature: Edge[] size (Shape[] in, int dx, int dy, unsigned int mode) Description: Size the given shapes
See the EdgeProcessor for a description of the sizing method. This implementation takes shapes rather than polygons for input and produces an edge set. This version does not feature a transformation for each shape (unity is assumed). | |||||||||||||||||||||||
size_to_polygon | (1) Signature: Polygon[] size_to_polygon (Shape[] in, CplxTrans[] trans, int d, unsigned int mode, bool resolve_holes, bool min_coherence) Description: Size the given shapes
See the EdgeProcessor for a description of the sizing method. This implementation takes shapes rather than polygons for input and produces a polygon set. This is isotropic version that does not allow to specify different values in x and y direction. | ||||||||||||||||||||||
(2) Signature: Polygon[] size_to_polygon (Shape[] in, CplxTrans[] trans, int dx, int dy, unsigned int mode, bool resolve_holes, bool min_coherence) Description: Size the given shapes
See the EdgeProcessor for a description of the sizing method. This implementation takes shapes rather than polygons for input and produces a polygon set. | |||||||||||||||||||||||
(3) Signature: Polygon[] size_to_polygon (Shape[] in, int d, unsigned int mode, bool resolve_holes, bool min_coherence) Description: Size the given shapes
See the EdgeProcessor for a description of the sizing method. This implementation takes shapes rather than polygons for input and produces a polygon set. This is isotropic version that does not allow to specify different values in x and y direction. This version does not feature a transformation for each shape (unity is assumed). | |||||||||||||||||||||||
(4) Signature: Polygon[] size_to_polygon (Shape[] in, int dx, int dy, unsigned int mode, bool resolve_holes, bool min_coherence) Description: Size the given shapes
See the EdgeProcessor for a description of the sizing method. This implementation takes shapes rather than polygons for input and produces a polygon set. This version does not feature a transformation for each shape (unity is assumed). |