API reference - Class Path
Notation used in Ruby API documentation
Description: A path class
- Public constructors
- Public methods
- Public static methods and constants
- Deprecated methods (protected, public, static, non-static and constructors)
- Detailed description
A path consists of an sequence of line segments forming the 'spine' of the path and a width. In addition, the starting point can be drawn back by a certain extent (the 'begin extension') and the end point can be pulled forward somewhat (by the 'end extension').
A path may have round ends for special purposes. In particular, a round-ended path with a single point can represent a circle. Round-ended paths should have being and end extensions equal to half the width. Non-round-ended paths with a single point are allowed but the definition of the resulting shape in not well defined and may differ in other tools.
See The Database API for more details about the database objects.
Public constructors
| new Path ptr | new | (const DPath dpath) | Creates an integer coordinate path from a floating-point coordinate path |
| new Path ptr | new | Default constructor: creates an empty (invalid) path with width 0 | |
| new Path ptr | new | (Point[] pts, int width) | Constructor given the points of the path's spine and the width |
| new Path ptr | new | (Point[] pts, int width, int bgn_ext, int end_ext) | Constructor given the points of the path's spine, the width and the extensions |
| new Path ptr | new | (Point[] pts, int width, int bgn_ext, int end_ext, bool round) | Constructor given the points of the path's spine, the width, the extensions and the round end flag |
Public methods
| [const] | bool | != | (const Path p) | Inequality test |
| [const] | Path | * | (double f) | Scaling by some factor |
| [const] | bool | < | (const Path p) | Less operator |
| [const] | bool | == | (const Path p) | Equality test |
| 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. | ||
| [const] | long | area | Returns the approximate area of the path | |
| void | assign | (const Path other) | Assigns another object to self | |
| [const] | Box | bbox | Returns the bounding box of the path | |
| [const] | int | bgn_ext | Get the begin extension | |
| void | bgn_ext= | (int ext) | Set the begin extension | |
| [const] | new Path ptr | dup | Creates a copy of self | |
| [const,iter] | Point | each_point | Get the points that make up the path's spine | |
| [const] | int | end_ext | Get the end extension | |
| void | end_ext= | (int ext) | Set the end extension | |
| [const] | unsigned long | hash | Computes a hash value | |
| [const] | bool | is_round? | Returns true, if the path has round ends | |
| [const] | unsigned int | length | Returns the length of the path | |
| Path | move | (const Vector p) | Moves the path. | |
| Path | move | (int dx, int dy) | Moves the path. | |
| [const] | Path | moved | (const Vector p) | Returns the moved path (does not change self) |
| [const] | Path | moved | (int dx, int dy) | Returns the moved path (does not change self) |
| [const] | unsigned long | num_points | Get the number of points | |
| [const] | unsigned long | perimeter | Returns the approximate perimeter of the path | |
| void | points= | (Point[] p) | Set the points of the path | |
| [const] | Polygon | polygon | Convert the path to a polygon | |
| void | round= | (bool round_ends_flag) | Set the 'round ends' flag | |
| [const] | Path | round_corners | (double radius, int npoints) | Creates a new path whose corners are interpolated with circular bends |
| [const] | SimplePolygon | simple_polygon | Convert the path to a simple polygon | |
| [const] | DPath | to_dtype | (double dbu = 1) | Converts the path to a floating-point coordinate path |
| [const] | string | to_s | Convert to a string | |
| [const] | Path | transformed | (const ICplxTrans t) | Transform the path. |
| [const] | Path | transformed | (const Trans t) | Transform the path. |
| [const] | DPath | transformed | (const CplxTrans t) | Transform the path. |
| [const] | int | width | Get the width | |
| void | width= | (int w) | Set the width |
Public static methods and constants
| new Path ptr | from_s | (string s) | Creates an object from a string |
Deprecated methods (protected, public, static, non-static and constructors)
| 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 | |
| [static] | new Path ptr | from_dpath | (const DPath dpath) | Use of this method is deprecated. Use new instead |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead | |
| [static] | new Path ptr | new_pw | (Point[] pts, int width) | Use of this method is deprecated. Use new instead |
| [static] | new Path ptr | new_pwx | (Point[] pts, int width, int bgn_ext, int end_ext) | Use of this method is deprecated. Use new instead |
| [static] | new Path ptr | new_pwxr | (Point[] pts, int width, int bgn_ext, int end_ext, bool round) | Use of this method is deprecated. Use new instead |
| [const] | unsigned long | points | Use of this method is deprecated. Use num_points instead | |
| [const] | DPath | transformed_cplx | (const CplxTrans t) | Use of this method is deprecated. Use transformed instead |
Detailed description
!= | Signature: [const] bool != (const Path p) Description: Inequality test
| ||||||||||
* | Signature: [const] Path * (double f) Description: Scaling by some factor Returns the scaled object. All coordinates are multiplied with the given factor and if necessary rounded. | ||||||||||
< | Signature: [const] bool < (const Path p) Description: Less operator
This operator is provided to establish some, not necessarily a certain sorting order | ||||||||||
== | Signature: [const] bool == (const Path p) Description: Equality test
| ||||||||||
_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. | ||||||||||
area | Signature: [const] long area Description: Returns the approximate area of the path This method returns the approximate value of the area. It is computed from the length times the width. end extensions are taken into account correctly, but not effects of the corner interpolation. This method was added in version 0.22. | ||||||||||
assign | Signature: void assign (const Path other) Description: Assigns another object to self | ||||||||||
bbox | Signature: [const] Box bbox Description: Returns the bounding box of the path | ||||||||||
bgn_ext | Signature: [const] int bgn_ext Description: Get the begin extension Python specific notes: | ||||||||||
bgn_ext= | Signature: void bgn_ext= (int ext) Description: Set the begin extension Python specific notes: | ||||||||||
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 | ||||||||||
dup | Signature: [const] new Path ptr dup Description: Creates a copy of self | ||||||||||
each_point | Signature: [const,iter] Point each_point Description: Get the points that make up the path's spine | ||||||||||
end_ext | Signature: [const] int end_ext Description: Get the end extension Python specific notes: | ||||||||||
end_ext= | Signature: void end_ext= (int ext) Description: Set the end extension Python specific notes: | ||||||||||
from_dpath | Signature: [static] new Path ptr from_dpath (const DPath dpath) Description: Creates an integer coordinate path from a floating-point coordinate path Use of this method is deprecated. Use new instead Python specific notes: | ||||||||||
from_s | Signature: [static] new Path ptr 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. | ||||||||||
hash | Signature: [const] unsigned long hash Description: Computes a hash value Returns a hash value for the given polygon. This method enables polygons as hash keys. This method has been introduced in version 0.25. 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 | ||||||||||
is_round? | Signature: [const] bool is_round? Description: Returns true, if the path has round ends | ||||||||||
length | Signature: [const] unsigned int length Description: Returns the length of the path the length of the path is determined by summing the lengths of the segments and adding begin and end extensions. For round-ended paths the length of the paths between the tips of the ends. This method was added in version 0.23. | ||||||||||
move | Signature: Path move (const Vector p) Description: Moves the path.
Moves the path by the given offset and returns the moved path. The path is overwritten. | ||||||||||
Signature: Path move (int dx,int dy) Description: Moves the path.
Moves the path by the given offset and returns the moved path. The path is overwritten. This version has been added in version 0.23. | |||||||||||
moved | Signature: [const] Path moved (const Vector p) Description: Returns the moved path (does not change self)
Moves the path by the given offset and returns the moved path. The path is not modified. | ||||||||||
Signature: [const] Path moved (int dx,int dy) Description: Returns the moved path (does not change self)
Moves the path by the given offset and returns the moved path. The path is not modified. This version has been added in version 0.23. | |||||||||||
new | Signature: [static] new Path ptr new (const DPath dpath) Description: Creates an integer coordinate path from a floating-point coordinate path This constructor has been introduced in version 0.25 and replaces the previous static method 'from_dpath'. Python specific notes: | ||||||||||
Signature: [static] new Path ptr new Description: Default constructor: creates an empty (invalid) path with width 0 Python specific notes: | |||||||||||
Signature: [static] new Path ptr new (Point[] pts,int width) Description: Constructor given the points of the path's spine and the width
Python specific notes: | |||||||||||
Signature: [static] new Path ptr new (Point[] pts,int width,int bgn_ext,int end_ext) Description: Constructor given the points of the path's spine, the width and the extensions
Python specific notes: | |||||||||||
Signature: [static] new Path ptr new (Point[] pts,int width,int bgn_ext,int end_ext,bool round) Description: Constructor given the points of the path's spine, the width, the extensions and the round end flag
Python specific notes: | |||||||||||
new_pw | Signature: [static] new Path ptr new_pw (Point[] pts,int width) Description: Constructor given the points of the path's spine and the width
Use of this method is deprecated. Use new instead Python specific notes: | ||||||||||
new_pwx | Signature: [static] new Path ptr new_pwx (Point[] pts,int width,int bgn_ext,int end_ext) Description: Constructor given the points of the path's spine, the width and the extensions
Use of this method is deprecated. Use new instead Python specific notes: | ||||||||||
new_pwxr | Signature: [static] new Path ptr new_pwxr (Point[] pts,int width,int bgn_ext,int end_ext,bool round) Description: Constructor given the points of the path's spine, the width, the extensions and the round end flag
Use of this method is deprecated. Use new instead Python specific notes: | ||||||||||
num_points | Signature: [const] unsigned long num_points Description: Get the number of points Python specific notes: | ||||||||||
perimeter | Signature: [const] unsigned long perimeter Description: Returns the approximate perimeter of the path This method returns the approximate value of the perimeter. It is computed from the length and the width. end extensions are taken into account correctly, but not effects of the corner interpolation. This method was added in version 0.24.4. | ||||||||||
points | Signature: [const] unsigned long points Description: Get the number of points Use of this method is deprecated. Use num_points instead Python specific notes: | ||||||||||
points= | Signature: void points= (Point[] p) Description: Set the points of the path
Python specific notes: | ||||||||||
polygon | Signature: [const] Polygon polygon Description: Convert the path to a polygon The returned polygon is not guaranteed to be non-self overlapping. This may happen if the path overlaps itself or contains very short segments. | ||||||||||
round= | Signature: void round= (bool round_ends_flag) Description: Set the 'round ends' flag A path with round ends show half circles at the ends, instead of square or rectangular ends. Paths with this flag set should use a begin and end extension of half the width (see bgn_ext and end_ext). The interpretation of such paths in other tools may differ otherwise. Python specific notes: | ||||||||||
round_corners | Signature: [const] Path round_corners (double radius,int npoints) Description: Creates a new path whose corners are interpolated with circular bends
This method has been introduced in version 0.25. | ||||||||||
simple_polygon | Signature: [const] SimplePolygon simple_polygon Description: Convert the path to a simple polygon The returned polygon is not guaranteed to be non-selfoverlapping. This may happen if the path overlaps itself or contains very short segments. | ||||||||||
to_dtype | Signature: [const] DPath to_dtype (double dbu = 1) Description: Converts the path to a floating-point coordinate path The database unit can be specified to translate the integer-coordinate path into a floating-point coordinate path in micron units. The database unit is basically a scaling factor. This method has been introduced in version 0.25. | ||||||||||
to_s | Signature: [const] string to_s Description: Convert to a string Python specific notes: | ||||||||||
transformed | Signature: [const] Path transformed (const ICplxTrans t) Description: Transform the path.
Transforms the path with the given complex transformation. Does not modify the path but returns the transformed path. This method has been introduced in version 0.18. | ||||||||||
Signature: [const] Path transformed (const Trans t) Description: Transform the path.
Transforms the path with the given transformation. Does not modify the path but returns the transformed path. | |||||||||||
Signature: [const] DPath transformed (const CplxTrans t) Description: Transform the path.
Transforms the path with the given complex transformation. Does not modify the path but returns the transformed path. | |||||||||||
transformed_cplx | Signature: [const] DPath transformed_cplx (const CplxTrans t) Description: Transform the path.
Use of this method is deprecated. Use transformed instead | ||||||||||
width | Signature: [const] int width Description: Get the width Python specific notes: | ||||||||||
width= | Signature: void width= (int w) Description: Set the width Python specific notes: |