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 constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] Matrix3d *(const Matrix3d m)Description: Product of two matrices.
[const] DPoint *(const DPoint p)Description: Transform a point.
[const] Matrix3d +(const Matrix3d m)Description: Sum of two matrices.
[static] int AdjustAllDescription: Mode for adjust: currently equivalent to adjust_perspective [static] int AdjustDisplacementDescription: Mode for adjust: adjust displacement only [static] int AdjustMagnificationDescription: Mode for adjust: adjust rotation, mirror option and magnification [static] int AdjustNoneDescription: Mode for adjust: adjust nothing [static] int AdjustPerspectiveDescription: Mode for adjust: adjust whole matrix including perspective transformation [static] int AdjustRotationDescription: Mode for adjust: adjust rotation only [static] int AdjustRotationMirrorDescription: Mode for adjust: adjust rotation and mirror option [static] int AdjustShearDescription: Mode for adjust: adjust rotation, mirror option, magnification and shear void _createDescription: 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. void _destroyDescription: 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. [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. [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. void _manageDescription: 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. void _unmanageDescription: 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. 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
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). [const] double angleDescription: Returns the rotation angle of the rotation component of this matrix.
See the description of this class for details about the basic transformations. void assign(const Matrix3d other)Description: Assigns another object to self [const] DCplxTrans cplx_transDescription: Converts this matrix to a complex transformation (if possible).
This method is successful only if the matrix does not contain shear or perspective distortion components and the magnification must be isotropic. void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] DPoint dispDescription: Returns the displacement vector of this transformation.
[const] new Matrix3d ptr dupDescription: Creates a copy of self [const] Matrix3d invertedDescription: The inverse of this matrix.
[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 [const] bool is_mirror?Description: Returns the mirror flag of this matrix.
See the description of this class for details about the basic transformations. [const] double m(int i,int j)Description: Gets the m coefficient with the given index.
[const] double mag_xDescription: Returns the x magnification of the magnification component of this matrix.
[const] double mag_yDescription: Returns the y magnification of the magnification component of this matrix.
[static] new Matrix3d ptr newDescription: Create a new Matrix3d representing a unit transformation Python specific notes:This method is the default initializer of the object [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 [static] new Matrix3d ptr new(const DCplxTrans arg1)Description: Create a new Matrix3d from the given complex transformation@args t
Python specific notes:This method is the default initializer of the object [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 [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 [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 [static] new Matrix3d ptr newc(double mag,double rotation,bool mirrx)Description: Create a new Matrix3d representing a isotropic magnification, rotation and mirroring
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). [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
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). [static] new Matrix3d ptr newc(const DPoint 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
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). [static] new Matrix3d ptr newc(double tx,double ty,double z,const DPoint 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
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. [const] double shear_angleDescription: Returns the magnitude of the shear component of this matrix.
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. [const] string to_sDescription: Convert the matrix to a string.
Python specific notes:This method is also available as 'str(object)' [const] DPoint trans(const DPoint p)Description: Transforms a point with this matrix.
[const] double tx(double z)Description: Returns the perspective 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. [const] double ty(double z)Description: Returns the perspective 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. |