Notation used in Ruby API documentation
Module: db
Description: A simple transformation
Simple transformations only provide rotations about angles which a multiples of 90 degree. Together with the mirror options, this results in 8 distinct orientations (fixpoint transformations). These can be combined with a displacement which is applied after the rotation/mirror. This version acts on floating-point coordinates. A version for integer coordinates is Trans.
Here are some examples for using the DTrans class:
t = RBA::DTrans::new(0, 100) # displacement by 100 DBU in y direction # the inverse: -> "r0 0,-100" t.inverted.to_s # concatenation: -> "r90 -100,0" (RBA::DTrans::new(RBA::DTrans::R90) * t).to_s # apply to a point: -> "0,100" RBA::DTrans::new(RBA::DTrans::R90).trans(RBA::DPoint::new(100, 0))
See The Database API for more details about the database objects.
new DTrans ptr | new | (const Trans trans) | Creates a floating-point coordinate transformation from an integer coordinate transformation |
new DTrans ptr | new | Creates a unit transformation | |
new DTrans ptr | new | (const DTrans c, const DVector u = 0,0) | Creates a transformation from another transformation plus a displacement |
new DTrans ptr | new | (const DTrans c, double x = 0, double y = 0) | Creates a transformation from another transformation plus a displacement |
new DTrans ptr | new | (int rot = 0, bool mirrx = false, const DVector u = 0,0) | Creates a transformation using angle and mirror flag |
new DTrans ptr | new | (int rot = 0, bool mirrx = false, double x = 0, double y = 0) | Creates a transformation using angle and mirror flag and two coordinate values for displacement |
new DTrans ptr | new | (const DVector u) | Creates a transformation using a displacement only |
new DTrans ptr | new | (double x, double y) | Creates a transformation using a displacement given as two coordinates |
[const] | bool | != | (const DTrans other) | Tests for inequality |
[const] | double | * | (double d) | Transforms a single distance |
[const] | DPoint | * | (const DPoint p) | Transforms a point |
[const] | DVector | * | (const DVector v) | Transforms a vector |
[const] | DBox | * | (const DBox box) | Transforms a box |
[const] | DEdge | * | (const DEdge edge) | Transforms an edge |
[const] | DPolygon | * | (const DPolygon polygon) | Transforms a polygon |
[const] | DPath | * | (const DPath path) | Transforms a path |
[const] | DText | * | (const DText text) | Transforms a text |
[const] | DTrans | * | (const DTrans t) | Returns the concatenated transformation |
[const] | bool | < | (const DTrans other) | Provides a 'less' criterion for sorting |
[const] | bool | == | (const DTrans other) | Tests for equality |
[const] | DTrans 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] | int | angle | Gets the angle in units of 90 degree | |
void | angle= | (int a) | Sets the angle in units of 90 degree | |
void | assign | (const DTrans other) | Assigns another object to self | |
[const] | double | ctrans | (double d) | Transforms a single distance |
[const] | DVector | disp | Gets to the displacement vector | |
void | disp= | (const DVector u) | Sets the displacement | |
[const] | new DTrans ptr | dup | Creates a copy of self | |
[const] | unsigned long | hash | Computes a hash value | |
DTrans | invert | Inverts the transformation (in place) | ||
[const] | DTrans | inverted | Returns the inverted transformation | |
[const] | bool | is_mirror? | Gets the mirror flag | |
void | mirror= | (bool m) | Sets the mirror flag | |
[const] | int | rot | Gets the angle/mirror code | |
void | rot= | (int r) | Sets the angle/mirror code | |
[const] | Trans | to_itype | (double dbu = 1) | Converts the transformation to an integer coordinate transformation |
[const] | string | to_s | (double dbu = 0) | String conversion |
[const] | DPoint | trans | (const DPoint p) | Transforms a point |
[const] | DVector | trans | (const DVector v) | Transforms a vector |
[const] | DBox | trans | (const DBox box) | Transforms a box |
[const] | DEdge | trans | (const DEdge edge) | Transforms an edge |
[const] | DPolygon | trans | (const DPolygon polygon) | Transforms a polygon |
[const] | DPath | trans | (const DPath path) | Transforms a path |
[const] | DText | trans | (const DText text) | Transforms a text |
DTrans | M0 | A constant giving "mirrored at the x-axis" transformation | ||
DTrans | M135 | A constant giving "mirrored at the 135 degree axis" transformation | ||
DTrans | M45 | A constant giving "mirrored at the 45 degree axis" transformation | ||
DTrans | M90 | A constant giving "mirrored at the y (90 degree) axis" transformation | ||
DTrans | R0 | A constant giving "unrotated" (unit) transformation | ||
DTrans | R180 | A constant giving "rotated by 180 degree counterclockwise" transformation | ||
DTrans | R270 | A constant giving "rotated by 270 degree counterclockwise" transformation | ||
DTrans | R90 | A constant giving "rotated by 90 degree counterclockwise" transformation | ||
new DTrans ptr | from_s | (string s) | Creates a transformation 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 DTrans ptr | from_itrans | (const Trans trans) | 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 DTrans other) Description: Tests for inequality | |||||||
* | (1) Signature: [const] double * (double d) Description: Transforms a single distance
The "ctrans" method transforms the given distance. This is equivalent to multiplying with the magnification. For the simple transformations, there is no magnification and no modification of the distance. The product '*' has been added as a synonym in version 0.28. The distance can be signed since version 0.29.3. Python specific notes: | |||||||
(2) Signature: [const] DPoint * (const DPoint p) Description: Transforms a point
The "trans" method or the * operator transforms the given point. q = t(p) The * operator has been introduced in version 0.25. Python specific notes: | ||||||||
(3) Signature: [const] DVector * (const DVector v) Description: Transforms a vector
The "trans" method or the * operator transforms the given vector. w = t(v) Vector transformation has been introduced in version 0.25. Python specific notes: | ||||||||
(4) Signature: [const] DBox * (const DBox box) Description: Transforms a box
't*box' or 't.trans(box)' is equivalent to box.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(5) Signature: [const] DEdge * (const DEdge edge) Description: Transforms an edge
't*edge' or 't.trans(edge)' is equivalent to edge.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(6) Signature: [const] DPolygon * (const DPolygon polygon) Description: Transforms a polygon
't*polygon' or 't.trans(polygon)' is equivalent to polygon.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(7) Signature: [const] DPath * (const DPath path) Description: Transforms a path
't*path' or 't.trans(path)' is equivalent to path.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(8) Signature: [const] DText * (const DText text) Description: Transforms a text
't*text' or 't.trans(text)' is equivalent to text.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(9) Signature: [const] DTrans * (const DTrans t) Description: Returns the concatenated transformation
The * operator returns self*t ("t is applied before this transformation"). | ||||||||
< | Signature: [const] bool < (const DTrans other) Description: Provides a 'less' criterion for sorting This method is provided to implement a sorting order. The definition of 'less' is opaque and might change in future versions. | |||||||
== | Signature: [const] bool == (const DTrans other) Description: Tests for equality | |||||||
M0 | Signature: [static] DTrans M0 Description: A constant giving "mirrored at the x-axis" transformation The previous integer constant has been turned into a transformation in version 0.25. Python specific notes: | |||||||
M135 | Signature: [static] DTrans M135 Description: A constant giving "mirrored at the 135 degree axis" transformation The previous integer constant has been turned into a transformation in version 0.25. Python specific notes: | |||||||
M45 | Signature: [static] DTrans M45 Description: A constant giving "mirrored at the 45 degree axis" transformation The previous integer constant has been turned into a transformation in version 0.25. Python specific notes: | |||||||
M90 | Signature: [static] DTrans M90 Description: A constant giving "mirrored at the y (90 degree) axis" transformation The previous integer constant has been turned into a transformation in version 0.25. Python specific notes: | |||||||
R0 | Signature: [static] DTrans R0 Description: A constant giving "unrotated" (unit) transformation The previous integer constant has been turned into a transformation in version 0.25. Python specific notes: | |||||||
R180 | Signature: [static] DTrans R180 Description: A constant giving "rotated by 180 degree counterclockwise" transformation The previous integer constant has been turned into a transformation in version 0.25. Python specific notes: | |||||||
R270 | Signature: [static] DTrans R270 Description: A constant giving "rotated by 270 degree counterclockwise" transformation The previous integer constant has been turned into a transformation in version 0.25. Python specific notes: | |||||||
R90 | Signature: [static] DTrans R90 Description: A constant giving "rotated by 90 degree counterclockwise" transformation The previous integer constant has been turned into a transformation in version 0.25. Python specific notes: | |||||||
_const_cast | Signature: [const] DTrans 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. | |||||||
angle | Signature: [const] int angle Description: Gets the angle in units of 90 degree This value delivers the rotation component. In addition, a mirroring at the x axis may be applied before if the is_mirror? property is true. Python specific notes: | |||||||
angle= | Signature: void angle= (int a) Description: Sets the angle in units of 90 degree
This method was introduced in version 0.20. Python specific notes: | |||||||
assign | Signature: void assign (const DTrans 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. | |||||||
ctrans | Signature: [const] double ctrans (double d) Description: Transforms a single distance
The "ctrans" method transforms the given distance. This is equivalent to multiplying with the magnification. For the simple transformations, there is no magnification and no modification of the distance. The product '*' has been added as a synonym in version 0.28. The distance can be signed since version 0.29.3. Python specific notes: | |||||||
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. | |||||||
disp | Signature: [const] DVector disp Description: Gets to the displacement vector Staring with version 0.25 the displacement type is a vector. Python specific notes: | |||||||
disp= | Signature: void disp= (const DVector u) Description: Sets the displacement
This method was introduced in version 0.20. Staring with version 0.25 the displacement type is a vector. Python specific notes: | |||||||
dup | Signature: [const] new DTrans ptr dup Description: Creates a copy of self Python specific notes: | |||||||
from_itrans | Signature: [static] new DTrans ptr from_itrans (const Trans trans) Description: Creates a floating-point coordinate transformation from an integer coordinate transformation 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_itrans'. Python specific notes: | |||||||
from_s | Signature: [static] new DTrans ptr from_s (string s) Description: Creates a transformation 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 transformation. This method enables transformations as hash keys. This method has been introduced in version 0.25. Python specific notes: | |||||||
invert | Signature: DTrans invert Description: Inverts the transformation (in place)
Inverts the transformation and replaces this object by the inverted one. | |||||||
inverted | Signature: [const] DTrans inverted Description: Returns the inverted transformation
Returns the inverted transformation | |||||||
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. | |||||||
is_mirror? | Signature: [const] bool is_mirror? Description: Gets the mirror flag If this property is true, the transformation is composed of a mirroring at the x-axis followed by a rotation by the angle given by the angle property. Python specific notes: | |||||||
mirror= | Signature: void mirror= (bool m) Description: Sets the mirror flag
"mirroring" describes a reflection at the x-axis which is included in the transformation prior to rotation. This method was introduced in version 0.20. Python specific notes: | |||||||
new | (1) Signature: [static] new DTrans ptr new (const Trans trans) Description: Creates a floating-point coordinate transformation from an integer coordinate transformation This constructor has been introduced in version 0.25 and replaces the previous static method 'from_itrans'. Python specific notes: | |||||||
(2) Signature: [static] new DTrans ptr new Description: Creates a unit transformation Python specific notes: | ||||||||
(3) Signature: [static] new DTrans ptr new (const DTrans c, const DVector u = 0,0) Description: Creates a transformation from another transformation plus a displacement
Creates a new transformation from a existing transformation. This constructor is provided for creating duplicates and backward compatibility since the constants are transformations now. It will copy the original transformation and add the given displacement. This variant has been introduced in version 0.25. Python specific notes: | ||||||||
(4) Signature: [static] new DTrans ptr new (const DTrans c, double x = 0, double y = 0) Description: Creates a transformation from another transformation plus a displacement
Creates a new transformation from a existing transformation. This constructor is provided for creating duplicates and backward compatibility since the constants are transformations now. It will copy the original transformation and add the given displacement. This variant has been introduced in version 0.25. Python specific notes: | ||||||||
(5) Signature: [static] new DTrans ptr new (int rot = 0, bool mirrx = false, const DVector u = 0,0) Description: Creates a transformation using angle and mirror flag
The sequence of operations is: mirroring at x axis, rotation, application of displacement. Python specific notes: | ||||||||
(6) Signature: [static] new DTrans ptr new (int rot = 0, bool mirrx = false, double x = 0, double y = 0) Description: Creates a transformation using angle and mirror flag and two coordinate values for displacement
The sequence of operations is: mirroring at x axis, rotation, application of displacement. Python specific notes: | ||||||||
(7) Signature: [static] new DTrans ptr new (const DVector u) Description: Creates a transformation using a displacement only
Python specific notes: | ||||||||
(8) Signature: [static] new DTrans ptr new (double x, double y) Description: Creates a transformation using a displacement given as two coordinates
Python specific notes: | ||||||||
rot | Signature: [const] int rot Description: Gets the angle/mirror code The angle/mirror code is one of the constants R0, R90, R180, R270, M0, M45, M90 and M135. rx is the rotation by an angle of x counter clockwise. mx is the mirroring at the axis given by the angle x (to the x-axis). Python specific notes: | |||||||
rot= | Signature: void rot= (int r) Description: Sets the angle/mirror code
This method was introduced in version 0.20. Python specific notes: | |||||||
to_itype | Signature: [const] Trans to_itype (double dbu = 1) Description: Converts the transformation to an integer coordinate transformation The database unit can be specified to translate the floating-point coordinate transformation in micron units to an integer-coordinate transformation in database units. The transformation's' coordinates will be divided by the database unit. 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: | |||||||
trans | (1) Signature: [const] DPoint trans (const DPoint p) Description: Transforms a point
The "trans" method or the * operator transforms the given point. q = t(p) The * operator has been introduced in version 0.25. Python specific notes: | |||||||
(2) Signature: [const] DVector trans (const DVector v) Description: Transforms a vector
The "trans" method or the * operator transforms the given vector. w = t(v) Vector transformation has been introduced in version 0.25. Python specific notes: | ||||||||
(3) Signature: [const] DBox trans (const DBox box) Description: Transforms a box
't*box' or 't.trans(box)' is equivalent to box.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(4) Signature: [const] DEdge trans (const DEdge edge) Description: Transforms an edge
't*edge' or 't.trans(edge)' is equivalent to edge.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(5) Signature: [const] DPolygon trans (const DPolygon polygon) Description: Transforms a polygon
't*polygon' or 't.trans(polygon)' is equivalent to polygon.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(6) Signature: [const] DPath trans (const DPath path) Description: Transforms a path
't*path' or 't.trans(path)' is equivalent to path.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: | ||||||||
(7) Signature: [const] DText trans (const DText text) Description: Transforms a text
't*text' or 't.trans(text)' is equivalent to text.transformed(t). This convenience method has been introduced in version 0.25. Python specific notes: |