
KLayout Documentation (Qt 4): Main Index » Class Index » API reference  Class Matrix3d API reference  Class Matrix3dNotation used in Ruby API documentation Description: A 3d matrix object used mainly for representing rotation, shear, displacement and perspective transformations. This object represents a 3x3 matrix. This matrix is used to represent geometrical transformations in the 2d space mainly. It can be decomposed into basic transformations: mirroring, rotation, shear, displacement and perspective distortion. In that case, the assumed execution order of the basic transformations is mirroring at the x axis, rotation, magnification, shear, displacement and perspective distortion. This class was introduced in version 0.22.
Public constructorsnew Matrix3d ptr  new   Create a new Matrix3d representing a unit transformation  new Matrix3d ptr  new  (double m)  Create a new Matrix3d representing a magnification  new Matrix3d ptr  new  (const DCplxTrans arg1)  Create a new Matrix3d from the given complex transformation@args t  new Matrix3d ptr  new  (double m11, double m12, double m21, double m22)  Create a new Matrix3d from the four coefficients of a Matrix2d  new Matrix3d ptr  new  (double m11, double m12, double m21, double m22, double dx, double dy)  Create a new Matrix3d from the four coefficients of a Matrix2d plus a displacement  new Matrix3d ptr  new  (double m11, double m12, double m13, double m21, double m22, double m23, double m31, double m32, double m33)  Create a new Matrix3d from the nine matrix coefficients 
Public methods[const]  Matrix3d  *  (const Matrix3d m)  Product of two matrices.  [const]  DPoint  *  (const DPoint p)  Transform a point.  [const]  Matrix3d  +  (const Matrix3d m)  Sum of two matrices.   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  adjust  (DPoint[] landmarks_before, DPoint[] landmarks_after, int flags, int fixed_point)  Adjust a 3d matrix to match the given set of landmarks  [const]  double  angle   Returns the rotation angle of the rotation component of this matrix.   void  assign  (const Matrix3d other)  Assigns another object to self  [const]  DCplxTrans  cplx_trans   Converts this matrix to a complex transformation (if possible).  [const]  DVector  disp   Returns the displacement vector of this transformation.  [const]  new Matrix3d ptr  dup   Creates a copy of self  [const]  Matrix3d  inverted   The inverse of this matrix.  [const]  bool  is_mirror?   Returns the mirror flag of this matrix.  [const]  double  m  (int i, int j)  Gets the m coefficient with the given index.  [const]  double  mag_x   Returns the x magnification of the magnification component of this matrix.  [const]  double  mag_y   Returns the y magnification of the magnification component of this matrix.  [const]  double  shear_angle   Returns the magnitude of the shear component of this matrix.  [const]  string  to_s   Convert the matrix to a string.  [const]  DPoint  trans  (const DPoint p)  Transforms a point with this matrix.  [const]  double  tx  (double z)  Returns the perspective tilt angle tx.  [const]  double  ty  (double z)  Returns the perspective tilt angle ty. 
Public static methods and constants  int  AdjustAll   Mode for adjust: currently equivalent to adjust_perspective   int  AdjustDisplacement   Mode for adjust: adjust displacement only   int  AdjustMagnification   Mode for adjust: adjust rotation, mirror option and magnification   int  AdjustNone   Mode for adjust: adjust nothing   int  AdjustPerspective   Mode for adjust: adjust whole matrix including perspective transformation   int  AdjustRotation   Mode for adjust: adjust rotation only   int  AdjustRotationMirror   Mode for adjust: adjust rotation and mirror option   int  AdjustShear   Mode for adjust: adjust rotation, mirror option, magnification and shear   new Matrix3d ptr  newc  (double mag, double rotation, bool mirrx)  Create a new Matrix3d representing a isotropic magnification, rotation and mirroring   new Matrix3d ptr  newc  (double shear, double mx, double my, double rotation, bool mirrx)  Create a new Matrix3d representing a shear, anisotropic magnification, rotation and mirroring   new Matrix3d ptr  newc  (const DVector u, double shear, double mx, double my, double rotation, bool mirrx)  Create a new Matrix3d representing a displacement, shear, anisotropic magnification, rotation and mirroring   new Matrix3d ptr  newc  (double tx, double ty, double z, const DVector u, double shear, double mx, double my, double rotation, bool mirrx)  Create a new Matrix3d representing a perspective distortion, displacement, shear, anisotropic magnification, rotation and mirroring 
Deprecated methods (protected, public, static, nonstatic 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  [const]  bool  is_const_object?   Use of this method is deprecated. Use _is_const_object? instead 
Detailed description*  Signature: [const] Matrix3d * (const Matrix3d m) Description: Product of two matrices. m:  The other matrix.  Returns:  The matrix product self*m 
 Signature: [const] DPoint * (const DPoint p) Description: Transform a point. p:  The point to transform.  Returns:  The transformed point 
 +  Signature: [const] Matrix3d + (const Matrix3d m) Description: Sum of two matrices. m:  The other matrix.  Returns:  The (elementwise) sum of self+m 
 AdjustAll  Signature: [static] int AdjustAll Description: Mode for adjust: currently equivalent to adjust_perspective  AdjustDisplacement  Signature: [static] int AdjustDisplacement Description: Mode for adjust: adjust displacement only  AdjustMagnification  Signature: [static] int AdjustMagnification Description: Mode for adjust: adjust rotation, mirror option and magnification  AdjustNone  Signature: [static] int AdjustNone Description: Mode for adjust: adjust nothing  AdjustPerspective  Signature: [static] int AdjustPerspective Description: Mode for adjust: adjust whole matrix including perspective transformation  AdjustRotation  Signature: [static] int AdjustRotation Description: Mode for adjust: adjust rotation only  AdjustRotationMirror  Signature: [static] int AdjustRotationMirror Description: Mode for adjust: adjust rotation and mirror option  AdjustShear  Signature: [static] int AdjustShear Description: Mode for adjust: adjust rotation, mirror option, magnification and shear  _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.  adjust  Signature: void adjust (DPoint[] landmarks_before,DPoint[] landmarks_after,int flags,int fixed_point) Description: Adjust a 3d matrix to match the given set of landmarks landmarks_before:  The points before the transformation.  landmarks_after:  The points after the transformation.  mode:  Selects the adjustment mode. Must be one of the Adjust... constants.  fixed_point:  The index of the fixed point (one that is definitly mapped to the target) or 1 if there is none 
This function tries to adjust the matrix
such, that either the matrix is changed as little as possible (if few landmarks are given)
or that the "after" landmarks will match as close as possible to the "before" landmarks
(if the problem is overdetermined).  angle  Signature: [const] double angle Description: Returns the rotation angle of the rotation component of this matrix. Returns:  The angle in degree. 
See the description of this class for details about the basic transformations.  assign  Signature: void assign (const Matrix3d other) Description: Assigns another object to self  cplx_trans  Signature: [const] DCplxTrans cplx_trans Description: Converts this matrix to a complex transformation (if possible). Returns:  The complex transformation. 
This method is successful only if the matrix does not contain shear or perspective distortion components and the magnification must be isotropic.
 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  disp  Signature: [const] DVector disp Description: Returns the displacement vector of this transformation. Returns:  The displacement vector. 
Starting with version 0.25 this method returns a vector type instead of a point.  dup  Signature: [const] new Matrix3d ptr dup Description: Creates a copy of self  inverted  Signature: [const] Matrix3d inverted Description: The inverse of this matrix. Returns:  The inverse of this matrix 
 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_mirror?  Signature: [const] bool is_mirror? Description: Returns the mirror flag of this matrix. Returns:  True if this matrix has a mirror component. 
See the description of this class for details about the basic transformations.  m  Signature: [const] double m (int i,int j) Description: Gets the m coefficient with the given index. Returns:  The coefficient [i,j] 
 mag_x  Signature: [const] double mag_x Description: Returns the x magnification of the magnification component of this matrix. Returns:  The magnification factor. 
 mag_y  Signature: [const] double mag_y Description: Returns the y magnification of the magnification component of this matrix. Returns:  The magnification factor. 
 new  Signature: [static] new Matrix3d ptr new Description: Create a new Matrix3d representing a unit transformation Python specific notes: This method is the default initializer of the object
 Signature: [static] new Matrix3d ptr new (double m) Description: Create a new Matrix3d representing a magnification Python specific notes: This method is the default initializer of the object
 Signature: [static] new Matrix3d ptr new (const DCplxTrans arg1) Description: Create a new Matrix3d from the given complex transformation@args t t:  The transformation from which to create the matrix 
Python specific notes: This method is the default initializer of the object
 Signature: [static] new Matrix3d ptr new (double m11,double m12,double m21,double m22) Description: Create a new Matrix3d from the four coefficients of a Matrix2d Python specific notes: This method is the default initializer of the object
 Signature: [static] new Matrix3d ptr new (double m11,double m12,double m21,double m22,double dx,double dy) Description: Create a new Matrix3d from the four coefficients of a Matrix2d plus a displacement Python specific notes: This method is the default initializer of the object
 Signature: [static] new Matrix3d ptr new (double m11,double m12,double m13,double m21,double m22,double m23,double m31,double m32,double m33) Description: Create a new Matrix3d from the nine matrix coefficients Python specific notes: This method is the default initializer of the object
 newc  Signature: [static] new Matrix3d ptr newc (double mag,double rotation,bool mirrx) Description: Create a new Matrix3d representing a isotropic magnification, rotation and mirroring mag:  The magnification  rotation:  The rotation angle (in degree)  mirrx:  The mirror flag (at x axis) 
The order of execution of the operations is mirror, magnification and rotation.
This constructor is called 'newc' to distinguish it from the constructors taking coefficients ('c' is for composite).
 Signature: [static] new Matrix3d ptr newc (double shear,double mx,double my,double rotation,bool mirrx) Description: Create a new Matrix3d representing a shear, anisotropic magnification, rotation and mirroring shear:  The shear angle  mx:  The magnification in x direction  mx:  The magnification in y direction  rotation:  The rotation angle (in degree)  mirrx:  The mirror flag (at x axis) 
The order of execution of the operations is mirror, magnification, rotation and shear.
This constructor is called 'newc' to distinguish it from the constructor taking the four matrix coefficients ('c' is for composite).
 Signature: [static] new Matrix3d ptr newc (const DVector u,double shear,double mx,double my,double rotation,bool mirrx) Description: Create a new Matrix3d representing a displacement, shear, anisotropic magnification, rotation and mirroring u:  The displacement  shear:  The shear angle  mx:  The magnification in x direction  mx:  The magnification in y direction  rotation:  The rotation angle (in degree)  mirrx:  The mirror flag (at x axis) 
The order of execution of the operations is mirror, magnification, rotation, shear and displacement.
This constructor is called 'newc' to distinguish it from the constructor taking the four matrix coefficients ('c' is for composite). Starting with version 0.25 the displacement is of vector type.  Signature: [static] new Matrix3d ptr newc (double tx,double ty,double z,const DVector u,double shear,double mx,double my,double rotation,bool mirrx) Description: Create a new Matrix3d representing a perspective distortion, displacement, shear, anisotropic magnification, rotation and mirroring tx:  The perspective tilt angle x (around the y axis)  ty:  The perspective tilt angle y (around the x axis)  z:  The observer distance at which the tilt angles are given  u:  The displacement  shear:  The shear angle  mx:  The magnification in x direction  mx:  The magnification in y direction  rotation:  The rotation angle (in degree)  mirrx:  The mirror flag (at x axis) 
The order of execution of the operations is mirror, magnification, rotation, shear, perspective distortion and displacement.
This constructor is called 'newc' to distinguish it from the constructor taking the four matrix coefficients ('c' is for composite). The tx and ty parameters represent the perspective distortion. They denote a tilt of the xy plane around the y axis (tx) or the x axis (ty) in degree. The same effect is achieved for different tilt angles for different observer distances. Hence, the observer distance must be given at which the tilt angles are given. If the magnitude of the tilt angle is not important, z can be set to 1. Starting with version 0.25 the displacement is of vector type.  shear_angle  Signature: [const] double shear_angle Description: Returns the magnitude of the shear component of this matrix. Returns:  The shear angle in degree. 
The shear basic transformation will tilt the x axis towards the y axis and vice versa. The shear angle gives the tilt angle of the axes towards the other one. The possible range for this angle is 45 to 45 degree.See the description of this class for details about the basic transformations.  to_s  Signature: [const] string to_s Description: Convert the matrix to a string. Returns:  The string representing this matrix 
Python specific notes: This method is also available as 'str(object)' and 'repr(object)'
 trans  Signature: [const] DPoint trans (const DPoint p) Description: Transforms a point with this matrix. p:  The point to transform.  Returns:  The product if self and the point p 
 tx  Signature: [const] double tx (double z) Description: Returns the perspective tilt angle tx. z:  The observer distance at which the tilt angle is computed.  Returns:  The tilt angle tx. 
The tx and ty parameters represent the perspective distortion. They denote a tilt of the xy plane around the y axis (tx) or the x axis (ty) in degree. The same effect is achieved for different tilt angles at different observer distances. Hence, the observer distance must be specified at which the tilt angle is computed. If the magnitude of the tilt angle is not important, z can be set to 1.
 ty  Signature: [const] double ty (double z) Description: Returns the perspective tilt angle ty. z:  The observer distance at which the tilt angle is computed.  Returns:  The tilt angle ty. 
The tx and ty parameters represent the perspective distortion. They denote a tilt of the xy plane around the y axis (tx) or the x axis (ty) in degree. The same effect is achieved for different tilt angles at different observer distances. Hence, the observer distance must be specified at which the tilt angle is computed. If the magnitude of the tilt angle is not important, z can be set to 1.

