API reference - Class EdgeProcessor
Notation used in Ruby API documentation
Description: The edge processor (boolean, sizing, merge)
- Public constructors
- Public methods
- Public static methods and constants
- Deprecated methods (protected, public, static, non-static and constructors)
- Detailed description
The edge processor implements the boolean and edge set operations (size, merge). Because the edge processor might allocate resources which can be reused in later operations, it is implemented as an object that can be used several times.
Here is a simple example of how to use the edge processor:
ep = RBA::EdgeProcessor::new # Prepare two boxes a = [ RBA::Polygon::new(RBA::Box::new(0, 0, 300, 300)) ] b = [ RBA::Polygon::new(RBA::Box::new(100, 100, 200, 200)) ] # Run an XOR -> creates a polygon with a hole, since the 'resolve_holes' parameter # is false: out = ep.boolean_p2p(a, b, RBA::EdgeProcessor::ModeXor, false, false) out.to_s # -> [(0,0;0,300;300,300;300,0/100,100;200,100;200,200;100,200)]
Public constructors
| new EdgeProcessor ptr | new | Creates a new object of this class |
Public methods
| 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 EdgeProcessor other) | Assigns another object to self | |
| Edge[] | boolean_e2e | (Edge[] a, Edge[] b, int mode) | Boolean operation for a set of given edges, creating edges | |
| Polygon[] | boolean_e2p | (Edge[] a, Edge[] b, int mode, bool resolve_holes, bool min_coherence) | Boolean operation for a set of given edges, creating polygons | |
| Edge[] | boolean_p2e | (Polygon[] a, Polygon[] b, int mode) | Boolean operation for a set of given polygons, creating edges | |
| Polygon[] | boolean_p2p | (Polygon[] a, Polygon[] b, int mode, bool resolve_holes, bool min_coherence) | Boolean operation for a set of given polygons, creating polygons | |
| void | disable_progress | Disable progress reporting | ||
| [const] | new EdgeProcessor ptr | dup | Creates a copy of self | |
| void | enable_progress | (string label) | Enable progress reporting | |
| Edge[] | merge_p2e | (Polygon[] in, unsigned int min_wc) | Merge the given polygons | |
| Polygon[] | merge_p2p | (Polygon[] in, unsigned int min_wc, bool resolve_holes, bool min_coherence) | Merge the given polygons | |
| Edge[] | simple_merge_e2e | (Edge[] in) | Merge the given edges in a simple "non-zero wrapcount" fashion | |
| Edge[] | simple_merge_e2e | (Edge[] in, int mode) | Merge the given polygons and specify the merge mode | |
| Polygon[] | simple_merge_e2p | (Edge[] in, bool resolve_holes, bool min_coherence) | Merge the given edges in a simple "non-zero wrapcount" fashion into polygons | |
| Polygon[] | simple_merge_e2p | (Edge[] in, bool resolve_holes, bool min_coherence, int mode) | Merge the given polygons and specify the merge mode | |
| Edge[] | simple_merge_p2e | (Polygon[] in) | Merge the given polygons in a simple "non-zero wrapcount" fashion | |
| Edge[] | simple_merge_p2e | (Polygon[] in, int mode) | Merge the given polygons and specify the merge mode | |
| Polygon[] | simple_merge_p2p | (Polygon[] in, bool resolve_holes, bool min_coherence) | Merge the given polygons in a simple "non-zero wrapcount" fashion into polygons | |
| Polygon[] | simple_merge_p2p | (Polygon[] in, bool resolve_holes, bool min_coherence, int mode) | Merge the given polygons and specify the merge mode | |
| Edge[] | size_p2e | (Polygon[] in, int dx, int dy, unsigned int mode) | Size the given polygons | |
| Edge[] | size_p2e | (Polygon[] in, int d, unsigned int mode) | Size the given polygons (isotropic) | |
| Polygon[] | size_p2p | (Polygon[] in, int dx, int dy, unsigned int mode, bool resolve_holes, bool min_coherence) | Size the given polygons into polygons | |
| Polygon[] | size_p2p | (Polygon[] in, int d, unsigned int mode, bool resolve_holes, bool min_coherence) | Size the given polygons into polygons (isotropic) |
Public static methods and constants
| int | ModeANotB | boolean method's mode value for A NOT B operation | ||
| int | ModeAnd | boolean method's mode value for AND operation | ||
| int | ModeBNotA | boolean method's mode value for B NOT A operation | ||
| int | ModeOr | boolean method's mode value for OR operation | ||
| int | ModeXor | boolean method's mode value for XOR operation |
Deprecated methods (protected, public, static, non-static and constructors)
| Edge[] | boolean | (Polygon[] a, Polygon[] b, int mode) | Use of this method is deprecated. Use boolean_p2e instead | |
| Edge[] | boolean | (Edge[] a, Edge[] b, int mode) | Use of this method is deprecated. Use boolean_e2e instead | |
| Polygon[] | boolean_to_polygon | (Polygon[] a, Polygon[] b, int mode, bool resolve_holes, bool min_coherence) | Use of this method is deprecated. Use boolean_p2p instead | |
| Polygon[] | boolean_to_polygon | (Edge[] a, Edge[] b, int mode, bool resolve_holes, bool min_coherence) | Use of this method is deprecated. Use boolean_e2p instead | |
| 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 | |
| Edge[] | merge | (Polygon[] in, unsigned int min_wc) | Use of this method is deprecated. Use merge_p2e instead | |
| Polygon[] | merge_to_polygon | (Polygon[] in, unsigned int min_wc, bool resolve_holes, bool min_coherence) | Use of this method is deprecated. Use merge_p2p instead | |
| [static] | int | mode_and | Use of this method is deprecated. Use ModeAnd instead | |
| [static] | int | mode_anotb | Use of this method is deprecated. Use ModeANotB instead | |
| [static] | int | mode_bnota | Use of this method is deprecated. Use ModeBNotA instead | |
| [static] | int | mode_or | Use of this method is deprecated. Use ModeOr instead | |
| [static] | int | mode_xor | Use of this method is deprecated. Use ModeXor instead | |
| Edge[] | simple_merge | (Polygon[] in) | Use of this method is deprecated. Use simple_merge_p2e instead | |
| Edge[] | simple_merge | (Polygon[] in, int mode) | Use of this method is deprecated. Use simple_merge_p2e instead | |
| Edge[] | simple_merge | (Edge[] in) | Use of this method is deprecated. Use simple_merge_e2e instead | |
| Edge[] | simple_merge | (Edge[] in, int mode) | Use of this method is deprecated. Use simple_merge_e2e instead | |
| Polygon[] | simple_merge_to_polygon | (Polygon[] in, bool resolve_holes, bool min_coherence) | Use of this method is deprecated. Use simple_merge_p2p instead | |
| Polygon[] | simple_merge_to_polygon | (Polygon[] in, bool resolve_holes, bool min_coherence, int mode) | Use of this method is deprecated. Use simple_merge_p2p instead | |
| Polygon[] | simple_merge_to_polygon | (Edge[] in, bool resolve_holes, bool min_coherence) | Use of this method is deprecated. Use simple_merge_e2p instead | |
| Polygon[] | simple_merge_to_polygon | (Edge[] in, bool resolve_holes, bool min_coherence, int mode) | Use of this method is deprecated. Use simple_merge_e2p instead | |
| Edge[] | size | (Polygon[] in, int dx, int dy, unsigned int mode) | Use of this method is deprecated. Use size_p2e instead | |
| Edge[] | size | (Polygon[] in, int d, unsigned int mode) | Use of this method is deprecated. Use size_p2e instead | |
| Polygon[] | size_to_polygon | (Polygon[] in, int dx, int dy, unsigned int mode, bool resolve_holes, bool min_coherence) | Use of this method is deprecated. Use size_p2p instead | |
| Polygon[] | size_to_polygon | (Polygon[] in, int d, unsigned int mode, bool resolve_holes, bool min_coherence) | Use of this method is deprecated. Use size_p2p instead |
Detailed description
ModeANotB | Signature: [static] int ModeANotB Description: boolean method's mode value for A NOT B operation | ||||||||||||||
ModeAnd | Signature: [static] int ModeAnd Description: boolean method's mode value for AND operation | ||||||||||||||
ModeBNotA | Signature: [static] int ModeBNotA Description: boolean method's mode value for B NOT A operation | ||||||||||||||
ModeOr | Signature: [static] int ModeOr Description: boolean method's mode value for OR operation | ||||||||||||||
ModeXor | Signature: [static] int ModeXor Description: boolean method's mode value for XOR operation | ||||||||||||||
_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 EdgeProcessor other) Description: Assigns another object to self | ||||||||||||||
boolean | Signature: Edge[] boolean (Polygon[] a,Polygon[] b,int mode) Description: Boolean operation for a set of given polygons, creating edges
Use of this method is deprecated. Use boolean_p2e instead | ||||||||||||||
Signature: Edge[] boolean (Edge[] a,Edge[] b,int mode) Description: Boolean operation for a set of given edges, creating edges
Use of this method is deprecated. Use boolean_e2e instead | |||||||||||||||
boolean_e2e | Signature: Edge[] boolean_e2e (Edge[] a,Edge[] b,int mode) Description: Boolean operation for a set of given edges, creating edges
This method computes the result for the given boolean operation on two sets of edges. The input edges must form closed contours where holes and hulls must be oriented differently. The input edges are processed with a simple non-zero wrap count rule as a whole. The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while holes are oriented counter-clockwise. Prior to version 0.21 this method was called 'boolean'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
boolean_e2p | Signature: Polygon[] boolean_e2p (Edge[] a,Edge[] b,int mode,bool resolve_holes,bool min_coherence) Description: Boolean operation for a set of given edges, creating polygons
This method computes the result for the given boolean operation on two sets of edges. The input edges must form closed contours where holes and hulls must be oriented differently. The input edges are processed with a simple non-zero wrap count rule as a whole. This method produces polygons on output and allows to fine-tune the parameters for that purpose. Prior to version 0.21 this method was called 'boolean_to_polygon'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
boolean_p2e | Signature: Edge[] boolean_p2e (Polygon[] a,Polygon[] b,int mode) Description: Boolean operation for a set of given polygons, creating edges
This method computes the result for the given boolean operation on two sets of polygons. The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while holes are oriented counter-clockwise. This is a convenience method that bundles filling of the edges, processing with a Boolean operator and puts the result into an output vector. Prior to version 0.21 this method was called 'boolean'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
boolean_p2p | Signature: Polygon[] boolean_p2p (Polygon[] a,Polygon[] b,int mode,bool resolve_holes,bool min_coherence) Description: Boolean operation for a set of given polygons, creating polygons
This method computes the result for the given boolean operation on two sets of polygons. This method produces polygons on output and allows to fine-tune the parameters for that purpose. This is a convenience method that bundles filling of the edges, processing with a Boolean operator and puts the result into an output vector. Prior to version 0.21 this method was called 'boolean_to_polygon'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
boolean_to_polygon | Signature: Polygon[] boolean_to_polygon (Polygon[] a,Polygon[] b,int mode,bool resolve_holes,bool min_coherence) Description: Boolean operation for a set of given polygons, creating polygons
Use of this method is deprecated. Use boolean_p2p instead | ||||||||||||||
Signature: Polygon[] boolean_to_polygon (Edge[] a,Edge[] b,int mode,bool resolve_holes,bool min_coherence) Description: Boolean operation for a set of given edges, creating polygons
Use of this method is deprecated. Use boolean_e2p instead | |||||||||||||||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead | ||||||||||||||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead | ||||||||||||||
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 | ||||||||||||||
disable_progress | Signature: void disable_progress Description: Disable progress reporting Calling this method will stop the edge processor from showing a progress bar. See enable_progress. This method has been introduced in version 0.23. | ||||||||||||||
dup | Signature: [const] new EdgeProcessor ptr dup Description: Creates a copy of self | ||||||||||||||
enable_progress | Signature: void enable_progress (string label) Description: Enable progress reporting After calling this method, the edge processor will report the progress through a progress bar. 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. This method has been introduced in version 0.23. | ||||||||||||||
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 | ||||||||||||||
merge | Signature: Edge[] merge (Polygon[] in,unsigned int min_wc) Description: Merge the given polygons
Use of this method is deprecated. Use merge_p2e instead | ||||||||||||||
merge_p2e | Signature: Edge[] merge_p2e (Polygon[] in,unsigned int min_wc) Description: Merge the given polygons
In contrast to "simple_merge", this merge implementation considers each polygon individually before merging them. Thus self-overlaps are effectively removed before the output is computed and holes are correctly merged with the hull. In addition, this method allows to select areas with a higher wrap count which allows to compute overlaps of polygons on the same layer. Because this method merges the polygons before the overlap is computed, self-overlapping polygons do not contribute to higher wrap count areas. The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while holes are oriented counter-clockwise. Prior to version 0.21 this method was called 'merge'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
merge_p2p | Signature: Polygon[] merge_p2p (Polygon[] in,unsigned int min_wc,bool resolve_holes,bool min_coherence) Description: Merge the given polygons
In contrast to "simple_merge", this merge implementation considers each polygon individually before merging them. Thus self-overlaps are effectively removed before the output is computed and holes are correctly merged with the hull. In addition, this method allows to select areas with a higher wrap count which allows to compute overlaps of polygons on the same layer. Because this method merges the polygons before the overlap is computed, self-overlapping polygons do not contribute to higher wrap count areas. This method produces polygons and allows to fine-tune the parameters for that purpose. Prior to version 0.21 this method was called 'merge_to_polygon'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
merge_to_polygon | Signature: Polygon[] merge_to_polygon (Polygon[] in,unsigned int min_wc,bool resolve_holes,bool min_coherence) Description: Merge the given polygons
Use of this method is deprecated. Use merge_p2p instead | ||||||||||||||
mode_and | Signature: [static] int mode_and Description: boolean method's mode value for AND operation Use of this method is deprecated. Use ModeAnd instead | ||||||||||||||
mode_anotb | Signature: [static] int mode_anotb Description: boolean method's mode value for A NOT B operation Use of this method is deprecated. Use ModeANotB instead | ||||||||||||||
mode_bnota | Signature: [static] int mode_bnota Description: boolean method's mode value for B NOT A operation Use of this method is deprecated. Use ModeBNotA instead | ||||||||||||||
mode_or | Signature: [static] int mode_or Description: boolean method's mode value for OR operation Use of this method is deprecated. Use ModeOr instead | ||||||||||||||
mode_xor | Signature: [static] int mode_xor Description: boolean method's mode value for XOR operation Use of this method is deprecated. Use ModeXor instead | ||||||||||||||
new | Signature: [static] new EdgeProcessor ptr new Description: Creates a new object of this class Python specific notes: | ||||||||||||||
simple_merge | Signature: Edge[] simple_merge (Polygon[] in) Description: Merge the given polygons in a simple "non-zero wrapcount" fashion
Use of this method is deprecated. Use simple_merge_p2e instead | ||||||||||||||
Signature: Edge[] simple_merge (Polygon[] in,int mode) Description: Merge the given polygons and specify the merge mode
Use of this method is deprecated. Use simple_merge_p2e instead | |||||||||||||||
Signature: Edge[] simple_merge (Edge[] in) Description: Merge the given edges in a simple "non-zero wrapcount" fashion
Use of this method is deprecated. Use simple_merge_e2e instead | |||||||||||||||
Signature: Edge[] simple_merge (Edge[] in,int mode) Description: Merge the given polygons and specify the merge mode
Use of this method is deprecated. Use simple_merge_e2e instead | |||||||||||||||
simple_merge_e2e | Signature: Edge[] simple_merge_e2e (Edge[] in) Description: Merge the given edges in a simple "non-zero wrapcount" fashion
The egdes provided must form valid closed contours. Contours oriented differently "cancel" each other. Overlapping contours are merged when the orientation is the same. The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while holes are oriented counter-clockwise. This is a convenience method that bundles filling of the edges, processing with a SimpleMerge operator and puts the result into an output vector. Prior to version 0.21 this method was called 'simple_merge'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
Signature: Edge[] simple_merge_e2e (Edge[] in,int mode) Description: Merge the given polygons and specify the merge mode
The egdes provided must form valid closed contours. Contours oriented differently "cancel" each other. Overlapping contours are merged when the orientation is the same. The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while holes are oriented counter-clockwise. This is a convenience method that bundles filling of the edges, processing with a SimpleMerge operator and puts the result into an output vector. This method has been added in version 0.22. The mode specifies the rule to use when producing output. A value of 0 specifies the even-odd rule. A positive value specfies the wrap count threshold (postive only). A negative value specifies the threshold of the absolute value of the wrap count (i.e. -1 is non-zero rule). | |||||||||||||||
simple_merge_e2p | Signature: Polygon[] simple_merge_e2p (Edge[] in,bool resolve_holes,bool min_coherence) Description: Merge the given edges in a simple "non-zero wrapcount" fashion into polygons
The egdes provided must form valid closed contours. Contours oriented differently "cancel" each other. Overlapping contours are merged when the orientation is the same. This method produces polygons and allows to fine-tune the parameters for that purpose. This is a convenience method that bundles filling of the edges, processing with a SimpleMerge operator and puts the result into an output vector. Prior to version 0.21 this method was called 'simple_merge_to_polygon'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
Signature: Polygon[] simple_merge_e2p (Edge[] in,bool resolve_holes,bool min_coherence,int mode) Description: Merge the given polygons and specify the merge mode
The egdes provided must form valid closed contours. Contours oriented differently "cancel" each other. Overlapping contours are merged when the orientation is the same. This method produces polygons and allows to fine-tune the parameters for that purpose. This is a convenience method that bundles filling of the edges, processing with a SimpleMerge operator and puts the result into an output vector. This method has been added in version 0.22. The mode specifies the rule to use when producing output. A value of 0 specifies the even-odd rule. A positive value specfies the wrap count threshold (postive only). A negative value specifies the threshold of the absolute value of the wrap count (i.e. -1 is non-zero rule). | |||||||||||||||
simple_merge_p2e | Signature: Edge[] simple_merge_p2e (Polygon[] in) Description: Merge the given polygons in a simple "non-zero wrapcount" fashion
The wrapcount is computed over all polygons, i.e. overlapping polygons may "cancel" if they have different orientation (since a polygon is oriented by construction that is not easy to achieve). The other merge operation provided for this purpose is "merge" which normalizes each polygon individually before merging them. "simple_merge" is somewhat faster and consumes less memory. The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while holes are oriented counter-clockwise. This is a convenience method that bundles filling of the edges, processing with a SimpleMerge operator and puts the result into an output vector. Prior to version 0.21 this method was called 'simple_merge'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
Signature: Edge[] simple_merge_p2e (Polygon[] in,int mode) Description: Merge the given polygons and specify the merge mode
The wrapcount is computed over all polygons, i.e. overlapping polygons may "cancel" if they have different orientation (since a polygon is oriented by construction that is not easy to achieve). The other merge operation provided for this purpose is "merge" which normalizes each polygon individually before merging them. "simple_merge" is somewhat faster and consumes less memory. The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while holes are oriented counter-clockwise. This is a convenience method that bundles filling of the edges, processing with a SimpleMerge operator and puts the result into an output vector. This method has been added in version 0.22. The mode specifies the rule to use when producing output. A value of 0 specifies the even-odd rule. A positive value specfies the wrap count threshold (postive only). A negative value specifies the threshold of the absolute value of the wrap count (i.e. -1 is non-zero rule). | |||||||||||||||
simple_merge_p2p | Signature: Polygon[] simple_merge_p2p (Polygon[] in,bool resolve_holes,bool min_coherence) Description: Merge the given polygons in a simple "non-zero wrapcount" fashion into polygons
The wrapcount is computed over all polygons, i.e. overlapping polygons may "cancel" if they have different orientation (since a polygon is oriented by construction that is not easy to achieve). The other merge operation provided for this purpose is "merge" which normalizes each polygon individually before merging them. "simple_merge" is somewhat faster and consumes less memory. This method produces polygons and allows to fine-tune the parameters for that purpose. This is a convenience method that bundles filling of the edges, processing with a SimpleMerge operator and puts the result into an output vector. Prior to version 0.21 this method was called 'simple_merge_to_polygon'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
Signature: Polygon[] simple_merge_p2p (Polygon[] in,bool resolve_holes,bool min_coherence,int mode) Description: Merge the given polygons and specify the merge mode
The wrapcount is computed over all polygons, i.e. overlapping polygons may "cancel" if they have different orientation (since a polygon is oriented by construction that is not easy to achieve). The other merge operation provided for this purpose is "merge" which normalizes each polygon individually before merging them. "simple_merge" is somewhat faster and consumes less memory. This method produces polygons and allows to fine-tune the parameters for that purpose. This is a convenience method that bundles filling of the edges, processing with a SimpleMerge operator and puts the result into an output vector. This method has been added in version 0.22. The mode specifies the rule to use when producing output. A value of 0 specifies the even-odd rule. A positive value specfies the wrap count threshold (postive only). A negative value specifies the threshold of the absolute value of the wrap count (i.e. -1 is non-zero rule). | |||||||||||||||
simple_merge_to_polygon | Signature: Polygon[] simple_merge_to_polygon (Polygon[] in,bool resolve_holes,bool min_coherence) Description: Merge the given polygons in a simple "non-zero wrapcount" fashion into polygons
Use of this method is deprecated. Use simple_merge_p2p instead | ||||||||||||||
Signature: Polygon[] simple_merge_to_polygon (Polygon[] in,bool resolve_holes,bool min_coherence,int mode) Description: Merge the given polygons and specify the merge mode
Use of this method is deprecated. Use simple_merge_p2p instead | |||||||||||||||
Signature: Polygon[] simple_merge_to_polygon (Edge[] in,bool resolve_holes,bool min_coherence) Description: Merge the given edges in a simple "non-zero wrapcount" fashion into polygons
Use of this method is deprecated. Use simple_merge_e2p instead | |||||||||||||||
Signature: Polygon[] simple_merge_to_polygon (Edge[] in,bool resolve_holes,bool min_coherence,int mode) Description: Merge the given polygons and specify the merge mode
Use of this method is deprecated. Use simple_merge_e2p instead | |||||||||||||||
size | Signature: Edge[] size (Polygon[] in,int dx,int dy,unsigned int mode) Description: Size the given polygons
Use of this method is deprecated. Use size_p2e instead | ||||||||||||||
Signature: Edge[] size (Polygon[] in,int d,unsigned int mode) Description: Size the given polygons (isotropic)
Use of this method is deprecated. Use size_p2e instead | |||||||||||||||
size_p2e | Signature: Edge[] size_p2e (Polygon[] in,int dx,int dy,unsigned int mode) Description: Size the given polygons
This method sizes a set of polygons. Before the sizing is applied, the polygons are merged. After that, sizing is applied on the individual result polygons of the merge step. The result may contain overlapping contours, but no self-overlaps. dx and dy describe the sizing. A positive value indicates oversize (outwards) while a negative one describes undersize (inwards). The sizing applied can be choosen differently in x and y direction. In this case, the sign must be identical for both dx and dy. The 'mode' parameter describes the corner fill strategy. Mode 0 connects all corner segments directly. Mode 1 is the 'octagon' strategy in which square corners are interpolated with a partial octagon. Mode 2 is the standard mode in which corners are filled by expanding edges unless these edges form a sharp bend with an angle of more than 90 degree. In that case, the corners are cut off. In Mode 3, no cutoff occures up to a bending angle of 135 degree. Mode 4 and 5 are even more aggressive and allow very sharp bends without cutoff. This strategy may produce long spikes on sharply bending corners. The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while holes are oriented counter-clockwise. Prior to version 0.21 this method was called 'size'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
Signature: Edge[] size_p2e (Polygon[] in,int d,unsigned int mode) Description: Size the given polygons (isotropic)
This method is equivalent to calling the anisotropic version with identical dx and dy. Prior to version 0.21 this method was called 'size'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | |||||||||||||||
size_p2p | Signature: Polygon[] size_p2p (Polygon[] in,int dx,int dy,unsigned int mode,bool resolve_holes,bool min_coherence) Description: Size the given polygons into polygons
This method sizes a set of polygons. Before the sizing is applied, the polygons are merged. After that, sizing is applied on the individual result polygons of the merge step. The result may contain overlapping polygons, but no self-overlapping ones. Polygon overlap occures if the polygons are close enough, so a positive sizing makes polygons overlap. dx and dy describe the sizing. A positive value indicates oversize (outwards) while a negative one describes undersize (inwards). The sizing applied can be choosen differently in x and y direction. In this case, the sign must be identical for both dx and dy. The 'mode' parameter describes the corner fill strategy. Mode 0 connects all corner segments directly. Mode 1 is the 'octagon' strategy in which square corners are interpolated with a partial octagon. Mode 2 is the standard mode in which corners are filled by expanding edges unless these edges form a sharp bend with an angle of more than 90 degree. In that case, the corners are cut off. In Mode 3, no cutoff occures up to a bending angle of 135 degree. Mode 4 and 5 are even more aggressive and allow very sharp bends without cutoff. This strategy may produce long spikes on sharply bending corners. This method produces polygons and allows to fine-tune the parameters for that purpose. Prior to version 0.21 this method was called 'size_to_polygon'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | ||||||||||||||
Signature: Polygon[] size_p2p (Polygon[] in,int d,unsigned int mode,bool resolve_holes,bool min_coherence) Description: Size the given polygons into polygons (isotropic)
This method is equivalent to calling the anisotropic version with identical dx and dy. Prior to version 0.21 this method was called 'size_to_polygon'. Is was renamed to avoid ambiguities for empty input arrays. The old version is still available but deprecated. | |||||||||||||||
size_to_polygon | Signature: Polygon[] size_to_polygon (Polygon[] in,int dx,int dy,unsigned int mode,bool resolve_holes,bool min_coherence) Description: Size the given polygons into polygons
Use of this method is deprecated. Use size_p2p instead | ||||||||||||||
Signature: Polygon[] size_to_polygon (Polygon[] in,int d,unsigned int mode,bool resolve_holes,bool min_coherence) Description: Size the given polygons into polygons (isotropic)
Use of this method is deprecated. Use size_p2p instead |