Translate

java.lang.Object
- javafx.scene.transform.Transform
- - javafx.scene.transform.Translate

All Implemented Interfaces:

java.lang.Cloneable
```
public class Translate
extends Transform
```
This class represents an Affine object that translates coordinates by the specified factors. The matrix representing the translating transformation by distances x, y and z is as follows:
```
              [   1   0   0   x   ]
              [   0   1   0   y   ]
              [   0   0   1   z   ]
 
```
Since:

JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`DoubleProperty`	`x` Defines the distance by which coordinates are translated in the X axis direction
`DoubleProperty`	`y` Defines the distance by which coordinates are translated in the Y axis direction
`DoubleProperty`	`z` Defines the distance by which coordinates are translated in the Z axis direction

Properties inherited from class javafx.scene.transform.Transform
identityProperty, onTransformChangedProperty, type2DProperty

Nested Class Summary
- Nested classes/interfaces inherited from class javafx.scene.transform.Transform
  Transform.ImmutableTransform

Field Summary

Fields
Modifier and Type	Field and Description
`private DoubleProperty`	`x` Defines the distance by which coordinates are translated in the X axis direction
`private DoubleProperty`	`y` Defines the distance by which coordinates are translated in the Y axis direction
`private DoubleProperty`	`z` Defines the distance by which coordinates are translated in the Z axis direction

Constructor Summary

Constructors
Constructor and Description
`Translate()` Creates a default Translate (identity).
`Translate(double x, double y)` Creates a two-dimensional Translate.
`Translate(double x, double y, double z)` Creates a three-dimensional Translate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`appendTo(Affine a)` Visitor from `Affine` class which provides an efficient `append` operation for the subclasses.
`(package private) void`	`apply(Affine3D trans)`
`Translate`	`clone()` Returns a deep copy of this transform.
`(package private) boolean`	`computeIs2D()` Computes if this transform is currently a 2D transform (has no effect in the direction of Z axis).
`(package private) boolean`	`computeIsIdentity()` Computes if this transform is currently an identity (has no effect in any direction).
`Transform`	`createConcatenation(Transform transform)` Returns the concatenation of this transform and the specified transform.
`Translate`	`createInverse()` Returns the inverse transform of this transform.
`Point2D`	`deltaTransform(double x, double y)` Transforms the relative magnitude vector by this transform.
`Point3D`	`deltaTransform(double x, double y, double z)` Transforms the relative magnitude vector by this transform.
`Point2D`	`deltaTransform(Point2D point)` Transforms the relative magnitude vector represented by the specified `Point3D` instance by this transform.
`Point3D`	`deltaTransform(Point3D point)` Transforms the relative magnitude vector represented by the specified `Point3D` instance by this transform.
`(package private) BaseTransform`	`derive(BaseTransform trans)`
`(package private) void`	`fill2DArray(double[] array)` Core of the toArray implementation for the 2D case.
`(package private) void`	`fill3DArray(double[] array)` Core of the toArray implementation for the 3D case.
`double`	`getTx()` Gets the X coordinate translation element of the 3x4 matrix.
`double`	`getTy()` Gets the Y coordinate translation element of the 3x4 matrix.
`double`	`getTz()` Gets the Z coordinate translation element of the 3x4 matrix.
`double`	`getX()` Gets the value of the property x.
`double`	`getY()` Gets the value of the property y.
`double`	`getZ()` Gets the value of the property z.
`Point2D`	`inverseDeltaTransform(double x, double y)` Transforms the relative magnitude vector by the inverse of this transform.
`Point3D`	`inverseDeltaTransform(double x, double y, double z)` Transforms the relative magnitude vector by the inverse of this transform.
`Point2D`	`inverseDeltaTransform(Point2D point)` Transforms the relative magnitude vector represented by the specified `Point3D` instance by the inverse of this transform.
`Point3D`	`inverseDeltaTransform(Point3D point)` Transforms the relative magnitude vector represented by the specified `Point3D` instance by the inverse of this transform.
`Point2D`	`inverseTransform(double x, double y)` Transforms the specified point by the inverse of this transform.
`Point3D`	`inverseTransform(double x, double y, double z)` Transforms the specified point by the inverse of this transform.
`(package private) void`	`inverseTransform2DPointsImpl(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)` Core of the inverseTransform2DPoints method.
`(package private) void`	`inverseTransform3DPointsImpl(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)` Core of the inverseTransform3DPoints method.
`(package private) void`	`prependTo(Affine a)` Visitor from `Affine` class which provides an efficient `prepend` operation for the subclasses.
`void`	`setX(double value)` Sets the value of the property x.
`void`	`setY(double value)` Sets the value of the property y.
`void`	`setZ(double value)` Sets the value of the property z.
`java.lang.String`	`toString()` Returns a string representation of this `Translate` object.
`Point2D`	`transform(double x, double y)` Transforms the specified point by this transform.
`Point3D`	`transform(double x, double y, double z)` Transforms the specified point by this transform.
`(package private) void`	`transform2DPointsImpl(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)` Core of the transform2DPoints method.
`(package private) void`	`transform3DPointsImpl(double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts)` Core of the transform3DPoints method.
`(package private) void`	`validate()` Needed for the proper delivery of the TransformChangedEvent.
`DoubleProperty`	`xProperty()` Defines the distance by which coordinates are translated in the X axis direction
`DoubleProperty`	`yProperty()` Defines the distance by which coordinates are translated in the Y axis direction
`DoubleProperty`	`zProperty()` Defines the distance by which coordinates are translated in the Z axis direction

Methods inherited from class javafx.scene.transform.Transform
add, addEventFilter, addEventHandler, affine, affine, buildEventDispatchChain, checkRequestedMAT, clearInverseCache, column, column, createImmutableTransform, createImmutableTransform, createImmutableTransform, createImmutableTransform, determinant, ensureCanTransform2DPoint, getElement, getMxx, getMxy, getMxz, getMyx, getMyy, getMyz, getMzx, getMzy, getMzz, getOnTransformChanged, identityProperty, inverseTransform, inverseTransform, inverseTransform, inverseTransform2DPoints, inverseTransform3DPoints, isIdentity, isType2D, onTransformChangedProperty, remove, removeEventFilter, removeEventHandler, rotate, row, row, scale, scale, setOnTransformChanged, shear, shear, similarTo, toArray, toArray, transform, transform, transform, transform2DPoints, transform3DPoints, transformChanged, translate, type2DProperty

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - x
```
public final DoubleProperty xProperty
```
    Defines the distance by which coordinates are translated in the X axis direction
    
    See Also:
    
    getX(), setX(double)
  - y
```
public final DoubleProperty yProperty
```
    Defines the distance by which coordinates are translated in the Y axis direction
    
    See Also:
    
    getY(), setY(double)
  - z
```
public final DoubleProperty zProperty
```
    Defines the distance by which coordinates are translated in the Z axis direction
    
    See Also:
    
    getZ(), setZ(double)
- Field Detail
  - x
```
private DoubleProperty x
```
    Defines the distance by which coordinates are translated in the X axis direction
  - y
```
private DoubleProperty y
```
    Defines the distance by which coordinates are translated in the Y axis direction
  - z
```
private DoubleProperty z
```
    Defines the distance by which coordinates are translated in the Z axis direction
- Constructor Detail
  - Translate
```
public Translate()
```
    Creates a default Translate (identity).
  - Translate
```
public Translate(double x,
                 double y)
```
    Creates a two-dimensional Translate.
    
    Parameters:
    
    x - the distance by which coordinates are translated in the X axis direction
    
    y - the distance by which coordinates are translated in the Y axis direction
  - Translate
```
public Translate(double x,
                 double y,
                 double z)
```
    Creates a three-dimensional Translate.
    
    Parameters:
    
    x - the distance by which coordinates are translated in the X axis direction
    
    y - the distance by which coordinates are translated in the Y axis direction
    
    z - the distance by which coordinates are translated in the Z axis direction
- Method Detail
  - setX
```
public final void setX(double value)
```
    Sets the value of the property x.
  - getX
```
public final double getX()
```
    Gets the value of the property x.
  - xProperty
```
public final DoubleProperty xProperty()
```
    Defines the distance by which coordinates are translated in the X axis direction
    
    See Also:
    
    getX(), setX(double)
  - setY
```
public final void setY(double value)
```
    Sets the value of the property y.
  - getY
```
public final double getY()
```
    Gets the value of the property y.
  - yProperty
```
public final DoubleProperty yProperty()
```
    Defines the distance by which coordinates are translated in the Y axis direction
    
    See Also:
    
    getY(), setY(double)
  - setZ
```
public final void setZ(double value)
```
    Sets the value of the property z.
  - getZ
```
public final double getZ()
```
    Gets the value of the property z.
  - zProperty
```
public final DoubleProperty zProperty()
```
    Defines the distance by which coordinates are translated in the Z axis direction
    
    See Also:
    
    getZ(), setZ(double)
  - getTx
```
public double getTx()
```
    Description copied from class: Transform
    
    Gets the X coordinate translation element of the 3x4 matrix.
    
    Overrides:
    
    getTx in class Transform
    
    Returns:
    
    the X coordinate translation element of the 3x4 matrix
  - getTy
```
public double getTy()
```
    Description copied from class: Transform
    
    Gets the Y coordinate translation element of the 3x4 matrix.
    
    Overrides:
    
    getTy in class Transform
    
    Returns:
    
    the Y coordinate translation element of the 3x4 matrix
  - getTz
```
public double getTz()
```
    Description copied from class: Transform
    
    Gets the Z coordinate translation element of the 3x4 matrix.
    
    Overrides:
    
    getTz in class Transform
    
    Returns:
    
    the Z coordinate translation element of the 3x4 matrix
  - computeIs2D
```
boolean computeIs2D()
```
    Description copied from class: Transform
    
    Computes if this transform is currently a 2D transform (has no effect in the direction of Z axis). Used by the subclasses to effectively provide value of the type2D property.
    
    Overrides:
    
    computeIs2D in class Transform
    
    Returns:
    
    true if this transform is currently 2D-only
  - computeIsIdentity
```
boolean computeIsIdentity()
```
    Description copied from class: Transform
    
    Computes if this transform is currently an identity (has no effect in any direction). Used by the subclasses to effectively provide value of the identity property.
    
    Overrides:
    
    computeIsIdentity in class Transform
    
    Returns:
    
    true if this transform is currently an identity transform
  - fill2DArray
```
void fill2DArray(double[] array)
```
    Description copied from class: Transform
    
    Core of the toArray implementation for the 2D case. All of the checks has been made by the enclosing method as well as the constant elements filled, this method only fills the varying elements to the array. Used by subclasses to fill the elements efficiently.
    
    Overrides:
    
    fill2DArray in class Transform
    
    Parameters:
    
    array - array to be filled with the 6 2D elements
  - fill3DArray
```
void fill3DArray(double[] array)
```
    Description copied from class: Transform
    
    Core of the toArray implementation for the 3D case. All of the checks has been made by the enclosing method as well as the constant elements filled, this method only fills the varying elements to the array. Used by subclasses to fill the elements efficiently.
    
    Overrides:
    
    fill3DArray in class Transform
    
    Parameters:
    
    array - array to be filled with the 12 3D elements
  - createConcatenation
```
public Transform createConcatenation(Transform transform)
```
    Description copied from class: Transform
    
    Returns the concatenation of this transform and the specified transform. Applying the resulting transform to a node has the same effect as adding the two transforms to its getTransforms() list, this transform first and the specified transform second.
    
    Overrides:
    
    createConcatenation in class Transform
    
    Parameters:
    
    transform - transform to be concatenated with this transform
    
    Returns:
    
    The concatenated transform
  - createInverse
```
public Translate createInverse()
```
    Description copied from class: Transform
    
    Returns the inverse transform of this transform.
    
    Overrides:
    
    createInverse in class Transform
    
    Returns:
    
    the inverse transform
  - clone
```
public Translate clone()
```
    Description copied from class: Transform
    
    Returns a deep copy of this transform.
    
    Overrides:
    
    clone in class Transform
    
    Returns:
    
    a copy of this transform
  - transform
```
public Point2D transform(double x,
                         double y)
```
    Description copied from class: Transform
    
    Transforms the specified point by this transform. This method can be used only for 2D transforms.
    
    Overrides:
    
    transform in class Transform
    
    Parameters:
    
    x - the X coordinate of the point
    
    y - the Y coordinate of the point
    
    Returns:
    
    the transformed point
  - transform
```
public Point3D transform(double x,
                         double y,
                         double z)
```
    Description copied from class: Transform
    
    Transforms the specified point by this transform.
    
    Overrides:
    
    transform in class Transform
    
    Parameters:
    
    x - the X coordinate of the point
    
    y - the Y coordinate of the point
    
    z - the Z coordinate of the point
    
    Returns:
    
    the transformed point
  - transform2DPointsImpl
```
void transform2DPointsImpl(double[] srcPts,
                           int srcOff,
                           double[] dstPts,
                           int dstOff,
                           int numPts)
```
    Description copied from class: Transform
    
    Core of the transform2DPoints method. All the checks has been performed and the care of the overlaps has been taken by the enclosing method, this method only transforms the points and fills them to the array. Used by the subclasses to perform the transform efficiently.
    
    Overrides:
    
    transform2DPointsImpl in class Transform
  - transform3DPointsImpl
```
void transform3DPointsImpl(double[] srcPts,
                           int srcOff,
                           double[] dstPts,
                           int dstOff,
                           int numPts)
```
    Description copied from class: Transform
    
    Core of the transform3DPoints method. All the checks has been performed and the care of the overlaps has been taken by the enclosing method, this method only transforms the points and fills them to the array. Used by the subclasses to perform the transform efficiently.
    
    Overrides:
    
    transform3DPointsImpl in class Transform
  - deltaTransform
```
public Point2D deltaTransform(double x,
                              double y)
```
    Description copied from class: Transform
    
    Transforms the relative magnitude vector by this transform. The vector is transformed without applying the translation components of the affine transformation matrix. This method can be used only for a 2D transform.
    
    Overrides:
    
    deltaTransform in class Transform
    
    Parameters:
    
    x - vector magnitude in the direction of the X axis
    
    y - vector magnitude in the direction of the Y axis
    
    Returns:
    
    the transformed relative magnitude vector represented by a Point2D instance
  - deltaTransform
```
public Point2D deltaTransform(Point2D point)
```
    Description copied from class: Transform
    
    Transforms the relative magnitude vector represented by the specified Point3D instance by this transform. The vector is transformed without applying the translation components of the affine transformation matrix.
    
    Overrides:
    
    deltaTransform in class Transform
    
    Parameters:
    
    point - the relative magnitude vector
    
    Returns:
    
    the transformed relative magnitude vector represented by a Point3D instance
  - deltaTransform
```
public Point3D deltaTransform(double x,
                              double y,
                              double z)
```
    Description copied from class: Transform
    
    Transforms the relative magnitude vector by this transform. The vector is transformed without applying the translation components of the affine transformation matrix.
    
    Overrides:
    
    deltaTransform in class Transform
    
    Parameters:
    
    x - vector magnitude in the direction of the X axis
    
    y - vector magnitude in the direction of the Y axis
    
    z - vector magnitude in the direction of the Z axis
    
    Returns:
    
    the transformed relative magnitude vector represented by a Point3D instance
  - deltaTransform
```
public Point3D deltaTransform(Point3D point)
```
    Description copied from class: Transform
    
    Transforms the relative magnitude vector represented by the specified Point3D instance by this transform. The vector is transformed without applying the translation components of the affine transformation matrix.
    
    Overrides:
    
    deltaTransform in class Transform
    
    Parameters:
    
    point - the relative magnitude vector
    
    Returns:
    
    the transformed relative magnitude vector represented by a Point3D instance
  - inverseTransform
```
public Point2D inverseTransform(double x,
                                double y)
```
    Description copied from class: Transform
    
    Transforms the specified point by the inverse of this transform. This method can be used only for 2D transforms.
    
    Overrides:
    
    inverseTransform in class Transform
    
    Parameters:
    
    x - the X coordinate of the point
    
    y - the Y coordinate of the point
    
    Returns:
    
    the inversely transformed point
  - inverseTransform
```
public Point3D inverseTransform(double x,
                                double y,
                                double z)
```
    Description copied from class: Transform
    
    Transforms the specified point by the inverse of this transform.
    
    Overrides:
    
    inverseTransform in class Transform
    
    Parameters:
    
    x - the X coordinate of the point
    
    y - the Y coordinate of the point
    
    z - the Z coordinate of the point
    
    Returns:
    
    the inversely transformed point
  - inverseTransform2DPointsImpl
```
void inverseTransform2DPointsImpl(double[] srcPts,
                                  int srcOff,
                                  double[] dstPts,
                                  int dstOff,
                                  int numPts)
```
    Description copied from class: Transform
    
    Core of the inverseTransform2DPoints method. All the checks has been performed and the care of the overlaps has been taken by the enclosing method, this method only transforms the points and fills them to the array. Used by the subclasses to perform the transform efficiently.
    
    Overrides:
    
    inverseTransform2DPointsImpl in class Transform
  - inverseTransform3DPointsImpl
```
void inverseTransform3DPointsImpl(double[] srcPts,
                                  int srcOff,
                                  double[] dstPts,
                                  int dstOff,
                                  int numPts)
```
    Description copied from class: Transform
    
    Core of the inverseTransform3DPoints method. All the checks has been performed and the care of the overlaps has been taken by the enclosing method, this method only transforms the points and fills them to the array. Used by the subclasses to perform the transform efficiently.
    
    Overrides:
    
    inverseTransform3DPointsImpl in class Transform
  - inverseDeltaTransform
```
public Point2D inverseDeltaTransform(double x,
                                     double y)
```
    Description copied from class: Transform
    
    Transforms the relative magnitude vector by the inverse of this transform. The vector is transformed without applying the translation components of the affine transformation matrix. This method can be used only for a 2D transform.
    
    Overrides:
    
    inverseDeltaTransform in class Transform
    
    Parameters:
    
    x - vector magnitude in the direction of the X axis
    
    y - vector magnitude in the direction of the Y axis
    
    Returns:
    
    the inversely transformed relative magnitude vector represented by a Point2D instance
  - inverseDeltaTransform
```
public Point2D inverseDeltaTransform(Point2D point)
```
    Description copied from class: Transform
    
    Transforms the relative magnitude vector represented by the specified Point3D instance by the inverse of this transform. The vector is transformed without applying the translation components of the affine transformation matrix.
    
    Overrides:
    
    inverseDeltaTransform in class Transform
    
    Parameters:
    
    point - the relative magnitude vector
    
    Returns:
    
    the inversely transformed relative magnitude vector represented by a Point3D instance
  - inverseDeltaTransform
```
public Point3D inverseDeltaTransform(double x,
                                     double y,
                                     double z)
```
    Description copied from class: Transform
    
    Transforms the relative magnitude vector by the inverse of this transform. The vector is transformed without applying the translation components of the affine transformation matrix.
    
    Overrides:
    
    inverseDeltaTransform in class Transform
    
    Parameters:
    
    x - vector magnitude in the direction of the X axis
    
    y - vector magnitude in the direction of the Y axis
    
    z - vector magnitude in the direction of the Z axis
    
    Returns:
    
    the inversely transformed relative magnitude vector represented by a Point3D instance
  - inverseDeltaTransform
```
public Point3D inverseDeltaTransform(Point3D point)
```
    Description copied from class: Transform
    
    Transforms the relative magnitude vector represented by the specified Point3D instance by the inverse of this transform. The vector is transformed without applying the translation components of the affine transformation matrix.
    
    Overrides:
    
    inverseDeltaTransform in class Transform
    
    Parameters:
    
    point - the relative magnitude vector
    
    Returns:
    
    the inversely transformed relative magnitude vector represented by a Point3D instance
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this Translate object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of this Translate object.
  - apply
```
void apply(Affine3D trans)
```
    Specified by:
    
    apply in class Transform
  - derive
```
BaseTransform derive(BaseTransform trans)
```
    Specified by:
    
    derive in class Transform
  - validate
```
void validate()
```
    Description copied from class: Transform
    
    Needed for the proper delivery of the TransformChangedEvent. If the members are invalid, the transformChanged() notification is not called and the event is not delivered. To avoid that we need to manually validate all properties. Subclasses validate their specific properties.
    
    Overrides:
    
    validate in class Transform
  - appendTo
```
void appendTo(Affine a)
```
    Description copied from class: Transform
    
    Visitor from Affine class which provides an efficient append operation for the subclasses.
    
    Overrides:
    
    appendTo in class Transform
    
    Parameters:
    
    a - Affine instance to append to
  - prependTo
```
void prependTo(Affine a)
```
    Description copied from class: Transform
    
    Visitor from Affine class which provides an efficient prepend operation for the subclasses.
    
    Overrides:
    
    prependTo in class Transform
    
    Parameters:
    
    a - Affine instance to prepend to

Class Translate

Property Summary

Properties inherited from class javafx.scene.transform.Transform

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.transform.Transform

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.transform.Transform

Methods inherited from class java.lang.Object

Property Detail

x

y

z

Field Detail

x

y

z

Constructor Detail

Translate

Translate

Translate

Method Detail

setX

getX

xProperty

setY

getY

yProperty

setZ

getZ

zProperty

getTx

getTy

getTz

computeIs2D

computeIsIdentity

fill2DArray

fill3DArray

createConcatenation

createInverse

clone

transform

transform

transform2DPointsImpl

transform3DPointsImpl

deltaTransform

deltaTransform

deltaTransform

deltaTransform

inverseTransform

inverseTransform

inverseTransform2DPointsImpl

inverseTransform3DPointsImpl

inverseDeltaTransform

inverseDeltaTransform

inverseDeltaTransform

inverseDeltaTransform

toString

apply

derive

validate

appendTo

prependTo