com.sun.javafx.geom.transform

Class BaseTransform

java.lang.Object

com.sun.javafx.geom.transform.BaseTransform

All Implemented Interfaces:

CanTransformVec3d

Direct Known Subclasses:

AffineBase, Identity, Translate2D

public abstract class BaseTransform
extends Object
implements CanTransformVec3d

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseTransform.Degree

Field Summary

Fields

Modifier and Type	Field and Description
static BaseTransform	IDENTITY_TRANSFORM
static int	TYPE_AFFINE_3D
static int	TYPE_AFFINE2D_MASK
static int	TYPE_FLIP This flag bit indicates that the transform defined by this object performs a mirror image flip about some axis which changes the normally right handed coordinate system into a left handed system in addition to the conversions indicated by other flag bits.
static int	TYPE_GENERAL_ROTATION This flag bit indicates that the transform defined by this object performs a rotation by an arbitrary angle in addition to the conversions indicated by other flag bits.
static int	TYPE_GENERAL_SCALE This flag bit indicates that the transform defined by this object performs a general scale in addition to the conversions indicated by other flag bits.
static int	TYPE_GENERAL_TRANSFORM This constant indicates that the transform defined by this object performs an arbitrary conversion of the input coordinates.
static int	TYPE_IDENTITY This constant indicates that the transform defined by this object is an identity transform.
static int	TYPE_MASK_ROTATION This constant is a bit mask for any of the rotation flag bits.
static int	TYPE_MASK_SCALE This constant is a bit mask for any of the scale flag bits.
static int	TYPE_QUADRANT_ROTATION This flag bit indicates that the transform defined by this object performs a quadrant rotation by some multiple of 90 degrees in addition to the conversions indicated by other flag bits.
static int	TYPE_TRANSLATION This flag bit indicates that the transform defined by this object performs a translation in addition to the conversions indicated by other flag bits.
static int	TYPE_UNIFORM_SCALE This flag bit indicates that the transform defined by this object performs a uniform scale in addition to the conversions indicated by other flag bits.
protected static int	TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
BaseTransform()

Method Summary

Modifier and Type	Method and Description
static boolean	almostZero(double a)
abstract BaseTransform	copy()
abstract BaseTransform	createInverse() This function always returns a new object, unless the transform is an identity transform in which case it might return the Identity singleton.
abstract Shape	createTransformedShape(Shape s)
abstract void	deltaTransform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)
abstract void	deltaTransform(float[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts)
abstract Vec3d	deltaTransform(Vec3d src, Vec3d dst)
abstract BaseTransform	deriveWithConcatenation(BaseTransform tx)
abstract BaseTransform	deriveWithConcatenation(double mxx, double myx, double mxy, double myy, double mxt, double myt)
abstract BaseTransform	deriveWithConcatenation(double mxx, double mxy, double mxz, double mxt, double myx, double myy, double myz, double myt, double mzx, double mzy, double mzz, double mzt)
abstract BaseTransform	deriveWithNewTransform(BaseTransform tx)
abstract BaseTransform	deriveWithPreConcatenation(BaseTransform transform)
abstract BaseTransform	deriveWithPreTranslation(double mxt, double myt)
abstract BaseTransform	deriveWithRotation(double theta, double axisX, double axisY, double axisZ)
abstract BaseTransform	deriveWithScale(double mxx, double myy, double mzz)
abstract BaseTransform	deriveWithTranslation(double mxt, double myt)
abstract BaseTransform	deriveWithTranslation(double mxt, double myt, double mzt)
boolean	equals(Object obj) Returns true if this BaseTransform represents the same coordinate transform as the specified argument.
abstract BaseTransform.Degree	getDegree()
abstract double	getDeterminant()
static BaseTransform	getInstance(BaseTransform tx)
static BaseTransform	getInstance(double mxx, double myx, double mxy, double myy, double mxt, double myt)
static BaseTransform	getInstance(double mxx, double mxy, double mxz, double mxt, double myx, double myy, double myz, double myt, double mzx, double mzy, double mzz, double mzt)
double	getMxt()
double	getMxx()
double	getMxy()
double	getMxz()
double	getMyt()
double	getMyx()
double	getMyy()
double	getMyz()
double	getMzt()
double	getMzx()
double	getMzy()
double	getMzz()
static BaseTransform	getRotateInstance(double theta, double x, double y)
static BaseTransform	getScaleInstance(double mxx, double myy)
static BaseTransform	getTranslateInstance(double mxt, double myt)
abstract int	getType() Retrieves the flag bits describing the conversion properties of this transform.
int	hashCode() Returns the hashcode for this transform.
abstract void	inverseDeltaTransform(float[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts)
abstract Vec3d	inverseDeltaTransform(Vec3d src, Vec3d dst)
abstract BaseBounds	inverseTransform(BaseBounds bounds, BaseBounds result)
abstract void	inverseTransform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)
abstract void	inverseTransform(float[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts)
abstract Point2D	inverseTransform(Point2D src, Point2D dst)
abstract void	inverseTransform(Rectangle rect, Rectangle result)
abstract Vec3d	inverseTransform(Vec3d src, Vec3d dst)
abstract void	invert() This function inverts the BaseTransform in place.
abstract boolean	is2D()
abstract boolean	isIdentity()
abstract boolean	isTranslateOrIdentity()
abstract void	restoreTransform(double mxx, double myx, double mxy, double myy, double mxt, double myt) This function is only guaranteed to succeed if the transform is of degree AFFINE2D or less and the matrix parameters specified came from this same instance.
abstract void	restoreTransform(double mxx, double mxy, double mxz, double mxt, double myx, double myy, double myz, double myt, double mzx, double mzy, double mzz, double mzt) This function is only guaranteed to succeed if the matrix parameters specified came from this same instance.
abstract void	setToIdentity()
abstract void	setTransform(BaseTransform xform)
String	toString() Returns the matrix elements and degree of this transform as a string.
abstract BaseBounds	transform(BaseBounds bounds, BaseBounds result)
abstract void	transform(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)
abstract void	transform(double[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts)
abstract void	transform(float[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)
abstract void	transform(float[] srcPts, int srcOff, float[] dstPts, int dstOff, int numPts)
abstract Point2D	transform(Point2D src, Point2D dst)
abstract void	transform(Rectangle rect, Rectangle result)
abstract Vec3d	transform(Vec3d src, Vec3d dst)

Methods inherited from class java.lang.Object

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

Field Detail

IDENTITY_TRANSFORM

public static final BaseTransform IDENTITY_TRANSFORM

TYPE_UNKNOWN

protected static final int TYPE_UNKNOWN

See Also:

Constant Field Values

TYPE_IDENTITY

public static final int TYPE_IDENTITY

This constant indicates that the transform defined by this object is an identity transform. An identity transform is one in which the output coordinates are always the same as the input coordinates. If this transform is anything other than the identity transform, the type will either be the constant GENERAL_TRANSFORM or a combination of the appropriate flag bits for the various coordinate conversions that this transform performs.

See Also:

TYPE_TRANSLATION, TYPE_UNIFORM_SCALE, TYPE_GENERAL_SCALE, TYPE_FLIP, TYPE_QUADRANT_ROTATION, TYPE_GENERAL_ROTATION, TYPE_GENERAL_TRANSFORM, getType(), Constant Field Values

TYPE_TRANSLATION

public static final int TYPE_TRANSLATION

This flag bit indicates that the transform defined by this object performs a translation in addition to the conversions indicated by other flag bits. A translation moves the coordinates by a constant amount in x and y without changing the length or angle of vectors.

See Also:

TYPE_IDENTITY, TYPE_UNIFORM_SCALE, TYPE_GENERAL_SCALE, TYPE_FLIP, TYPE_QUADRANT_ROTATION, TYPE_GENERAL_ROTATION, TYPE_GENERAL_TRANSFORM, getType(), Constant Field Values

TYPE_UNIFORM_SCALE

public static final int TYPE_UNIFORM_SCALE

This flag bit indicates that the transform defined by this object performs a uniform scale in addition to the conversions indicated by other flag bits. A uniform scale multiplies the length of vectors by the same amount in both the x and y directions without changing the angle between vectors. This flag bit is mutually exclusive with the TYPE_GENERAL_SCALE flag.

See Also:

TYPE_IDENTITY, TYPE_TRANSLATION, TYPE_GENERAL_SCALE, TYPE_FLIP, TYPE_QUADRANT_ROTATION, TYPE_GENERAL_ROTATION, TYPE_GENERAL_TRANSFORM, getType(), Constant Field Values

TYPE_GENERAL_SCALE

public static final int TYPE_GENERAL_SCALE

This flag bit indicates that the transform defined by this object performs a general scale in addition to the conversions indicated by other flag bits. A general scale multiplies the length of vectors by different amounts in the x and y directions without changing the angle between perpendicular vectors. This flag bit is mutually exclusive with the TYPE_UNIFORM_SCALE flag.

See Also:

TYPE_IDENTITY, TYPE_TRANSLATION, TYPE_UNIFORM_SCALE, TYPE_FLIP, TYPE_QUADRANT_ROTATION, TYPE_GENERAL_ROTATION, TYPE_GENERAL_TRANSFORM, getType(), Constant Field Values

TYPE_MASK_SCALE

public static final int TYPE_MASK_SCALE

This constant is a bit mask for any of the scale flag bits.

See Also:

TYPE_UNIFORM_SCALE, TYPE_GENERAL_SCALE, Constant Field Values

TYPE_FLIP

public static final int TYPE_FLIP

This flag bit indicates that the transform defined by this object performs a mirror image flip about some axis which changes the normally right handed coordinate system into a left handed system in addition to the conversions indicated by other flag bits. A right handed coordinate system is one where the positive X axis rotates counterclockwise to overlay the positive Y axis similar to the direction that the fingers on your right hand curl when you stare end on at your thumb. A left handed coordinate system is one where the positive X axis rotates clockwise to overlay the positive Y axis similar to the direction that the fingers on your left hand curl. There is no mathematical way to determine the angle of the original flipping or mirroring transformation since all angles of flip are identical given an appropriate adjusting rotation.

See Also:

TYPE_IDENTITY, TYPE_TRANSLATION, TYPE_UNIFORM_SCALE, TYPE_GENERAL_SCALE, TYPE_QUADRANT_ROTATION, TYPE_GENERAL_ROTATION, TYPE_GENERAL_TRANSFORM, getType(), Constant Field Values

TYPE_QUADRANT_ROTATION

public static final int TYPE_QUADRANT_ROTATION

This flag bit indicates that the transform defined by this object performs a quadrant rotation by some multiple of 90 degrees in addition to the conversions indicated by other flag bits. A rotation changes the angles of vectors by the same amount regardless of the original direction of the vector and without changing the length of the vector. This flag bit is mutually exclusive with the TYPE_GENERAL_ROTATION flag.

See Also:

TYPE_IDENTITY, TYPE_TRANSLATION, TYPE_UNIFORM_SCALE, TYPE_GENERAL_SCALE, TYPE_FLIP, TYPE_GENERAL_ROTATION, TYPE_GENERAL_TRANSFORM, getType(), Constant Field Values

TYPE_GENERAL_ROTATION

public static final int TYPE_GENERAL_ROTATION

This flag bit indicates that the transform defined by this object performs a rotation by an arbitrary angle in addition to the conversions indicated by other flag bits. A rotation changes the angles of vectors by the same amount regardless of the original direction of the vector and without changing the length of the vector. This flag bit is mutually exclusive with the TYPE_QUADRANT_ROTATION flag.

See Also:

TYPE_IDENTITY, TYPE_TRANSLATION, TYPE_UNIFORM_SCALE, TYPE_GENERAL_SCALE, TYPE_FLIP, TYPE_QUADRANT_ROTATION, TYPE_GENERAL_TRANSFORM, getType(), Constant Field Values

TYPE_MASK_ROTATION

public static final int TYPE_MASK_ROTATION

This constant is a bit mask for any of the rotation flag bits.

See Also:

TYPE_QUADRANT_ROTATION, TYPE_GENERAL_ROTATION, Constant Field Values

TYPE_GENERAL_TRANSFORM

public static final int TYPE_GENERAL_TRANSFORM

This constant indicates that the transform defined by this object performs an arbitrary conversion of the input coordinates. If this transform can be classified by any of the above constants, the type will either be the constant TYPE_IDENTITY or a combination of the appropriate flag bits for the various coordinate conversions that this transform performs.

See Also:

TYPE_IDENTITY, TYPE_TRANSLATION, TYPE_UNIFORM_SCALE, TYPE_GENERAL_SCALE, TYPE_FLIP, TYPE_QUADRANT_ROTATION, TYPE_GENERAL_ROTATION, getType(), Constant Field Values

TYPE_AFFINE2D_MASK

public static final int TYPE_AFFINE2D_MASK

See Also:

Constant Field Values

TYPE_AFFINE_3D

public static final int TYPE_AFFINE_3D

See Also:

Constant Field Values

Constructor Detail

BaseTransform

public BaseTransform()

Method Detail

getInstance

public static BaseTransform getInstance(BaseTransform tx)

getInstance

public static BaseTransform getInstance(double mxx,
                                        double mxy,
                                        double mxz,
                                        double mxt,
                                        double myx,
                                        double myy,
                                        double myz,
                                        double myt,
                                        double mzx,
                                        double mzy,
                                        double mzz,
                                        double mzt)

getInstance

public static BaseTransform getInstance(double mxx,
                                        double myx,
                                        double mxy,
                                        double myy,
                                        double mxt,
                                        double myt)

getTranslateInstance

public static BaseTransform getTranslateInstance(double mxt,
                                                 double myt)

getScaleInstance

public static BaseTransform getScaleInstance(double mxx,
                                             double myy)

getRotateInstance

public static BaseTransform getRotateInstance(double theta,
                                              double x,
                                              double y)

getDegree

public abstract BaseTransform.Degree getDegree()

getType

public abstract int getType()

Retrieves the flag bits describing the conversion properties of this transform. The return value is either one of the constants TYPE_IDENTITY or TYPE_GENERAL_TRANSFORM, or a combination of the appriopriate flag bits. A valid combination of flag bits is an exclusive OR operation that can combine the TYPE_TRANSLATION flag bit in addition to either of the TYPE_UNIFORM_SCALE or TYPE_GENERAL_SCALE flag bits as well as either of the TYPE_QUADRANT_ROTATION or TYPE_GENERAL_ROTATION flag bits.

Returns:

the OR combination of any of the indicated flags that apply to this transform

See Also:

TYPE_IDENTITY, TYPE_TRANSLATION, TYPE_UNIFORM_SCALE, TYPE_GENERAL_SCALE, TYPE_QUADRANT_ROTATION, TYPE_GENERAL_ROTATION, TYPE_GENERAL_TRANSFORM

isIdentity

public abstract boolean isIdentity()

isTranslateOrIdentity

public abstract boolean isTranslateOrIdentity()

is2D

public abstract boolean is2D()

getDeterminant

public abstract double getDeterminant()

getMxx

public double getMxx()

getMxy

public double getMxy()

getMxz

public double getMxz()

getMxt

public double getMxt()

getMyx

public double getMyx()

getMyy

public double getMyy()

getMyz

public double getMyz()

getMyt

public double getMyt()

getMzx

public double getMzx()

getMzy

public double getMzy()

getMzz

public double getMzz()

getMzt

public double getMzt()

transform

public abstract Point2D transform(Point2D src,
                                  Point2D dst)

inverseTransform

public abstract Point2D inverseTransform(Point2D src,
                                         Point2D dst)
                                  throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

transform

public abstract Vec3d transform(Vec3d src,
                                Vec3d dst)

Specified by:

transform in interface CanTransformVec3d

deltaTransform

public abstract Vec3d deltaTransform(Vec3d src,
                                     Vec3d dst)

inverseTransform

public abstract Vec3d inverseTransform(Vec3d src,
                                       Vec3d dst)
                                throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

inverseDeltaTransform

public abstract Vec3d inverseDeltaTransform(Vec3d src,
                                            Vec3d dst)
                                     throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

transform

public abstract void transform(float[] srcPts,
                               int srcOff,
                               float[] dstPts,
                               int dstOff,
                               int numPts)

transform

public abstract void transform(double[] srcPts,
                               int srcOff,
                               double[] dstPts,
                               int dstOff,
                               int numPts)

transform

public abstract void transform(float[] srcPts,
                               int srcOff,
                               double[] dstPts,
                               int dstOff,
                               int numPts)

transform

public abstract void transform(double[] srcPts,
                               int srcOff,
                               float[] dstPts,
                               int dstOff,
                               int numPts)

deltaTransform

public abstract void deltaTransform(float[] srcPts,
                                    int srcOff,
                                    float[] dstPts,
                                    int dstOff,
                                    int numPts)

deltaTransform

public abstract void deltaTransform(double[] srcPts,
                                    int srcOff,
                                    double[] dstPts,
                                    int dstOff,
                                    int numPts)

inverseTransform

public abstract void inverseTransform(float[] srcPts,
                                      int srcOff,
                                      float[] dstPts,
                                      int dstOff,
                                      int numPts)
                               throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

inverseDeltaTransform

public abstract void inverseDeltaTransform(float[] srcPts,
                                           int srcOff,
                                           float[] dstPts,
                                           int dstOff,
                                           int numPts)
                                    throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

inverseTransform

public abstract void inverseTransform(double[] srcPts,
                                      int srcOff,
                                      double[] dstPts,
                                      int dstOff,
                                      int numPts)
                               throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

transform

public abstract BaseBounds transform(BaseBounds bounds,
                                     BaseBounds result)

transform

public abstract void transform(Rectangle rect,
                               Rectangle result)

inverseTransform

public abstract BaseBounds inverseTransform(BaseBounds bounds,
                                            BaseBounds result)
                                     throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

inverseTransform

public abstract void inverseTransform(Rectangle rect,
                                      Rectangle result)
                               throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

createTransformedShape

public abstract Shape createTransformedShape(Shape s)

setToIdentity

public abstract void setToIdentity()

setTransform

public abstract void setTransform(BaseTransform xform)

invert

public abstract void invert()
                     throws NoninvertibleTransformException

This function inverts the BaseTransform in place. All current implementations can support their own inverted form, and that should likely remain true in the future as well.

Throws:

NoninvertibleTransformException

restoreTransform

public abstract void restoreTransform(double mxx,
                                      double myx,
                                      double mxy,
                                      double myy,
                                      double mxt,
                                      double myt)

This function is only guaranteed to succeed if the transform is of degree AFFINE2D or less and the matrix parameters specified came from this same instance. In practice, they will also tend to succeed if they specify a transform of Degree less than or equal to the Degree of this instance as well, but the intent of this method is to restore the transform that had been read out of this transform into local variables.

restoreTransform

public abstract void restoreTransform(double mxx,
                                      double mxy,
                                      double mxz,
                                      double mxt,
                                      double myx,
                                      double myy,
                                      double myz,
                                      double myt,
                                      double mzx,
                                      double mzy,
                                      double mzz,
                                      double mzt)

This function is only guaranteed to succeed if the matrix parameters specified came from this same instance. In practice, they will also tend to succeed if they specify a transform of Degree less than or equal to the Degree of this instance as well, but the intent of this method is to restore the transform that had been read out of this transform into local variables.

deriveWithTranslation

public abstract BaseTransform deriveWithTranslation(double mxt,
                                                    double myt)

deriveWithTranslation

public abstract BaseTransform deriveWithTranslation(double mxt,
                                                    double myt,
                                                    double mzt)

deriveWithScale

public abstract BaseTransform deriveWithScale(double mxx,
                                              double myy,
                                              double mzz)

deriveWithRotation

public abstract BaseTransform deriveWithRotation(double theta,
                                                 double axisX,
                                                 double axisY,
                                                 double axisZ)

deriveWithPreTranslation

public abstract BaseTransform deriveWithPreTranslation(double mxt,
                                                       double myt)

deriveWithConcatenation

public abstract BaseTransform deriveWithConcatenation(double mxx,
                                                      double myx,
                                                      double mxy,
                                                      double myy,
                                                      double mxt,
                                                      double myt)

deriveWithConcatenation

public abstract BaseTransform deriveWithConcatenation(double mxx,
                                                      double mxy,
                                                      double mxz,
                                                      double mxt,
                                                      double myx,
                                                      double myy,
                                                      double myz,
                                                      double myt,
                                                      double mzx,
                                                      double mzy,
                                                      double mzz,
                                                      double mzt)

deriveWithPreConcatenation

public abstract BaseTransform deriveWithPreConcatenation(BaseTransform transform)

deriveWithConcatenation

public abstract BaseTransform deriveWithConcatenation(BaseTransform tx)

deriveWithNewTransform

public abstract BaseTransform deriveWithNewTransform(BaseTransform tx)

createInverse

public abstract BaseTransform createInverse()
                                     throws NoninvertibleTransformException

This function always returns a new object, unless the transform is an identity transform in which case it might return the Identity singleton.

Returns:

a new transform representing the inverse of this transform.

Throws:

NoninvertibleTransformException

copy

public abstract BaseTransform copy()

hashCode

public int hashCode()

Returns the hashcode for this transform.

Overrides:

hashCode in class Object

Returns:

a hash code for this transform.

equals

public boolean equals(Object obj)

Returns true if this BaseTransform represents the same coordinate transform as the specified argument.

Overrides:

equals in class Object

Parameters:

obj - the Object to test for equality with this BaseTransform

Returns:

true if obj equals this BaseTransform object; false otherwise.

almostZero

public static boolean almostZero(double a)

toString

public String toString()

Returns the matrix elements and degree of this transform as a string.

Overrides:

toString in class Object

Returns:

the matrix elements and degree of this transform