Class Scale

All Implemented Interfaces:
Cloneable, EventTarget

public class Scale extends Transform
This class represents an Affine object that scales coordinates by the specified factors. The matrix representing the scaling transformation around a pivot point (pivotX, pivotY, pivotZ) with scaling factors x, y and z is as follows:
              [   x   0   0   (1-x)*pivotX   ]
              [   0   y   0   (1-y)*pivotY   ]
              [   0   0   z   (1-z)*pivotZ   ]
 
Since:
JavaFX 2.0
  • Property Details

  • Constructor Details

    • Scale

      public Scale()
      Creates a default Scale (identity).
    • Scale

      public Scale(double x, double y)
      Creates a two-dimensional Scale. The pivot point is set to (0,0)
      Parameters:
      x - the factor by which coordinates are scaled along the X axis
      y - the factor by which coordinates are scaled along the Y axis
    • Scale

      public Scale(double x, double y, double pivotX, double pivotY)
      Creates a two-dimensional Scale with pivot.
      Parameters:
      x - the factor by which coordinates are scaled along the X axis
      y - the factor by which coordinates are scaled along the Y axis
      pivotX - the X coordinate about which point the scale occurs
      pivotY - the Y coordinate about which point the scale occurs
    • Scale

      public Scale(double x, double y, double z)
      Creates a three-dimensional Scale. The pivot point is set to (0,0,0)
      Parameters:
      x - the factor by which coordinates are scaled along the X axis
      y - the factor by which coordinates are scaled along the Y axis
      z - the factor by which coordinates are scaled along the Z axis
    • Scale

      public Scale(double x, double y, double z, double pivotX, double pivotY, double pivotZ)
      Creates a three-dimensional Scale with pivot.
      Parameters:
      x - the factor by which coordinates are scaled along the X axis
      y - the factor by which coordinates are scaled along the Y axis
      z - the factor by which coordinates are scaled along the Z axis
      pivotX - the X coordinate about which point the scale occurs
      pivotY - the Y coordinate about which point the scale occurs
      pivotZ - the Z coordinate about which point the scale occurs
  • Method Details

    • setX

      public final void setX(double value)
      Sets the value of the x property.
      Property description:
      Defines the factor by which coordinates are scaled along the X axis direction. The default value is 1.0.
      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 factor by which coordinates are scaled along the X axis direction. The default value is 1.0.
      Returns:
      the value of the x property
      See Also:
    • xProperty

      public final DoubleProperty xProperty()
      Defines the factor by which coordinates are scaled along the X axis direction. The default value is 1.0.
      Returns:
      the x property
      See Also:
    • setY

      public final void setY(double value)
      Sets the value of the y property.
      Property description:
      Defines the factor by which coordinates are scaled along the Y axis direction. The default value is 1.0.
      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 factor by which coordinates are scaled along the Y axis direction. The default value is 1.0.
      Returns:
      the value of the y property
      See Also:
    • yProperty

      public final DoubleProperty yProperty()
      Defines the factor by which coordinates are scaled along the Y axis direction. The default value is 1.0.
      Returns:
      the y property
      See Also:
    • setZ

      public final void setZ(double value)
      Sets the value of the z property.
      Property description:
      Defines the factor by which coordinates are scaled along the Z axis direction. The default value is 1.0.
      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 factor by which coordinates are scaled along the Z axis direction. The default value is 1.0.
      Returns:
      the value of the z property
      See Also:
    • zProperty

      public final DoubleProperty zProperty()
      Defines the factor by which coordinates are scaled along the Z axis direction. The default value is 1.0.
      Returns:
      the z property
      See Also:
    • setPivotX

      public final void setPivotX(double value)
      Sets the value of the pivotX property.
      Property description:
      Defines the X coordinate about which point the scale occurs.
      Default value:
      0.0
      Parameters:
      value - the value for the pivotX property
      See Also:
    • getPivotX

      public final double getPivotX()
      Gets the value of the pivotX property.
      Property description:
      Defines the X coordinate about which point the scale occurs.
      Default value:
      0.0
      Returns:
      the value of the pivotX property
      See Also:
    • pivotXProperty

      public final DoubleProperty pivotXProperty()
      Defines the X coordinate about which point the scale occurs.
      Default value:
      0.0
      Returns:
      the pivotX property
      See Also:
    • setPivotY

      public final void setPivotY(double value)
      Sets the value of the pivotY property.
      Property description:
      Defines the Y coordinate about which point the scale occurs.
      Default value:
      0.0
      Parameters:
      value - the value for the pivotY property
      See Also:
    • getPivotY

      public final double getPivotY()
      Gets the value of the pivotY property.
      Property description:
      Defines the Y coordinate about which point the scale occurs.
      Default value:
      0.0
      Returns:
      the value of the pivotY property
      See Also:
    • pivotYProperty

      public final DoubleProperty pivotYProperty()
      Defines the Y coordinate about which point the scale occurs.
      Default value:
      0.0
      Returns:
      the pivotY property
      See Also:
    • setPivotZ

      public final void setPivotZ(double value)
      Sets the value of the pivotZ property.
      Property description:
      Defines the Z coordinate about which point the scale occurs.
      Default value:
      0.0
      Parameters:
      value - the value for the pivotZ property
      See Also:
    • getPivotZ

      public final double getPivotZ()
      Gets the value of the pivotZ property.
      Property description:
      Defines the Z coordinate about which point the scale occurs.
      Default value:
      0.0
      Returns:
      the value of the pivotZ property
      See Also:
    • pivotZProperty

      public final DoubleProperty pivotZProperty()
      Defines the Z coordinate about which point the scale occurs.
      Default value:
      0.0
      Returns:
      the pivotZ property
      See Also:
    • createInverse

      public Scale createInverse() throws NonInvertibleTransformException
      Description copied from class: Transform
      Returns the inverse transform of this transform.
      Overrides:
      createInverse in class Transform
      Returns:
      the inverse transform
      Throws:
      NonInvertibleTransformException - if this transform cannot be inverted
    • clone

      public Scale clone()
      Description copied from class: Transform
      Returns a deep copy of this transform.
      Overrides:
      clone in class Transform
      Returns:
      a copy of this transform
    • toString

      public String toString()
      Returns a string representation of this Scale object.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this Scale object.