Module javafx.graphics
Package javafx.scene.transform

Class Translate

java.lang.Object
javafx.scene.transform.Transform
javafx.scene.transform.Translate
All Implemented Interfaces:
Cloneable, EventTarget
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 Details

  • Constructor Details

    • 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 Details

    • setX

      public final void setX(double value)
      Sets the value of the x property.
      Property description:
      Defines the distance by which coordinates are translated in the X axis direction
      Parameters:
      value - the value for the x property
      See Also:

    • getX

      public final double getX()
      Gets the value of the x property.
      Property description:
      Defines the distance by which coordinates are translated in the X axis direction
      Returns:
      the value of the x property
      See Also:

    • xProperty

      public final DoubleProperty xProperty()
      Defines the distance by which coordinates are translated in the X axis direction
      Returns:
      the x property
      See Also:

    • setY

      public final void setY(double value)
      Sets the value of the y property.
      Property description:
      Defines the distance by which coordinates are translated in the Y axis direction
      Parameters:
      value - the value for the y property
      See Also:

    • getY

      public final double getY()
      Gets the value of the y property.
      Property description:
      Defines the distance by which coordinates are translated in the Y axis direction
      Returns:
      the value of the y property
      See Also:

    • yProperty

      public final DoubleProperty yProperty()
      Defines the distance by which coordinates are translated in the Y axis direction
      Returns:
      the y property
      See Also:

    • setZ

      public final void setZ(double value)
      Sets the value of the z property.
      Property description:
      Defines the distance by which coordinates are translated in the Z axis direction
      Parameters:
      value - the value for the z property
      See Also:

    • getZ

      public final double getZ()
      Gets the value of the z property.
      Property description:
      Defines the distance by which coordinates are translated in the Z axis direction
      Returns:
      the value of the z property
      See Also:

    • zProperty

      public final DoubleProperty zProperty()
      Defines the distance by which coordinates are translated in the Z axis direction
      Returns:
      the z property
      See Also:

    • 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

    • 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

    • 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 Point2D instance 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:
      point - the relative magnitude vector
      Returns:
      the transformed relative magnitude vector represented by a Point2D 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

    • 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 Point2D instance 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:
      point - the relative magnitude vector
      Returns:
      the inversely transformed relative magnitude vector represented by a Point2D 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 String toString()
      Returns a string representation of this Translate object.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this Translate object.