Notation used in Ruby API documentation
Module: db
Description: A visitor for the neighborhood of polygons in the input
Class hierarchy: PolygonNeighborhoodVisitor
Objects of this class are passed to PolygonNeighborhoodCompoundOperationNode constructor to handle events on each edge of the primary input along with the neighborhood taken from the additional inputs.
See neighbors for the description of the events delivered. This class has been introduced in version 0.30.0.
| new PolygonNeighborhoodVisitorBase ptr | new | Creates a new object of this class |
| [const] | PolygonNeighborhoodVisitor 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 PolygonNeighborhoodVisitorBase other) | Assigns another object to self | |
| [const] | new PolygonNeighborhoodVisitorBase ptr | dup | Creates a copy of self | |
| [virtual] | void | neighbors | (const Layout ptr layout, const Cell ptr cell, const PolygonWithProperties polygon, map<unsigned int,PolygonWithProperties[]> neighborhood) | Is called for each polygon with the neighbors |
| void | output | (const PolygonWithProperties polygon) | Outputs a polygon | |
| void | output | (const EdgeWithProperties edge) | Outputs an edge | |
| void | output | (const EdgePairWithProperties edge_pair) | Outputs an edge pair | |
| [const] | CompoundRegionOperationNode::ResultType | result_type | Gets the result type | |
| void | result_type= | (CompoundRegionOperationNode::ResultType result_type) | Configures the result type |
| 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] PolygonNeighborhoodVisitor 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 PolygonNeighborhoodVisitorBase other) Description: Assigns another object to self |
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 PolygonNeighborhoodVisitorBase 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. |
neighbors | Signature: [virtual] void neighbors (const Layout ptr layout, const Cell ptr cell, const PolygonWithProperties polygon, map<unsigned int,PolygonWithProperties[]> neighborhood) Description: Is called for each polygon with the neighbors This method is called for every (merged) polygon on the input region. It delivers the polygon and the neighborhood. The neighborhood is a collection of polygons (with properties) vs. input index. It contains all polygons 'close to' the current polygon given by 'polygon'. 'Close to' does not necessarily refer to being exactly in the vicinity, but may include other polygons just entering the bounding box of the current polygon. |
new | Signature: [static] new PolygonNeighborhoodVisitorBase ptr new Description: Creates a new object of this class Python specific notes: |
output | (1) Signature: void output (const PolygonWithProperties polygon) Description: Outputs a polygon Use this method from one of the callbacks (on_edge, begin_polygon, end_polygon) to deliver a polygon. Note that you have to configure the result type as 'Region' on construction of the visitor before being able to do so. 'output' expects an object in original space - i.e. of the input edge. to_original_trans gives you a suitable transformation to bring objects from 'edge is horizontal' space into the original space. |
(2) Signature: void output (const EdgeWithProperties edge) Description: Outputs an edge Use this method from one of the callbacks (on_edge, begin_polygon, end_polygon) to deliver a polygon. Note that you have to configure the result type as 'Edges' on construction of the visitor before being able to do so. 'output' expects an object in original space - i.e. of the input edge. to_original_trans gives you a suitable transformation to bring objects from 'edge is horizontal' space into the original space. | |
(3) Signature: void output (const EdgePairWithProperties edge_pair) Description: Outputs an edge pair Use this method from one of the callbacks (on_edge, begin_polygon, end_polygon) to deliver a polygon. Note that you have to configure the result type as 'EdgePairs' on construction of the visitor before being able to do so. 'output' expects an object in original space - i.e. of the input edge. to_original_trans gives you a suitable transformation to bring objects from 'edge is horizontal' space into the original space. | |
result_type | Signature: [const] CompoundRegionOperationNode::ResultType result_type Description: Gets the result type Python specific notes: |
result_type= | Signature: void result_type= (CompoundRegionOperationNode::ResultType result_type) Description: Configures the result type Use this method to indicate what type of result you want to deliver. You can use the corresponding 'output' method then to deliver result shapes from one the callbacks (on_edge, begin_polygon, end_polygon). Set this attribute when you create the visitor object. This attribute does not need to be set if no output is indended to be delivered. Python specific notes: |