API reference - Class Matrix2d

Notation used in Ruby API documentation

Module: db

Description: A 2d matrix object used mainly for representing rotation and shear transformations.

This object represents a 2x2 matrix. This matrix is used to implement 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.

The matrix is a generalization of the transformations and is of limited use in a layout database context. It is useful however to implement shear transformations on polygons, edges and polygon or edge collections.

This class was introduced in version 0.22.

Public constructors

new Matrix2d ptrnewCreate a new Matrix2d representing a unit transformation
new Matrix2d ptrnew(double m)Create a new Matrix2d representing an isotropic magnification
new Matrix2d ptrnew(double mx,
double my)
Create a new Matrix2d representing an anisotropic magnification
new Matrix2d ptrnew(const DCplxTrans t)Create a new Matrix2d from the given complex transformation@param t The transformation from which to create the matrix (not taking into account the displacement)
new Matrix2d ptrnew(double m11,
double m12,
double m21,
double m22)
Create a new Matrix2d from the four coefficients

Public methods

[const]DPoint*(const DPoint p)Transforms a point with this matrix.
[const]DVector*(const DVector v)Transforms a vector with this matrix.
[const]DEdge*(const DEdge e)Transforms an edge with this matrix.
[const]DBox*(const DBox box)Transforms a box with this matrix.
[const]DSimplePolygon*(const DSimplePolygon p)Transforms a simple polygon with this matrix.
[const]DPolygon*(const DPolygon p)Transforms a polygon with this matrix.
[const]Matrix2d*(const Matrix2d m)Product of two matrices.
[const]Matrix2d+(const Matrix2d m)Sum of two matrices.
void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]doubleangleReturns the rotation angle of the rotation component of this matrix.
voidassign(const Matrix2d other)Assigns another object to self
[const]DCplxTranscplx_transConverts this matrix to a complex transformation (if possible).
[const]new Matrix2d ptrdupCreates a copy of self
[const]Matrix2dinvertedThe inverse of this matrix.
[const]boolis_mirror?Returns the mirror flag of this matrix.
[const]doublem(int i,
int j)
Gets the m coefficient with the given index.
[const]doublem11Gets the m11 coefficient.
[const]doublem12Gets the m12 coefficient.
[const]doublem21Gets the m21 coefficient.
[const]doublem22Gets the m22 coefficient.
[const]doublemag_xReturns the x magnification of the magnification component of this matrix.
[const]doublemag_yReturns the y magnification of the magnification component of this matrix.
[const]doubleshear_angleReturns the magnitude of the shear component of this matrix.
[const]stringto_sConvert the matrix to a string.
[const]DPointtrans(const DPoint p)Transforms a point with this matrix.

Public static methods and constants

new Matrix2d ptrnewc(double mag,
double rotation,
bool mirror)
Create a new Matrix2d representing an isotropic magnification, rotation and mirroring
new Matrix2d ptrnewc(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)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

*

(1) Signature: [const] DPoint * (const DPoint p)

Description: Transforms a point with this matrix.

p:The point to transform.
Returns:The transformed point

Python specific notes:
This method is also available as '__rmul__'

(2) Signature: [const] DVector * (const DVector v)

Description: Transforms a vector with this matrix.

v:The vector to transform.
Returns:The transformed vector

Python specific notes:
This method is also available as '__rmul__'

(3) Signature: [const] DEdge * (const DEdge e)

Description: Transforms an edge with this matrix.

e:The edge to transform.
Returns:The transformed edge

Python specific notes:
This method is also available as '__rmul__'

(4) Signature: [const] DBox * (const DBox box)

Description: Transforms a box with this matrix.

box:The box to transform.
Returns:The transformed box

Please note that the box remains a box, even though the matrix supports shear and rotation. The returned box will be the bounding box of the sheared and rotated rectangle.

Python specific notes:
This method is also available as '__rmul__'

(5) Signature: [const] DSimplePolygon * (const DSimplePolygon p)

Description: Transforms a simple polygon with this matrix.

p:The simple polygon to transform.
Returns:The transformed simple polygon

Python specific notes:
This method is also available as '__rmul__'

(6) Signature: [const] DPolygon * (const DPolygon p)

Description: Transforms a polygon with this matrix.

p:The polygon to transform.
Returns:The transformed polygon

Python specific notes:
This method is also available as '__rmul__'

(7) Signature: [const] Matrix2d * (const Matrix2d m)

Description: Product of two matrices.

m:The other matrix.
Returns:The matrix product self*m

Python specific notes:
This method is also available as '__rmul__'

+

Signature: [const] Matrix2d + (const Matrix2d m)

Description: Sum of two matrices.

m:The other matrix.
Returns:The (element-wise) sum of self+m

_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.

Returns:The angle in degree.

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).

Returns:The complex transformation.

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

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.

dup

Signature: [const] new Matrix2d ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__'

inverted

Signature: [const] Matrix2d 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

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: Returns the mirror flag of this matrix.

Returns:True if this matrix has a mirror component.

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.

Returns:The coefficient [i,j]

m11

Signature: [const] double m11

Description: Gets the m11 coefficient.

Returns:The value of the m11 coefficient

m12

Signature: [const] double m12

Description: Gets the m12 coefficient.

Returns:The value of the m12 coefficient

m21

Signature: [const] double m21

Description: Gets the m21 coefficient.

Returns:The value of the m21 coefficient

m22

Signature: [const] double m22

Description: Gets the m22 coefficient.

Returns:The value of the m22 coefficient

mag_x

Signature: [const] double mag_x

Description: Returns the x magnification of the magnification component of this matrix.

Returns:The magnification factor.

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.

Returns:The magnification factor.

The matrix is decomposed into basic transformations assuming an execution order of mirroring at the x axis, magnification, shear and rotation.

new

(1) Signature: [static] new Matrix2d ptr new

Description: Create a new Matrix2d representing a unit transformation

Python specific notes:
This method is the default initializer of the object

(2) Signature: [static] new Matrix2d ptr new (double m)

Description: Create a new Matrix2d representing an isotropic magnification

m:The magnification

Python specific notes:
This method is the default initializer of the object

(3) Signature: [static] new Matrix2d ptr new (double mx, double my)

Description: Create a new Matrix2d representing an anisotropic magnification

mx:The magnification in x direction
my:The magnification in y direction

Python specific notes:
This method is the default initializer of the object

(4) Signature: [static] new Matrix2d ptr new (const DCplxTrans t)

Description: Create a new Matrix2d from the given complex transformation@param t The transformation from which to create the matrix (not taking into account the displacement)

Python specific notes:
This method is the default initializer of the object

(5) 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:
This method is the default initializer of the object

newc

(1) Signature: [static] new Matrix2d ptr newc (double mag, double rotation, bool mirror)

Description: Create a new Matrix2d representing an isotropic magnification, rotation and mirroring

mag:The magnification in x direction
rotation:The rotation angle (in degree)
mirror:The mirror flag (at x axis)

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).

(2) 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

shear:The shear angle
mx:The magnification in x direction
my:The magnification in y direction
rotation:The rotation angle (in degree)
mirror:The mirror flag (at x axis)

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.

Returns:The shear angle in degree.

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.

Returns:The string representing this matrix

Python specific notes:
This method is also available as 'str(object)'

trans

Signature: [const] DPoint trans (const DPoint p)

Description: Transforms a point with this matrix.

p:The point to transform.
Returns:The transformed point

Python specific notes:
This method is also available as '__rmul__'