AffineTransformation2D (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geometry
Class AffineTransformation2D

java.lang.Object
  com.esri.arcgis.geometry.AffineTransformation2D

All Implemented Interfaces:: IAffineTransformation2D, IAffineTransformation2D2, IAffineTransformation2D3, IAffineTransformation2D3GEN, IClone, ISupportErrorInfo, ITransformation, ITransformationGEN, IZShift, java.io.Serializable

public class AffineTransformation2D
extends java.lang.Object
implements ITransformationGEN, IAffineTransformation2D3GEN, ITransformation, IAffineTransformation2D, IAffineTransformation2D2, IAffineTransformation2D3, IClone, ISupportErrorInfo, IZShift

A two dimensional affine transformation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Description

The AffineTransformation2D coclass offers the ability to construct custom
transformations for geometrical shapes. It is useful for creating
particular transformations that are not supported by ITransform2D and
also for performing numerous transformations in one go.

Transformations can be done in two different ways. Firstly, and most
commonly within the geometry model, the AffineTransformation2D
object can be used in the ITransform2D::Transform method to transform
an existing Geometry. Alternatively, the methods of ITransform can
be used to transform points or values individually.

AffineTransformation2D implements two types of transformation.
Conformal Transformation (IAffineTransformation2D3::DefineConformalFromControlPoints)
and Affine Tranformation (IAffineTransformation2D::DefineFromControlPoints).

CONFORMAL TRANSFORMATION

At least two points are required to define this transformation.
The CONFORMAL equations use 4 parameters.

MATHEMATICAL MODEL :
The transformation can be described by a set of ceofficients (a, b, c, d, e, f)
of two linear equations:

X =  ax + by + c
 Y = -bx + ay + f

or in matrix form:

-b

The transformation elements can be interpreted as a sequence of simple operations:

  Scaling * Rotation * Translation  =

			Sx	0	0	cos r	sin r	0	1	0	0
x	y	1	0	Sy	0	-sin r	cos r	0	0	1	0
			0	0	1	0	0	1	Dx	Dy	1

Where :

  S - scaling factors (can be negative)
 r  - rotation angle in radians, measured counter-clockwise from x-
 axis (-pi < r <= pi)
 Dx, Dy - translation distances in x and y direction

These elements have the following locations within the transformation
matrix by which a ROW vector {x, y, 1} is to be POST-multiplied.

Given the matrix above the equation parameters can be interpreted as :

a = S cos r
 b = S sin r
 c = Dx
 d = Dy

AFFINE TRANSFORMATION

At least three points are required to define this transformation.
The AFFINE equations use six parameters.

MATHEMATICAL MODEL :
The transformation can be described by a set of ceofficients (a, b, c, d, e, f)
of two linear equations:

X = a * x + b * y + c
 Y = d * x + e * y + f

or in matrix form:

The transformation elements can be interpreted as a sequence of simple operations:

Scaling * Shearing * Rotation * Translation =

			Sx	0	1	1	0	0	cos r	sin r	0	1	0	0
x	y	1	0	Sy	0	tan s	1	0	-sin r	cos r	0	0	1	0
			0	0	1	0	0	1	0	0	1	Dx	Dy	1

Where :

Sx, Sy - scaling factors (can be negative)
 s - skew angle of shearing along x-axis, measured from y-axis (-pi/2 < s < pi/2)
 r - rotation angle in radians, measured counter-clockwise from x-axis (-pi < r <= pi)
 Dx, Dy - translation distances in x and y direction (can be negative)

These elements have the following locations within the transformation matrix by which a ROW vector {x, y, 1} is to be POST-multiplied.

Sx * cos r	Sx * sin r	0
(Sy / cos s) * sin (s - r)	(Sy / cos s) * cos (s - r)	0
Dx	Dy	1

Given the matrix above the equation parameters can be interpreted as : a = Sx cos r b = (Sy / cos s) sin(s - r) c = Dx d = Sx sin r e = (Sy / cos s) cos(s - r) f = Dy

Remarks

The skew angle is not public yet and cannot be directly get by using a method. But this angle can be calculated by first retrieveing some of the other parameters (b, d, r).

s = atan (b/d) + r

At 8.1, AffineTransformation2D does not implement the following methods:
IClone::Assign
IClone::IsEqual
IClone::IsIdentical
ITransformation::TransformMeasuresFF
ITransformation::TransformMeasuresFI
ITransformation::TransformMeasuresIF
ITransformation::TransformMeasuresII
ITransformation::TransformPointsIF
ITransformation::TransformPointsII

All of these methods return an HRESULT of E_NOTIMPL in C++. In VB, this is Error 445, "Object doesn't support this action".

See Also:: Serialized Form

Constructor Summary
`AffineTransformation2D()` Constructs a AffineTransformation2D using ArcGIS Engine.
`AffineTransformation2D(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary
`void`	`assign(IClone src)` Assigns the properties of src to the receiver.
`void`	`defineConformalFromControlPoints(int numPoints, IPoint fromPoints, IPoint toPoints)` Defines the best conformal affine transformation between two sets of points.
`void`	`defineConformalFromControlPoints(IPoint[] fromPoints, IPoint[] toPoints)` Defines the best conformal affine transformation between two sets of points.
`void`	`defineFromControlPoints(int numPoints, IPoint fromPoints, IPoint toPoints)` Defines the best affine transformation between two sets of points.
`void`	`defineFromControlPoints(IPoint[] fromPoints, IPoint[] toPoints)` Defines the best affine transformation between two sets of points.
`void`	`defineFromEnvelopes(IEnvelope from, IEnvelope to)` Defines a transformation that maps a point relative to one envelope to a similar position relative to another envelope.
`void`	`defineFromEnvelopesEx(IEnvelope from, IEnvelope to, IEnvelope outFrom, boolean assumeFalseOrigin, boolean keepAspect, boolean flipIt)` Defines a transformation that maps a point relative to one envelope to a similar position relative to another envelope.
`void`	`defineReflection(ILine l)` Defines a transformation that can perform a reflection about the line l.
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`IClone`	`esri_clone()` Clones the receiver and assigns the result to *clone.
`IAffineTransformation2D`	`getAsIAffineTransformation2D()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IAffineTransformation2D2`	`getAsIAffineTransformation2D2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IAffineTransformation2D3`	`getAsIAffineTransformation2D3()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IAffineTransformation2D3GEN`	`getAsIAffineTransformation2D3GEN()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IClone`	`getAsIClone()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISupportErrorInfo`	`getAsISupportErrorInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITransformation`	`getAsITransformation()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITransformationGEN`	`getAsITransformationGEN()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IZShift`	`getAsIZShift()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`static java.lang.String`	`getClsid()`
`void`	`getControlPointError(int i, double[] fromError, double[] toError)` Returns the errors involved in moving control point i from the 'from' to 'to' system.
`IPoint`	`getMoveOrigin()` The origin of accumulated transformations used when projecting an affine transformation to a different spatial reference system.
`void`	`getRMSError(double[] fromError, double[] toError)` RMS (Root Mean Square) error expressed relative to the 'from' and 'to' points defining the transformation.
`double`	`getRotation()` The rotation angle.
`ISpatialReference`	`getSpatialReference()` The spatial reference in which this transformation is meaningful.
`double`	`getXScale()` The scale along the X axis.
`double`	`getXTranslation()` The translation along the X axis.
`double`	`getYScale()` The scale along the Y axis.
`double`	`getYTranslation()` The translation along the Y axis.
`void`	`getZShift(double[] zOrigin, double[] zOffset)` The shift in the Z direction.
`int`	`hashCode()` the hashcode for this object
`void`	`interfaceSupportsErrorInfo(GUID riid)` Supported Platforms
`boolean`	`isEqual(IClone other)` Returns TRUE when the receiver and other have the same properties.
`boolean`	`isIdentical(IClone other)` Returns TRUE when the receiver and other are the same object.
`boolean`	`isReflective()` Indicates if the transformation contains a reflection (determinant is negative).
`void`	`move(double dx, double dy)` Incorporates a translation factor into the transformation.
`void`	`moveVector(ILine movementVector)` Performs an X and Y translation defined by a 2D vector.
`void`	`postMultiply(IAffineTransformation2D postTransform)` Post-multiplies the transformation by another transformation.
`void`	`postMultiply(IAffineTransformation2D3GEN postTransform)` Post-multiplies the transformation by another transformation.
`void`	`preMultiply(IAffineTransformation2D preTransform)` Pre-multiplies the transformation by another transformation.
`void`	`preMultiply(IAffineTransformation2D3GEN preTransform)` Pre-multiplies the transformation by another transformation.
`void`	`project(ISpatialReference newSpatialReference)` Moves this transformation into another spatial reference.
`void`	`putZShift(double zOrigin, double zOffset)` The shift in the Z direction.
`void`	`queryLinearCoefficients(int direction, double[] params)` Returns the linear coefficients which define the two dimensional affine transformation.
`void`	`queryLinearCoefficients(int direction, double[][] params)` Returns the linear coefficients which define the two dimensional affine transformation.
`void`	`reset()` Resets the tranformation.
`void`	`rotate(double da)` Incorporates a rotation (in radians) into the transformation.
`void`	`scale(double dx, double dy)` Incorporates scale factors into the transformation.
`void`	`setLinearCoefficients(int direction, double[] params)` Sets the linear coefficients which define the two dimensional affine transformation.
`void`	`setMoveOrigin(IPoint origin)` The origin of accumulated transformations used when projecting an affine transformation to a different spatial reference system.
`void`	`setSpatialReferenceByRef(ISpatialReference sR)` The spatial reference in which this transformation is meaningful.
`void`	`transformMeasuresFF(int direction, double[][] inMeasures, double[][] outMeasures)` Transforms floating point measures to floating point measures (or do the inverse).
`void`	`transformMeasuresFF(int direction, double[] inMeasures, double[][] outMeasures)` Transforms floating point measures to floating point measures (or do the inverse).
`void`	`transformMeasuresFF(int direction, int cMeasures, double[] inMeasures, double[] outMeasures)` Transforms floating point measures to floating point measures (or do the inverse).
`void`	`transformMeasuresFI(int direction, double[][] inMeasures, int[][] outMeasures)` Transforms floating point measures to integer measures (or do the inverse).
`void`	`transformMeasuresFI(int direction, double[] inMeasures, int[][] outMeasures)` Transforms floating point measures to integer measures (or do the inverse).
`void`	`transformMeasuresFI(int direction, int cMeasures, double[] inMeasures, int[] outMeasures)` Transforms floating point measures to integer measures (or do the inverse).
`void`	`transformMeasuresIF(int direction, int[][] inMeasures, double[][] outMeasures)` Transforms integer measures to floating point measures (or do the inverse).
`void`	`transformMeasuresIF(int direction, int[] inMeasures, double[][] outMeasures)` Transforms integer measures to floating point measures (or do the inverse).
`void`	`transformMeasuresIF(int direction, int cMeasures, int[] inMeasures, double[] outMeasures)` Transforms integer measures to floating point measures (or do the inverse).
`void`	`transformMeasuresII(int direction, int[][] inMeasures, int[][] outMeasures)` Transforms integer measures to integer measures (or do the inverse).
`void`	`transformMeasuresII(int direction, int[] inMeasures, int[][] outMeasures)` Transforms integer measures to integer measures (or do the inverse).
`void`	`transformMeasuresII(int direction, int cMeasures, int[] inMeasures, int[] outMeasures)` Transforms integer measures to integer measures (or do the inverse).
`void`	`transformPointsFF(int direction, double[][] inPoints, double[][] outPoints)` Transforms floating point points to floating point points (or do the inverse).
`void`	`transformPointsFF(int direction, double[] inPoints, double[][] outPoints)` Transforms floating point points to floating point points (or do the inverse).
`void`	`transformPointsFF(int direction, int cPoints, double[] inPoints, double[] outPoints)` Transforms floating point points to floating point points (or do the inverse).
`void`	`transformPointsFI(int direction, double[][] inPoints, int[][] outPoints)` Transforms floating point points to integer points (or do the inverse).
`void`	`transformPointsFI(int direction, double[] inPoints, int[][] outPoints)` Transforms floating point points to integer points (or do the inverse).
`void`	`transformPointsFI(int direction, int cPoints, double[] inPoints, int[] outPoints)` Transforms floating point points to integer points (or do the inverse).
`void`	`transformPointsIF(int direction, int[][] inPoints, double[][] outPoints)` Transforms integer points to floating point points (or do the inverse).
`void`	`transformPointsIF(int direction, int[] inPoints, double[][] outPoints)` Transforms integer points to floating point points (or do the inverse).
`void`	`transformPointsIF(int direction, int cPoints, int[] inPoints, double[] outPoints)` Transforms integer points to floating point points (or do the inverse).
`void`	`transformPointsII(int direction, int[][] inPoints, int[][] outPoints)` Transforms integer points to integer points (or do the inverse).
`void`	`transformPointsII(int direction, int[] inPoints, int[][] outPoints)` Transforms integer points to integer points (or do the inverse).
`void`	`transformPointsII(int direction, int cPoints, int[] inPoints, int[] outPoints)` Transforms integer points to integer points (or do the inverse).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AffineTransformation2D

public AffineTransformation2D()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a AffineTransformation2D using ArcGIS Engine.
Throws:: java.io.IOException - if there are interop problems; java.net.UnknownHostException - if there are interop problems

AffineTransformation2D

public AffineTransformation2D(java.lang.Object obj)
                       throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.; Construct a AffineTransformation2D using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AffineTransformation2D.
AffineTransformation2D theAffineTransformation2D = (AffineTransformation2D) obj;
Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsITransformationGEN

public ITransformationGEN getAsITransformationGEN()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAffineTransformation2D3GEN

public IAffineTransformation2D3GEN getAsIAffineTransformation2D3GEN()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITransformation

public ITransformation getAsITransformation()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAffineTransformation2D

public IAffineTransformation2D getAsIAffineTransformation2D()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAffineTransformation2D2

public IAffineTransformation2D2 getAsIAffineTransformation2D2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAffineTransformation2D3

public IAffineTransformation2D3 getAsIAffineTransformation2D3()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIZShift

public IZShift getAsIZShift()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

transformMeasuresFF

public void transformMeasuresFF(int direction,
                                double[] inMeasures,
                                double[][] outMeasures)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ITransformationGEN

Transforms floating point measures to floating point measures (or do the inverse).

Specified by:: transformMeasuresFF in interface ITransformationGEN

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); inMeasures - The inMeasures (in); outMeasures - The outMeasures (in/out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

transformMeasuresFI

public void transformMeasuresFI(int direction,
                                double[] inMeasures,
                                int[][] outMeasures)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ITransformationGEN

Transforms floating point measures to integer measures (or do the inverse).

Specified by:: transformMeasuresFI in interface ITransformationGEN

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); inMeasures - The inMeasures (in); outMeasures - The outMeasures (in/out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

transformMeasuresIF

public void transformMeasuresIF(int direction,
                                int[] inMeasures,
                                double[][] outMeasures)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ITransformationGEN

Transforms integer measures to floating point measures (or do the inverse).

Specified by:: transformMeasuresIF in interface ITransformationGEN

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); inMeasures - The inMeasures (in); outMeasures - The outMeasures (in/out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

transformMeasuresII

public void transformMeasuresII(int direction,
                                int[] inMeasures,
                                int[][] outMeasures)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ITransformationGEN

Transforms integer measures to integer measures (or do the inverse).

Specified by:: transformMeasuresII in interface ITransformationGEN

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); inMeasures - The inMeasures (in); outMeasures - The outMeasures (in/out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

transformPointsFF

public void transformPointsFF(int direction,
                              double[] inPoints,
                              double[][] outPoints)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: ITransformationGEN

Transforms floating point points to floating point points (or do the inverse).

Specified by:: transformPointsFF in interface ITransformationGEN

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); inPoints - The inPoints (in); outPoints - The outPoints (in/out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

transformPointsFI

public void transformPointsFI(int direction,
                              double[] inPoints,
                              int[][] outPoints)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: ITransformationGEN

Transforms floating point points to integer points (or do the inverse).

Specified by:: transformPointsFI in interface ITransformationGEN

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); inPoints - The inPoints (in); outPoints - The outPoints (in/out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

transformPointsIF

public void transformPointsIF(int direction,
                              int[] inPoints,
                              double[][] outPoints)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: ITransformationGEN

Transforms integer points to floating point points (or do the inverse).

Specified by:: transformPointsIF in interface ITransformationGEN

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); inPoints - The inPoints (in); outPoints - The outPoints (in/out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

transformPointsII

public void transformPointsII(int direction,
                              int[] inPoints,
                              int[][] outPoints)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: ITransformationGEN

Transforms integer points to integer points (or do the inverse).

Specified by:: transformPointsII in interface ITransformationGEN

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); inPoints - The inPoints (in); outPoints - The outPoints (in/out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.