API reference - Class Matrix2d
Notation used in Ruby API documentation
Description: A 2d matrix object used mainly for representing rotation and shear transformations.
- Public constructors
- Public methods
- Public static methods and constants
- Deprecated methods (protected, public, static, non-static and constructors)
- Detailed description
This object represents a 2x2 matrix. This matrix is used to represent affine transformations in the 2d space mainly. It can be decomposed into basic transformations: mirroring, rotation and shear. In that case, the assumed execution order of the basic transformations is mirroring at the x axis, rotation, magnification and shear.
This class was introduced in version 0.22.
Public constructors
| new Matrix2d ptr | new | Create a new Matrix2d representing a unit transformation | |
| new Matrix2d ptr | new | (double m) | Create a new Matrix2d representing an isotropic magnification |
| new Matrix2d ptr | new | (double mx, double my) | Create a new Matrix2d representing an anisotropic magnification |
| new Matrix2d ptr | new | (const DCplxTrans arg1) | Create a new Matrix2d from the given complex transformation@args t |
| new Matrix2d ptr | new | (double m11, double m12, double m21, double m22) | Create a new Matrix2d from the four coefficients |
Public methods
| [const] | Matrix2d | * | (const Matrix2d m) | Product of two matrices. |
| [const] | Matrix2d | + | (const Matrix2d 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. | ||
| [const] | double | angle | Returns the rotation angle of the rotation component of this matrix. | |
| void | assign | (const Matrix2d other) | Assigns another object to self | |
| [const] | DCplxTrans | cplx_trans | Converts this matrix to a complex transformation (if possible). | |
| [const] | new Matrix2d ptr | dup | Creates a copy of self | |
| [const] | Matrix2d | 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 | m11 | Gets the m11 coefficient. | |
| [const] | double | m12 | Gets the m12 coefficient. | |
| [const] | double | m21 | Gets the m21 coefficient. | |
| [const] | double | m22 | Gets the m22 coefficient. | |
| [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. |
Public static methods and constants
| new Matrix2d ptr | newc | (double mag, double rotation, bool mirror) | Create a new Matrix2d representing an isotropic magnification, rotation and mirroring | |
| new Matrix2d ptr | newc | (double shear, double mx, double my, double rotation, bool mirror) | Create a new Matrix2d representing a shear, anisotropic magnification, rotation and mirroring |
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 | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
Detailed description
* | Signature: [const] Matrix2d * (const Matrix2d m) Description: Product of two matrices.
| |||||||||
+ | Signature: [const] Matrix2d + (const Matrix2d m) Description: Sum of two matrices.
| |||||||||
_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] double angle Description: Returns the rotation angle of the rotation component of this matrix.
The matrix is decomposed into basic transformations assuming an execution order of mirroring at the x axis, rotation, magnification and shear. | |||||||||
assign | Signature: void assign (const Matrix2d other) Description: Assigns another object to self | |||||||||
cplx_trans | Signature: [const] DCplxTrans cplx_trans Description: Converts this matrix to a complex transformation (if possible).
This method is successful only if the matrix does not contain shear 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 | |||||||||
dup | Signature: [const] new Matrix2d ptr dup Description: Creates a copy of self | |||||||||
inverted | Signature: [const] Matrix2d inverted Description: 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.
The matrix is decomposed into basic transformations assuming an execution order of mirroring at the x axis, rotation, magnification and shear. | |||||||||
m | Signature: [const] double m (int i,int j) Description: Gets the m coefficient with the given index.
| |||||||||
m11 | Signature: [const] double m11 Description: Gets the m11 coefficient.
| |||||||||
m12 | Signature: [const] double m12 Description: Gets the m12 coefficient.
| |||||||||
m21 | Signature: [const] double m21 Description: Gets the m21 coefficient.
| |||||||||
m22 | Signature: [const] double m22 Description: Gets the m22 coefficient.
| |||||||||
mag_x | Signature: [const] double mag_x Description: Returns the x magnification of the magnification component of this matrix.
The matrix is decomposed into basic transformations assuming an execution order of mirroring at the x axis, magnification, shear and rotation. | |||||||||
mag_y | Signature: [const] double mag_y Description: Returns the y magnification of the magnification component of this matrix.
The matrix is decomposed into basic transformations assuming an execution order of mirroring at the x axis, magnification, shear and rotation. | |||||||||
new | Signature: [static] new Matrix2d ptr new Description: Create a new Matrix2d representing a unit transformation Python specific notes: | |||||||||
Signature: [static] new Matrix2d ptr new (double m) Description: Create a new Matrix2d representing an isotropic magnification
Python specific notes: | ||||||||||
Signature: [static] new Matrix2d ptr new (double mx,double my) Description: Create a new Matrix2d representing an anisotropic magnification
Python specific notes: | ||||||||||
Signature: [static] new Matrix2d ptr new (const DCplxTrans arg1) Description: Create a new Matrix2d from the given complex transformation@args t
Python specific notes: | ||||||||||
Signature: [static] new Matrix2d ptr new (double m11,double m12,double m21,double m22) Description: Create a new Matrix2d from the four coefficients Python specific notes: | ||||||||||
newc | Signature: [static] new Matrix2d ptr newc (double mag,double rotation,bool mirror) Description: Create a new Matrix2d representing an isotropic magnification, rotation and mirroring
This constructor is provided to construct a matrix similar to the complex transformation. This constructor is called 'newc' to distinguish it from the constructors taking matrix coefficients ('c' is for composite). The order of execution of the operations is mirror, magnification, rotation (as for complex transformations). | |||||||||
Signature: [static] new Matrix2d ptr newc (double shear,double mx,double my,double rotation,bool mirror) Description: Create a new Matrix2d representing a shear, anisotropic magnification, rotation and mirroring
The order of execution of the operations is mirror, magnification, shear and rotation. This constructor is called 'newc' to distinguish it from the constructor taking the four matrix coefficients ('c' is for composite). | ||||||||||
shear_angle | Signature: [const] double shear_angle Description: Returns the magnitude of the shear component of this matrix.
The matrix is decomposed into basic transformations assuming an execution order of mirroring at the x axis, rotation, magnification and shear. 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. | |||||||||
to_s | Signature: [const] string to_s Description: Convert the matrix to a string.
Python specific notes: | |||||||||
trans | Signature: [const] DPoint trans (const DPoint p) Description: Transforms a point with this matrix.
|