org.apache.pdfbox.util
Class Matrix

java.lang.Object
  extended by org.apache.pdfbox.util.Matrix
All Implemented Interfaces:
Cloneable

public class Matrix
extends Object
implements Cloneable

This class will be used for matrix manipulation.

Version:
$Revision: 1.14 $
Author:
Ben Litchfield

Constructor Summary
Matrix()
          Constructor.
 
Method Summary
 Object clone()
          Clones this object.
 Matrix copy()
          This will copy the text matrix data.
 AffineTransform createAffineTransform()
          Create an affine transform from this matrix's values.
 Matrix extractScaling()
          Create a new matrix with just the scaling operators.
 Matrix extractTranslating()
          Create a new matrix with just the translating operators.
static Matrix getScaleInstance(float x, float y)
          Convenience method to create a scaled instance.
static Matrix getTranslatingInstance(float x, float y)
          Convenience method to create a translating instance.
 float getValue(int row, int column)
          This will get a matrix value at some point.
 float[][] getValues()
          Return a single dimension array of all values in the matrix.
 double[][] getValuesAsDouble()
          Return a single dimension array of all values in the matrix.
 float getXPosition()
          Get the x position in the matrix.
 float getXScale()
          Get the xscaling factor of this matrix.
 float getYPosition()
          Get the y position.
 float getYScale()
          Get the y scaling factor of this matrix.
 Matrix multiply(Matrix b)
          This will take the current matrix and multipy it with a matrix that is passed in.
 void setFromAffineTransform(AffineTransform af)
          Set the values of the matrix from the AffineTransform.
 void setValue(int row, int column, float value)
          This will set a value at a position.
 String toString()
          This will return a string representation of the matrix.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Matrix

public Matrix()
Constructor.

Method Detail

createAffineTransform

public AffineTransform createAffineTransform()
Create an affine transform from this matrix's values.

Returns:
An affine transform with this matrix's values.

setFromAffineTransform

public void setFromAffineTransform(AffineTransform af)
Set the values of the matrix from the AffineTransform.

Parameters:
af - The transform to get the values from.

getValue

public float getValue(int row,
                      int column)
This will get a matrix value at some point.

Parameters:
row - The row to get the value from.
column - The column to get the value from.
Returns:
The value at the row/column position.

setValue

public void setValue(int row,
                     int column,
                     float value)
This will set a value at a position.

Parameters:
row - The row to set the value at.
column - the column to set the value at.
value - The value to set at the position.

getValues

public float[][] getValues()
Return a single dimension array of all values in the matrix.

Returns:
The values ot this matrix.

getValuesAsDouble

public double[][] getValuesAsDouble()
Return a single dimension array of all values in the matrix.

Returns:
The values ot this matrix.

multiply

public Matrix multiply(Matrix b)
This will take the current matrix and multipy it with a matrix that is passed in.

Parameters:
b - The matrix to multiply by.
Returns:
The result of the two multiplied matrices.

extractScaling

public Matrix extractScaling()
Create a new matrix with just the scaling operators.

Returns:
A new matrix with just the scaling operators.

getScaleInstance

public static Matrix getScaleInstance(float x,
                                      float y)
Convenience method to create a scaled instance.

Parameters:
x - The xscale operator.
y - The yscale operator.
Returns:
A new matrix with just the x/y scaling

extractTranslating

public Matrix extractTranslating()
Create a new matrix with just the translating operators.

Returns:
A new matrix with just the translating operators.

getTranslatingInstance

public static Matrix getTranslatingInstance(float x,
                                            float y)
Convenience method to create a translating instance.

Parameters:
x - The x translating operator.
y - The y translating operator.
Returns:
A new matrix with just the x/y translating.

clone

public Object clone()
Clones this object.

Overrides:
clone in class Object
Returns:
cloned matrix as an object.

copy

public Matrix copy()
This will copy the text matrix data.

Returns:
a matrix that matches this one.

toString

public String toString()
This will return a string representation of the matrix.

Overrides:
toString in class Object
Returns:
The matrix as a string.

getXScale

public float getXScale()
Get the xscaling factor of this matrix.

Returns:
The x-scale.

getYScale

public float getYScale()
Get the y scaling factor of this matrix.

Returns:
The y-scale factor.

getXPosition

public float getXPosition()
Get the x position in the matrix.

Returns:
The x-position.

getYPosition

public float getYPosition()
Get the y position.

Returns:
The y position.


Copyright © 2002-2010 The Apache Software Foundation. All Rights Reserved.