Module org.w3c.dom.svg

Package org.w3c.dom.svg

Interface SVGMatrix

All Known Implementing Classes:

AbstractSVGMatrix, SVGOMMatrix

public interface SVGMatrix

Many of SVG's graphics operations utilize 2x3 matrices of the form:

 [a c e]
 [b d f]
 

which, when expanded into a 3x3 matrix for the purposes of matrix arithmetic, become:

 [a c e]
 [b d f]
 [0 0 1]
 

Method Summary

Modifier and Type	Method	Description
SVGMatrix	flipX()	Post-multiplies the transformation [-1 0 0 1 0 0] and returns the resulting matrix.
SVGMatrix	flipY()	Post-multiplies the transformation [1 0 0 -1 0 0] and returns the resulting matrix.
float	getA()
float	getB()
float	getC()
float	getD()
float	getE()
float	getF()
SVGMatrix	inverse()
SVGMatrix	multiply(SVGMatrix secondMatrix)	Performs matrix multiplication.
SVGMatrix	rotate(float angle)	Post-multiplies a rotation transformation on the current matrix and returns the resulting matrix.
SVGMatrix	rotateFromVector(float x, float y)	Post-multiplies a rotation transformation on the current matrix and returns the resulting matrix.
SVGMatrix	scale(float scaleFactor)	Post-multiplies a uniform scale transformation on the current matrix and returns the resulting matrix.
SVGMatrix	scaleNonUniform(float scaleFactorX, float scaleFactorY)	Post-multiplies a non-uniform scale transformation on the current matrix and returns the resulting matrix.
void	setA(float a)	Set the a component of the matrix.
void	setB(float b)	Set the b component of the matrix.
void	setC(float c)	Set the c component of the matrix.
void	setD(float d)	Set the d component of the matrix.
void	setE(float e)	Set the e component of the matrix.
void	setF(float f)	Set the f component of the matrix.
SVGMatrix	skewX(float angle)	Post-multiplies a skewX transformation on the current matrix and returns the resulting matrix.
SVGMatrix	skewY(float angle)	Post-multiplies a skewY transformation on the current matrix and returns the resulting matrix.
SVGMatrix	translate(float x, float y)	Post-multiplies a translation transformation on the current matrix and returns the resulting matrix.

Method Details

getA

float getA()

Returns:

the a component of the matrix.

setA

void setA(float a)
   throws DOMException

Set the a component of the matrix.

Parameters:

a - the a component of the matrix.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR on an attempt to change the value of a read only attribute.

getB

float getB()

Returns:

the b component of the matrix.

setB

void setB(float b)
   throws DOMException

Set the b component of the matrix.

Parameters:

b - the b component of the matrix.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR on an attempt to change the value of a read only attribute.

getC

float getC()

Returns:

the c component of the matrix.

setC

void setC(float c)
   throws DOMException

Set the c component of the matrix.

Parameters:

c - the c component of the matrix.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR on an attempt to change the value of a read only attribute.

getD

float getD()

Returns:

the d component of the matrix.

setD

void setD(float d)
   throws DOMException

Set the d component of the matrix.

Parameters:

d - the d component of the matrix.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR on an attempt to change the value of a read only attribute.

getE

float getE()

Returns:

the e component of the matrix.

setE

void setE(float e)
   throws DOMException

Set the e component of the matrix.

Parameters:

e - the e component of the matrix.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR on an attempt to change the value of a read only attribute.

getF

float getF()

Returns:

the f component of the matrix.

setF

void setF(float f)
   throws DOMException

Set the f component of the matrix.

Parameters:

f - the f component of the matrix.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR on an attempt to change the value of a read only attribute.

multiply

SVGMatrix multiply(SVGMatrix secondMatrix)

Performs matrix multiplication. This matrix is post-multiplied by another matrix, returning the resulting new matrix.

Parameters:

secondMatrix - the matrix which is post-multiplied to this matrix.

Returns:

the resulting matrix.

inverse

SVGMatrix inverse()
           throws SVGException

Returns:

the inverse matrix.

Throws:

SVGException - SVG_MATRIX_NOT_INVERTABLE if this matrix is not invertible.

translate

SVGMatrix translate(float x,
 float y)

Post-multiplies a translation transformation on the current matrix and returns the resulting matrix.

Parameters:

x - the distance to translate along the x-axis.

y - the distance to translate along the y-axis.

Returns:

the resulting matrix.

scale

SVGMatrix scale(float scaleFactor)

Post-multiplies a uniform scale transformation on the current matrix and returns the resulting matrix.

Parameters:

scaleFactor - the scale factor in both X and Y.

Returns:

the resulting matrix.

scaleNonUniform

SVGMatrix scaleNonUniform(float scaleFactorX,
 float scaleFactorY)

Post-multiplies a non-uniform scale transformation on the current matrix and returns the resulting matrix.

Parameters:

scaleFactorX - the scale factor in X.

scaleFactorY - the scale factor in Y.

Returns:

the resulting matrix.

rotate

SVGMatrix rotate(float angle)

Post-multiplies a rotation transformation on the current matrix and returns the resulting matrix.

Parameters:

angle - the rotation angle.

Returns:

the resulting matrix.

rotateFromVector

SVGMatrix rotateFromVector(float x,
 float y)
                    throws SVGException

Post-multiplies a rotation transformation on the current matrix and returns the resulting matrix. The rotation angle is determined by taking (+/-) atan(y/x). The direction of the vector (x, y) determines whether the positive or negative angle value is used.

Parameters:

x - the X coordinate of the vector (x, y). Must not be zero.

y - the Y coordinate of the vector (x, y). Must not be zero.

Returns:

the resulting matrix.

Throws:

SVGException - SVG_INVALID_VALUE_ERR if one of the parameters is an invalid value.

flipX

SVGMatrix flipX()

Post-multiplies the transformation [-1 0 0 1 0 0] and returns the resulting matrix.

Returns:

the resulting matrix.

flipY

SVGMatrix flipY()

Post-multiplies the transformation [1 0 0 -1 0 0] and returns the resulting matrix.

Returns:

the resulting matrix.

skewX

SVGMatrix skewX(float angle)

Post-multiplies a skewX transformation on the current matrix and returns the resulting matrix.

Parameters:

angle - the skew angle.

Returns:

the resulting matrix.

skewY

SVGMatrix skewY(float angle)

Post-multiplies a skewY transformation on the current matrix and returns the resulting matrix.

Parameters:

angle - the skew angle.

Returns:

the resulting matrix.