XAffineTransform (Referencing core 3.19-geoapi-3.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.geotoolkit.referencing.operation.matrix
Class XAffineTransform

Object
  AffineTransform
      XAffineTransform

All Implemented Interfaces:: Serializable, Cloneable

Direct Known Subclasses:: AffineTransform2D

public class XAffineTransform
extends AffineTransform
extends AffineTransform

Utility methods for affine transforms. This class provides two kind of services:

A set of public static methods working on any AffineTransform.
An abstract base class that override all mutable AffineTransform methods in order to check for permission before changing the transform state. If checkPermission() is defined to always throw an exception, then XAffineTransform is immutable.

Since:

1.2

Version:

3.14

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

Fields inherited from class AffineTransform
`TYPE_FLIP, TYPE_GENERAL_ROTATION, TYPE_GENERAL_SCALE, TYPE_GENERAL_TRANSFORM, TYPE_IDENTITY, TYPE_MASK_ROTATION, TYPE_MASK_SCALE, TYPE_QUADRANT_ROTATION, TYPE_TRANSLATION, TYPE_UNIFORM_SCALE`

Constructor Summary
`protected`	`XAffineTransform()` Constructs an identity affine transform.
	`XAffineTransform(AffineTransform tr)` Constructs a new `XAffineTransform` that is a copy of the specified `AffineTransform` object.
	`XAffineTransform(double m00, double m10, double m01, double m11, double m02, double m12)` Constructs a new `XAffineTransform` from 6 values representing the 6 specifiable entries of the 3×3 transformation matrix.

Method Summary
`protected void`	`checkPermission()` Checks if the caller is allowed to change this `XAffineTransform` state.
`void`	`concatenate(AffineTransform Tx)` Checks for permission before concatenating this transform.
`static int`	`getFlip(AffineTransform tr)` Returns `-1` if one axis has been flipped, `+1` if no axis has been flipped, or 0 if unknown.
`static double`	`getRotation(AffineTransform tr)` Returns an estimation of the rotation angle in radians.
`static double`	`getScale(AffineTransform tr)` Returns a global scale factor for the specified affine transform.
`static AffineTransform`	`getScaleInstance(double sx, double sy, double anchorx, double anchory)` Returns an affine transform representing a zoom carried out around a anchor point (`x`, `y`).
`static double`	`getScaleX0(AffineTransform tr)` Returns the magnitude of scale factor `x` by cancelling the effect of eventual flip and rotation.
`static double`	`getScaleY0(AffineTransform tr)` Returns the magnitude of scale factor `y` by cancelling the effect of eventual flip and rotation.
`static int`	`getSwapXY(AffineTransform tr)` Returns an estimation about whatever the specified transform swaps `x` and `y` axis.
`static Point2D`	`inverseDeltaTransform(AffineTransform transform, Point2D source, Point2D dest)` Calculates the inverse affine transform of a point without without applying the translation components.
`static Rectangle2D`	`inverseTransform(AffineTransform transform, Rectangle2D bounds, Rectangle2D dest)` Returns a rectangle which entirely contains the inverse transform of `bounds`.
`void`	`invert()` Checks for permission before inverting this transform.
`static boolean`	`isIdentity(AffineTransform tr, double tolerance)` Returns `true` if the specified affine transform is an identity transform up to the specified tolerance.
`boolean`	`isIdentity(double tolerance)` Checks whether or not this `XAffineTransform` is the identity by using the provided `tolerance`.
`void`	`preConcatenate(AffineTransform Tx)` Checks for permission before concatenating this transform.
`void`	`quadrantRotate(int numquadrants)` Checks for permission before rotating this transform.
`void`	`quadrantRotate(int numquadrants, double anchorx, double anchory)` Checks for permission before rotating this transform.
`void`	`rotate(double theta)` Checks for permission before rotating this transform.
`void`	`rotate(double vecx, double vecy)` Checks for permission before rotating this transform.
`void`	`rotate(double theta, double anchorx, double anchory)` Checks for permission before rotating this transform.
`void`	`rotate(double vecx, double vecy, double anchorx, double anchory)` Checks for permission before rotating this transform.
`static void`	`roundIfAlmostInteger(AffineTransform tr, double tolerance)` If scale and shear coefficients are close to integers, replaces their current values by their rounded values.
`void`	`scale(double sx, double sy)` Checks for permission before scaling this transform.
`void`	`setToIdentity()` Checks for permission before setting this transform.
`void`	`setToQuadrantRotation(int numquadrants)` Checks for permission before setting this transform.
`void`	`setToQuadrantRotation(int numquadrants, double anchorx, double anchory)` Checks for permission before setting this transform.
`void`	`setToRotation(double theta)` Checks for permission before setting this transform.
`void`	`setToRotation(double vecx, double vecy)` Checks for permission before setting this transform.
`void`	`setToRotation(double theta, double anchorx, double anchory)` Checks for permission before setting this transform.
`void`	`setToRotation(double vecx, double vecy, double anchorx, double anchory)` Checks for permission before setting this transform.
`void`	`setToScale(double sx, double sy)` Checks for permission before setting this transform.
`void`	`setToShear(double shx, double shy)` Checks for permission before setting this transform.
`void`	`setToTranslation(double tx, double ty)` Checks for permission before setting this transform.
`void`	`setTransform(AffineTransform Tx)` Checks for permission before setting this transform.
`void`	`setTransform(double m00, double m10, double m01, double m11, double m02, double m12)` Checks for permission before setting this transform.
`void`	`shear(double shx, double shy)` Checks for permission before shearing this transform.
`static Rectangle2D`	`transform(AffineTransform transform, Rectangle2D bounds, Rectangle2D dest)` Returns a rectangle which entirely contains the direct transform of `bounds`.
`static Shape`	`transform(AffineTransform transform, Shape shape, boolean overwrite)` Transforms the given shape.
`void`	`translate(double tx, double ty)` Checks for permission before translating this transform.

Methods inherited from class AffineTransform
clone, createInverse, createTransformedShape, deltaTransform, deltaTransform, equals, getDeterminant, getMatrix, getQuadrantRotateInstance, getQuadrantRotateInstance, getRotateInstance, getRotateInstance, getRotateInstance, getRotateInstance, getScaleInstance, getScaleX, getScaleY, getShearInstance, getShearX, getShearY, getTranslateInstance, getTranslateX, getTranslateY, getType, hashCode, inverseTransform, inverseTransform, isIdentity, toString, transform, transform, transform, transform, transform, transform

Methods inherited from class AffineTransform

clone, createInverse, createTransformedShape, deltaTransform, deltaTransform, equals, getDeterminant, getMatrix, getQuadrantRotateInstance, getQuadrantRotateInstance, getRotateInstance, getRotateInstance, getRotateInstance, getRotateInstance, getScaleInstance, getScaleX, getScaleY, getShearInstance, getShearX, getShearY, getTranslateInstance, getTranslateX, getTranslateY, getType, hashCode, inverseTransform, inverseTransform, isIdentity, toString, transform, transform, transform, transform, transform, transform

Methods inherited from class Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

XAffineTransform

protected XAffineTransform()

Constructs an identity affine transform. This is for subclasses usage only, for example subclasses that override the checkPermission() method.

Note: This constructor is protected rather than public in order to avoid accidental instantation of identity transforms that are not of some subclass, which is likely to be useless since XAffineTransform is immutable.

Since:: 3.00

XAffineTransform

public XAffineTransform(AffineTransform tr)

Constructs a new XAffineTransform that is a copy of the specified AffineTransform object.

Parameters:: tr - The affine transform to copy.

XAffineTransform

public XAffineTransform(double m00,
                        double m10,
                        double m01,
                        double m11,
                        double m02,
                        double m12)

Constructs a new XAffineTransform from 6 values representing the 6 specifiable entries of the 3×3 transformation matrix. Those values are given unchanged to the super class constructor.

Parameters:: m00 - the X coordinate scaling.; m10 - the Y coordinate shearing.; m01 - the X coordinate shearing.; m11 - the Y coordinate scaling.; m02 - the X coordinate translation.; m12 - the Y coordinate translation.
Since:: 2.5

Method Detail

checkPermission

protected void checkPermission()
                        throws UnsupportedOperationException

Checks if the caller is allowed to change this XAffineTransform state. If this method is defined to thrown an exception in all case, then this XAffineTransform is immutable.

The default implementation throws the exception in all case, thus making this instance immutable.

Throws:: UnsupportedOperationException - if this affine transform is immutable.

translate

public void translate(double tx,
                      double ty)

Checks for permission before translating this transform.

Overrides:: translate in class AffineTransform

rotate

public void rotate(double theta)

Checks for permission before rotating this transform.

Overrides:: rotate in class AffineTransform

rotate

public void rotate(double theta,
                   double anchorx,
                   double anchory)

Checks for permission before rotating this transform.

Overrides:: rotate in class AffineTransform

rotate

public void rotate(double vecx,
                   double vecy)

Checks for permission before rotating this transform.

Overrides:: rotate in class AffineTransform

rotate

public void rotate(double vecx,
                   double vecy,
                   double anchorx,
                   double anchory)

Checks for permission before rotating this transform.

Overrides:: rotate in class AffineTransform

quadrantRotate

public void quadrantRotate(int numquadrants)

Checks for permission before rotating this transform.

Overrides:: quadrantRotate in class AffineTransform

quadrantRotate

public void quadrantRotate(int numquadrants,
                           double anchorx,
                           double anchory)

Checks for permission before rotating this transform.

Overrides:: quadrantRotate in class AffineTransform

scale

public void scale(double sx,
                  double sy)

Checks for permission before scaling this transform.

Overrides:: scale in class AffineTransform

shear

public void shear(double shx,
                  double shy)

Checks for permission before shearing this transform.

Overrides:: shear in class AffineTransform