Cairo.Matrix

Entities

Subprograms

Description

Generic matrix operations.

<c_version>1.8.8</c_version> <group>Cairo</group>

Init

procedure Init
  (Matrix : access Cairo_Matrix;
   Xx     : Gdouble;
   Yx     : Gdouble;
   Xy     : Gdouble;
   Yy     : Gdouble;
   X0     : Gdouble;
   Y0     : Gdouble)

Sets matrix to be the affine transformation given by Xx, Yx, Xy, Yy, X0, Y0. The transformation is given by:

X_new = Xx * X + Xy * Y + X0;
Y_new = Yx * X + Yy * Y + Y0;
Parameters
Matrix

a Cairo_Matrix

Xx

Xx component of the affine transformation

Yx

Yx component of the affine transformation

Xy

Xy component of the affine transformation

Yy

Yy component of the affine transformation

X0

X translation component of the affine transformation

Y0

Y translation component of the affine transformation

Init_Identity

procedure Init_Identity (Matrix : access Cairo_Matrix)

Modifies matrix to be an identity transformation.

Parameters
Matrix

a Cairo_Matrix

Init_Rotate

procedure Init_Rotate (Matrix : access Cairo_Matrix; Radians : Gdouble)

Initialized matrix to a transformation that rotates by radians.

Parameters
Matrix

a Cairo_Matrix

Radians

angle of rotation, in Radians. The direction of rotation is defined such that positive angles rotate in the direction from the positive X axis toward the positive Y axis. With the default axis orientation of cairo, positive angles rotate in a clockwise direction.

Init_Scale

procedure Init_Scale
  (Matrix : access Cairo_Matrix;
   Sx     : Gdouble;
   Sy     : Gdouble)

Initializes matrix to a transformation that scales by Sx and Sy in the X and Y dimensions, respectively.

Parameters
Matrix

a Cairo_Matrix

Sx

scale factor in the X direction

Sy

scale factor in the Y direction

Init_Translate

procedure Init_Translate
  (Matrix : access Cairo_Matrix;
   Tx     : Gdouble;
   Ty     : Gdouble)

Initializes matrix to a transformation that translates by Tx and Ty in the X and Y dimensions, respectively.

Parameters
Matrix

a Cairo_Matrix

Tx

amount to translate in the X direction

Ty

amount to translate in the Y direction

Invert

function Invert (Matrix : access Cairo_Matrix) return Cairo_Status

Changes matrix to be the inverse of its original value. Not all transformation matrices have inverses; if the matrix collapses points together (it is "degenerate"), then it has no inverse and this function will fail.

Parameters
Matrix

a Cairo_Matrix

Return Value

If matrix has an inverse, modifies matrix to be the inverse matrix and returns Cairo_Status_Success. Otherwise, returns Cairo_Status_Invalid_Matrix.

Multiply

procedure Multiply
  (Result : access Cairo_Matrix;
   A      : access Cairo_Matrix;
   B      : access Cairo_Matrix)

Multiplies the affine transformations in a and b together and stores the result in result. The effect of the resulting transformation is to first apply the transformation in a to the coordinates and then apply the transformation in b to the coordinates.

It is allowable for result to be identical to either a or b.

Parameters
Result

a Cairo_Matrix in which to store the Result

A

a Cairo_Matrix

B

a Cairo_Matrix

Rotate

procedure Rotate (Matrix : access Cairo_Matrix; Radians : Gdouble)

Applies rotation by radians to the transformation in matrix. The effect of the new transformation is to first rotate the coordinates by radians, then apply the original transformation to the coordinates.

Parameters
Matrix

a Cairo_Matrix

Radians

angle of rotation, in Radians. The direction of rotation is defined such that positive angles rotate in the direction from the positive X axis toward the positive Y axis. With the default axis orientation of cairo, positive angles rotate in a clockwise direction.

Scale

procedure Scale
  (Matrix : access Cairo_Matrix;
   Sx     : Gdouble;
   Sy     : Gdouble)

Applies scaling by Sx, Sy to the transformation in matrix. The effect of the new transformation is to first scale the coordinates by Sx and Sy, then apply the original transformation to the coordinates.

Parameters
Matrix

a Cairo_Matrix

Sx

scale factor in the X direction

Sy

scale factor in the Y direction

Transform_Distance

procedure Transform_Distance
  (Matrix : access Cairo_Matrix;
   Dx     : access Gdouble;
   Dy     : access Gdouble)

Transforms the distance vector (Dx,Dy) by matrix. This is similar to Cairo.Matrix.Transform_Point except that the translation components of the transformation are ignored. The calculation of the returned vector is as follows:

Dx2 = Dx1 * A + Dy1 * C;
Dy2 = Dx1 * B + Dy1 * D;

Affine transformations are position invariant, so the same vector always transforms to the same vector. If (X1,Y1) transforms to (X2,Y2) then (X1+Dx1,Y1+Dy1) will transform to (X1+Dx2,Y1+Dy2) for all values of X1 and X2.

Parameters
Matrix

a Cairo_Matrix

Dx

X component of a distance vector. An in/out parameter

Dy

Y component of a distance vector. An in/out parameter

Transform_Point

procedure Transform_Point
  (Matrix : access Cairo_Matrix;
   X      : access Gdouble;
   Y      : access Gdouble)

Transforms the point (X, Y) by matrix.

Parameters
Matrix

a Cairo_Matrix

X

X position. An in/out parameter

Y

Y position. An in/out parameter

Translate

procedure Translate
  (Matrix : access Cairo_Matrix;
   Tx     : Gdouble;
   Ty     : Gdouble)

Applies a translation by Tx, Ty to the transformation in matrix. The effect of the new transformation is to first translate the coordinates by Tx and Ty, then apply the original transformation to the coordinates.

Parameters
Matrix

a Cairo_Matrix

Tx

amount to translate in the X direction

Ty

amount to translate in the Y direction