ilog.views.maps.srs.coordtrans

Class IlvMapAffineTransform

java.lang.Object

ilog.views.maps.srs.coordtrans.IlvMapAffineTransform

All Implemented Interfaces:

IlvPersistentObject, IlvMathTransform, Serializable

public class IlvMapAffineTransform
extends Object
implements IlvMathTransform, IlvPersistentObject

This class defines an affine transformation. An affine transformation can perform translation, rotation, scaling and shearing. The transformation is based on a 4x4 transformation matrix.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvMapAffineTransform() Constructs a new identity affine transformation.
IlvMapAffineTransform(double xAxisTranslation, double yAxisTranslation, double zAxisTranslation) Constructs a new affine transformation with the specified translations on the axis.
IlvMapAffineTransform(IlvInputStream stream) Reads an IlvMapAffineTransform from the specified input stream.
IlvMapAffineTransform(int sourceDimension, int targetDimension, double[] matrix) Constructs a new affine transformation.

Method Summary

Modifier and Type	Method and Description
void	concatenate(IlvMapAffineTransform t) Concatenates the specified transformation with this one.
boolean	equals(Object obj)
IlvMathTransform	getInverse() Returns the inverse transformation.
int	getSourceDimension() Returns the dimension of the source coordinates.
int	getTargetDimension() Returns the dimension of the target coordinates.
double	getValue(int column, int row) Returns the value in the affine transformation matrix at the specified column and row.
boolean	isIdentity() Returns true if this transformation is an identity.
IlvCoordinate[]	transform(IlvCoordinate[] sourceCP, IlvCoordinate[] result) Transforms the specified array of coordinate points, and puts the resulting coordinates in result.
IlvCoordinate	transform(IlvCoordinate sourceCP, IlvCoordinate targetCP) Transforms the specified point.
void	write(IlvOutputStream stream) Writes this transformation to the specified output file.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMapAffineTransform

public IlvMapAffineTransform()

Constructs a new identity affine transformation.

IlvMapAffineTransform

public IlvMapAffineTransform(double xAxisTranslation,
                             double yAxisTranslation,
                             double zAxisTranslation)

Constructs a new affine transformation with the specified translations on the axis.

Parameters:

xAxisTranslation - The translation on the X axis.

yAxisTranslation - The translation on the Y axis.

zAxisTranslation - The translation on the Z axis.

IlvMapAffineTransform

public IlvMapAffineTransform(int sourceDimension,
                             int targetDimension,
                             double[] matrix)

Constructs a new affine transformation.

IlvMapAffineTransform

public IlvMapAffineTransform(IlvInputStream stream)
                      throws IlvReadFileException

Reads an IlvMapAffineTransform from the specified input stream.

Parameters:

stream - The IlvInputStream.

Throws:

IlvReadFileException - If a transformation cannot be read from the input stream.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this transformation to the specified output file.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The IlvOutputStream.

Throws:

IOException - If an error occurs.

getInverse

public IlvMathTransform getInverse()

Returns the inverse transformation.

Specified by:

getInverse in interface IlvMathTransform

getValue

public double getValue(int column,
                       int row)

Returns the value in the affine transformation matrix at the specified column and row.

getSourceDimension

public int getSourceDimension()

Returns the dimension of the source coordinates. For an affine transformation, this is always 3.

Specified by:

getSourceDimension in interface IlvMathTransform

Returns:

Always 3.

getTargetDimension

public int getTargetDimension()

Returns the dimension of the target coordinates. For an affine transformation, this is always 3.

Specified by:

getTargetDimension in interface IlvMathTransform

Returns:

Always 3.

isIdentity

public boolean isIdentity()

Returns true if this transformation is an identity.

Specified by:

isIdentity in interface IlvMathTransform

Returns:

true if this transformation is an identity.

concatenate

public void concatenate(IlvMapAffineTransform t)

Concatenates the specified transformation with this one.

Parameters:

t - The IlvMapAffineTransform to append.

transform

public IlvCoordinate transform(IlvCoordinate sourceCP,
                               IlvCoordinate targetCP)
                        throws IlvCoordinateTransformationException

Transforms the specified point.

Specified by:

transform in interface IlvMathTransform

Parameters:

sourceCP - The point to transform.

targetCP - The result point. If targetCP is null, a new IlvCoordinate is allocated.

Returns:

The result coordinate.

Throws:

IlvCoordinateTransformationException

transform

public IlvCoordinate[] transform(IlvCoordinate[] sourceCP,
                                 IlvCoordinate[] result)
                          throws IlvCoordinateTransformationException

Transforms the specified array of coordinate points, and puts the resulting coordinates in result. If result is null, a new array of coordinate is allocated.

Specified by:

transform in interface IlvMathTransform

Parameters:

sourceCP - The array of points to transform.

result - The array of results. If targetCP is null, a new array of IlvCoordinate is allocated.

Returns:

The result coordinates.

Throws:

IlvCoordinateTransformationException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

JViews 8.5

See Also:

Object.equals(java.lang.Object)