com.aspose.drawing.drawing2d

Class Matrix

java.lang.Object

com.aspose.drawing.drawing2d.Matrix

All Implemented Interfaces:

com.aspose.ms.System.IDisposable

public final class Matrix
extends Object
implements com.aspose.ms.System.IDisposable

Encapsulates a 3-by-3 affine matrix that represents a geometric transform. This class cannot be inherited.

Field Summary

Fields

Modifier and Type	Field and Description
static Matrix	IdentityTransform

Constructor Summary

Constructors

Constructor and Description
Matrix() Initializes a new instance of the Matrix class as the identity matrix.
Matrix(float m11, float m12, float m21, float m22, float dx, float dy) Initializes a new instance of the Matrix class with the specified elements.
Matrix(RectangleF rect, PointF[] plgpts) Initializes a new instance of the Matrix class to the geometric transform defined by the specified rectangle and array of points.
Matrix(Rectangle rect, Point[] plgpts) Initializes a new instance of the Matrix class to the geometric transform defined by the specified rectangle and array of points.

Method Summary

Modifier and Type	Method and Description
Matrix	deepClone() Creates an exact copy of this Matrix.
void	dispose() Releases all resources used by this Matrix.
float[]	getElements() Gets an array of floating-point values that represents the elements of this Matrix.
float	getOffsetX() Gets the x translation value (the dx value, or the element in the third row and first column) of this Matrix.
float	getOffsetY() Gets the y translation value (the dy value, or the element in the third row and second column) of this Matrix.
void	invert() Inverts this Matrix, if it is invertible.
boolean	isIdentity() Gets a value indicating whether this Matrix is the identity matrix.
boolean	isInvertible() Gets a value indicating whether this Matrix is invertible.
void	multiply(Matrix matrix) Multiplies this Matrix by the matrix specified in the matrix parameter, by prepending the specified Matrix.
void	multiply(Matrix matrix, int order) Multiplies this Matrix by the matrix specified in the matrix parameter, and in the order specified in the order parameter.
void	reset() Resets this Matrix to have the elements of the identity matrix.
void	rotate(float angle) Prepend to this Matrix a clockwise rotation, around the origin and by the specified angle.
void	rotate(float angle, int order) Applies a clockwise rotation of an amount specified in the angle parameter, around the origin (zero x and y coordinates) for this Matrix.
void	rotateAt(float angle, PointF point) Applies a clockwise rotation to this Matrix around the point specified in the point parameter, and by prepending the rotation.
void	rotateAt(float angle, PointF point, int order) Applies a clockwise rotation about the specified point to this Matrix in the specified order.
void	scale(float scaleX, float scaleY) Applies the specified scale vector to this Matrix by prepending the scale vector.
void	scale(float scaleX, float scaleY, int order) Applies the specified scale vector (scaleX and scaleY) to this Matrix using the specified order.
void	shear(float shearX, float shearY) Applies the specified shear vector to this Matrix by prepending the shear transformation.
void	shear(float shearX, float shearY, int order) Applies the specified shear vector to this Matrix in the specified order.
void	transformPoints(Point[] pts) Applies the geometric transform represented by this Matrix to a specified array of points.
void	transformPoints(PointF[] pts) Applies the geometric transform represented by this Matrix to a specified array of points.
void	transformVectors(PointF[] pts) Multiplies each vector in an array by the matrix.
void	translate(float offsetX, float offsetY) Applies the specified translation vector (offsetX and offsetY) to this Matrix by prepending the translation vector.
void	translate(float offsetX, float offsetY, int order) Applies the specified translation vector to this Matrix in the specified order.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IdentityTransform

public static final Matrix IdentityTransform

Constructor Detail

Matrix

public Matrix()

Initializes a new instance of the Matrix class as the identity matrix.

Matrix

public Matrix(float m11,
              float m12,
              float m21,
              float m22,
              float dx,
              float dy)

Initializes a new instance of the Matrix class with the specified elements.

Parameters:

m11 - The value in the first row and first column of the new Matrix.

m12 - The value in the first row and second column of the new Matrix.

m21 - The value in the second row and first column of the new Matrix.

m22 - The value in the second row and second column of the new Matrix.

dx - The value in the third row and first column of the new Matrix.

dy - The value in the third row and second column of the new Matrix.

Matrix

public Matrix(Rectangle rect,
              Point[] plgpts)

Initializes a new instance of the Matrix class to the geometric transform defined by the specified rectangle and array of points.

Parameters:

rect - A Rectangle structure that represents the rectangle to be transformed.

plgpts - An array of three Point structures that represents the points of a parallelogram to which the upper-left, upper-right, and lower-left corners of the rectangle is to be transformed. The lower-right corner of the parallelogram is implied by the first three corners.

Matrix

public Matrix(RectangleF rect,
              PointF[] plgpts)

Initializes a new instance of the Matrix class to the geometric transform defined by the specified rectangle and array of points.

Parameters:

rect - A RectangleF structure that represents the rectangle to be transformed.

plgpts - An array of three PointF structures that represents the points of a parallelogram to which the upper-left, upper-right, and lower-left corners of the rectangle is to be transformed. The lower-right corner of the parallelogram is implied by the first three corners.

Method Detail

getElements

public float[] getElements()

Gets an array of floating-point values that represents the elements of this Matrix.

Returns:

an array of floating-point values that represents the elements of this Matrix.

isIdentity

public boolean isIdentity()

Gets a value indicating whether this Matrix is the identity matrix.

Returns:

a value indicating whether this Matrix is the identity matrix.

isInvertible

public boolean isInvertible()

Gets a value indicating whether this Matrix is invertible.

Returns:

a value indicating whether this Matrix is invertible.

getOffsetX

public float getOffsetX()

Gets the x translation value (the dx value, or the element in the third row and first column) of this Matrix.

Returns:

the x translation value (the dx value, or the element in the third row and first column) of this Matrix.

getOffsetY

public float getOffsetY()

Gets the y translation value (the dy value, or the element in the third row and second column) of this Matrix.

Returns:

the y translation value (the dy value, or the element in the third row and second column) of this Matrix.

dispose

public void dispose()

Releases all resources used by this Matrix.

This method actually does nothing. It's just for compatibility with System.Drawing API.

Specified by:

dispose in interface com.aspose.ms.System.IDisposable

deepClone

public Matrix deepClone()

Creates an exact copy of this Matrix.

Returns:

The Matrix that this method creates.

invert

public void invert()

Inverts this Matrix, if it is invertible.

translate

public void translate(float offsetX,
                      float offsetY)

Applies the specified translation vector (offsetX and offsetY) to this Matrix by prepending the translation vector.

Parameters:

offsetX - The x value by which to translate this Matrix.

offsetY - The y value by which to translate this Matrix.

translate

public void translate(float offsetX,
                      float offsetY,
                      int order)

Applies the specified translation vector to this Matrix in the specified order.

Parameters:

offsetX - The x value by which to translate this Matrix.

offsetY - The y value by which to translate this Matrix.

order - A MatrixOrder that specifies the order (append or prepend) in which the translation is applied to this Matrix.

transformVectors

public void transformVectors(PointF[] pts)

Multiplies each vector in an array by the matrix. The translation elements of this matrix (third row) are ignored.

Parameters:

pts - An array of PointF structures that represents the points to transform.

scale

public void scale(float scaleX,
                  float scaleY)

Applies the specified scale vector to this Matrix by prepending the scale vector.

Parameters:

scaleX - The value by which to scale this Matrix in the x-axis direction.

scaleY - The value by which to scale this Matrix in the y-axis direction.

scale

public void scale(float scaleX,
                  float scaleY,
                  int order)

Applies the specified scale vector (scaleX and scaleY) to this Matrix using the specified order.

Parameters:

scaleX - The value by which to scale this Matrix in the x-axis direction.

scaleY - The value by which to scale this Matrix in the y-axis direction.

order - A MatrixOrder that specifies the order (append or prepend) in which the scale vector is applied to this Matrix.

shear

public void shear(float shearX,
                  float shearY)

Applies the specified shear vector to this Matrix by prepending the shear transformation.

Parameters:

shearX - The horizontal shear factor.

shearY - The vertical shear factor.

shear

public void shear(float shearX,
                  float shearY,
                  int order)

Applies the specified shear vector to this Matrix in the specified order.

Parameters:

shearX - The horizontal shear factor.

shearY - The vertical shear factor.

order - A MatrixOrder that specifies the order (append or prepend) in which the shear is applied.

rotateAt

public void rotateAt(float angle,
                     PointF point)

Applies a clockwise rotation to this Matrix around the point specified in the point parameter, and by prepending the rotation.

Parameters:

angle - The angle (extent) of the rotation, in degrees.

point - A PointF that represents the center of the rotation.

rotateAt

public void rotateAt(float angle,
                     PointF point,
                     int order)

Applies a clockwise rotation about the specified point to this Matrix in the specified order.

Parameters:

angle - The angle of the rotation, in degrees.

point - A PointF that represents the center of the rotation.

order - A MatrixOrder that specifies the order (append or prepend) in which the rotation is applied.

transformPoints

public void transformPoints(PointF[] pts)

Applies the geometric transform represented by this Matrix to a specified array of points.

Parameters:

pts - An array of PointF structures that represents the points to transform.

transformPoints

public void transformPoints(Point[] pts)

Applies the geometric transform represented by this Matrix to a specified array of points.

Parameters:

pts - An array of Point structures that represents the points to transform.

multiply

public void multiply(Matrix matrix)

Multiplies this Matrix by the matrix specified in the matrix parameter, by prepending the specified Matrix.

Parameters:

matrix - The Matrix by which this Matrix is to be multiplied.

multiply

public void multiply(Matrix matrix,
                     int order)

Multiplies this Matrix by the matrix specified in the matrix parameter, and in the order specified in the order parameter.

Parameters:

matrix - The Matrix by which this Matrix is to be multiplied.

order - The MatrixOrder that represents the order of the multiplication.

rotate

public void rotate(float angle)

Prepend to this Matrix a clockwise rotation, around the origin and by the specified angle.

Parameters:

angle - The angle of the rotation, in degrees.

rotate

public void rotate(float angle,
                   int order)

Applies a clockwise rotation of an amount specified in the angle parameter, around the origin (zero x and y coordinates) for this Matrix.

Parameters:

angle - The angle of the rotation, in degrees.

order - A MatrixOrder that specifies the order (append or prepend) in which the rotation is applied to this Matrix.

reset

public void reset()

Resets this Matrix to have the elements of the identity matrix.