Notation used in Ruby API documentation
Module: db
Description: An integer point class
Points represent a coordinate in the two-dimensional coordinate space of layout. They are not geometrical objects by itself. But they are frequently used in the database API for various purposes.
See The Database API for more details about the database objects.
| new Point ptr | new | (const DPoint dpoint) | Creates an integer coordinate point from a floating-point coordinate point |
| new Point ptr | new | Default constructor: creates a point at 0,0 | |
| new Point ptr | new | (const Vector v) | Default constructor: creates a point at from an vector |
| new Point ptr | new | (int x, int y) | Constructor for a point from two coordinate values |
| [const] | bool | != | (const Point p) | Inequality test operator |
| [const] | Point | * | (double f) | Scaling by some factor |
| Point | *= | (double f) | Scaling by some factor | |
| [const] | Point | + | (const Vector v) | Adds a vector to a point |
| [const] | Vector | - | (const Point p) | Subtract one point from another |
| [const] | Point | - | (const Vector v) | Subtract one vector from a point |
| [const] | Point | -@ | Compute the negative of a point | |
| [const] | Point | / | (double d) | Division by some divisor |
| Point | /= | (double d) | Division by some divisor | |
| [const] | bool | < | (const Point p) | "less" comparison operator |
| [const] | bool | == | (const Point p) | Equality test operator |
| [const] | Point 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. | ||
| [const] | double | abs | The absolute value of the point (Euclidian distance to 0,0) | |
| void | assign | (const Point other) | Assigns another object to self | |
| [const] | double | distance | (const Point d) | The Euclidian distance to another point |
| [const] | new Point ptr | dup | Creates a copy of self | |
| [const] | unsigned long | hash | Computes a hash value | |
| [const] | double | sq_abs | The square of the absolute value of the point (Euclidian distance to 0,0) | |
| [const] | double | sq_distance | (const Point d) | The square Euclidian distance to another point |
| [const] | DPoint | to_dtype | (double dbu = 1) | Converts the point to a floating-point coordinate point |
| [const] | string | to_s | (double dbu = 0) | String conversion. |
| [const] | Vector | to_v | Turns the point into a vector | |
| [const] | int | x | Accessor to the x coordinate | |
| void | x= | (int coord) | Write accessor to the x coordinate | |
| [const] | int | y | Accessor to the y coordinate | |
| void | y= | (int coord) | Write accessor to the y coordinate |
| new Point ptr | from_s | (string s) | Creates an object from a string |
| 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 Point ptr | from_dpoint | (const DPoint dpoint) | 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 |
!= | Signature: [const] bool != (const Point p) Description: Inequality test operator | ||
* | Signature: [const] Point * (double f) Description: Scaling by some factor Returns the scaled object. All coordinates are multiplied with the given factor and if necessary rounded. Python specific notes: | ||
*= | Signature: Point *= (double f) Description: Scaling by some factor Scales object in place. All coordinates are multiplied with the given factor and if necessary rounded. | ||
+ | Signature: [const] Point + (const Vector v) Description: Adds a vector to a point Adds vector v to self by adding the coordinates. Starting with version 0.25, this method expects a vector argument. | ||
- | (1) Signature: [const] Vector - (const Point p) Description: Subtract one point from another Subtract point p from self by subtracting the coordinates. This renders a vector. Starting with version 0.25, this method renders a vector. | ||
(2) Signature: [const] Point - (const Vector v) Description: Subtract one vector from a point Subtract vector v from from self by subtracting the coordinates. This renders a point. This method has been added in version 0.27. | |||
-@ | Signature: [const] Point -@ Description: Compute the negative of a point Returns a new point with -x, -y. This method has been added in version 0.23. | ||
/ | Signature: [const] Point / (double d) Description: Division by some divisor Returns the scaled object. All coordinates are divided with the given divisor and if necessary rounded. | ||
/= | Signature: Point /= (double d) Description: Division by some divisor Divides the object in place. All coordinates are divided with the given divisor and if necessary rounded. | ||
< | Signature: [const] bool < (const Point p) Description: "less" comparison operator This operator is provided to establish a sorting order | ||
== | Signature: [const] bool == (const Point p) Description: Equality test operator | ||
_const_cast | Signature: [const] Point 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. | ||
abs | Signature: [const] double abs Description: The absolute value of the point (Euclidian distance to 0,0) The returned value is 'sqrt(x*x+y*y)'. This method has been introduced in version 0.23. | ||
assign | Signature: void assign (const Point 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. | ||
distance | Signature: [const] double distance (const Point d) Description: The Euclidian distance to another point
| ||
dup | Signature: [const] new Point ptr dup Description: Creates a copy of self Python specific notes: | ||
from_dpoint | Signature: [static] new Point ptr from_dpoint (const DPoint dpoint) Description: Creates an integer coordinate point from a floating-point coordinate point Use of this method is deprecated. Use new instead This constructor has been introduced in version 0.25 and replaces the previous static method 'from_dpoint'. Python specific notes: | ||
from_s | Signature: [static] new Point 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 point. This method enables points 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 This method returns true, if self is a const reference. In that case, only const methods may be called on self. | ||
new | (1) Signature: [static] new Point ptr new (const DPoint dpoint) Description: Creates an integer coordinate point from a floating-point coordinate point This constructor has been introduced in version 0.25 and replaces the previous static method 'from_dpoint'. Python specific notes: | ||
(2) Signature: [static] new Point ptr new Description: Default constructor: creates a point at 0,0 Python specific notes: | |||
(3) Signature: [static] new Point ptr new (const Vector v) Description: Default constructor: creates a point at from an vector This constructor is equivalent to computing point(0,0)+v. This method has been introduced in version 0.25. Python specific notes: | |||
(4) Signature: [static] new Point ptr new (int x, int y) Description: Constructor for a point from two coordinate values Python specific notes: | |||
sq_abs | Signature: [const] double sq_abs Description: The square of the absolute value of the point (Euclidian distance to 0,0) The returned value is 'x*x+y*y'. This method has been introduced in version 0.23. | ||
sq_distance | Signature: [const] double sq_distance (const Point d) Description: The square Euclidian distance to another point
| ||
to_dtype | Signature: [const] DPoint to_dtype (double dbu = 1) Description: Converts the point to a floating-point coordinate point The database unit can be specified to translate the integer-coordinate point into a floating-point coordinate point 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 (double dbu = 0) Description: String conversion. If a DBU is given, the output units will be micrometers. The DBU argument has been added in version 0.27.6. Python specific notes: | ||
to_v | Signature: [const] Vector to_v Description: Turns the point into a vector This method returns a vector representing the distance from (0,0) to the point.This method has been introduced in version 0.25. | ||
x | Signature: [const] int x Description: Accessor to the x coordinate Python specific notes: | ||
x= | Signature: void x= (int coord) Description: Write accessor to the x coordinate Python specific notes: | ||
y | Signature: [const] int y Description: Accessor to the y coordinate Python specific notes: | ||
y= | Signature: void y= (int coord) Description: Write accessor to the y coordinate Python specific notes: |