Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: Scale

[11:7] extends: Transform

Wraps JavaFX Scale, a Transform that scales a node along the X, Y, and Z axes around an optional pivot point. Useful in both 2D and 3D scenes.

Methods

  • Scale (double X = 1.0, double Y = 1.0, double Z = 1.0, double PivotX = 0.0, double PivotY = 0.0, double PivotZ = 0.0)

    Creates a new Scale with the given X, Y, and Z scale factors and optional pivot.

    • @p X is a double with the X scale factor.
    • @p Y is a double with the Y scale factor.
    • @p Z is a double with the Z scale factor.
    • @p PivotX is an optional double with the pivot X coordinate.
    • @p PivotY is an optional double with the pivot Y coordinate.
    • @p PivotZ is an optional double with the pivot Z coordinate.
  • setX (double X)

    Sets the X scale factor.

    • @p X is a double with the X factor.
    • @r this object
  • setY (double Y)

    Sets the Y scale factor.

    • @p Y is a double with the Y factor.
    • @r this object
  • setZ (double Z)

    Sets the Z scale factor.

    • @p Z is a double with the Z factor.
    • @r this object
  • getX ()

    Returns the X scale factor.

    • @r A double with the X factor.
  • getY ()

    Returns the Y scale factor.

    • @r A double with the Y factor.
  • getZ ()

    Returns the Z scale factor.

    • @r A double with the Z factor.
  • xProperty ()

    Returns the DoubleProperty backing the X scale factor.

    • @r A DoubleProperty AJO.
  • yProperty ()

    Returns the DoubleProperty backing the Y scale factor.

    • @r A DoubleProperty AJO.
  • zProperty ()

    Returns the DoubleProperty backing the Z scale factor.

    • @r A DoubleProperty AJO.
  • setPivotX (double X)

    Sets the pivot X coordinate.

    • @p X is a double with the pivot X value.
    • @r this object
  • getPivotX ()

    Returns the pivot X coordinate.

    • @r A double with the pivot X.
  • pivotXProperty ()

    Returns the DoubleProperty backing the pivot X coordinate.

    • @r A DoubleProperty AJO.
  • setPivotY (double Y)

    Sets the pivot Y coordinate.

    • @p Y is a double with the pivot Y value.
    • @r this object
  • getPivotY ()

    Returns the pivot Y coordinate.

    • @r A double with the pivot Y.
  • pivotYProperty ()

    Returns the DoubleProperty backing the pivot Y coordinate.

    • @r A DoubleProperty AJO.
  • setPivotZ (double Z)

    Sets the pivot Z coordinate.

    • @p Z is a double with the pivot Z value.
    • @r this object
  • getPivotZ ()

    Returns the pivot Z coordinate.

    • @r A double with the pivot Z.
  • pivotZProperty ()

    Returns the DoubleProperty backing the pivot Z coordinate.

    • @r A DoubleProperty AJO.
  • getMxx ()

    Returns matrix element [0, 0].

    • @r A double with the Mxx value.
  • getMyy ()

    Returns matrix element [1, 1].

    • @r A double with the Myy value.
  • getMzz ()

    Returns matrix element [2, 2].

    • @r A double with the Mzz value.
  • getTx ()

    Returns the translation X component.

    • @r A double with the Tx value.
  • getTy ()

    Returns the translation Y component.

    • @r A double with the Ty value.
  • getTz ()

    Returns the translation Z component.

    • @r A double with the Tz value.
  • createConcatenation (object Tx)

    Returns the concatenation of this transform with the supplied Transform.

    • @p Tx is a Transform wrapper to concatenate with.
    • @r An AJO holding the resulting javafx.scene.transform.Transform.
  • createInverse ()

    Returns the inverse of this transform. Throws NonInvertibleTransformException when not invertible.

    • @r An AJO holding the inverse javafx.scene.transform.Transform.
  • transform (double X, double Y)

    Transforms a 2D point through this scale. Wraps the (double, double) overload that returns a Point2D.

    • @p X is a double with the input X coordinate.
    • @p Y is a double with the input Y coordinate.
    • @r An AJO holding the resulting javafx.geometry.Point2D.
  • transform3D (double X, double Y, double Z)

    Transforms a 3D point through this scale. Wraps the (double, double, double) overload that returns a Point3D.

    • @p X is a double with the input X coordinate.
    • @p Y is a double with the input Y coordinate.
    • @p Z is a double with the input Z coordinate.
    • @r An AJO holding the resulting javafx.geometry.Point3D.
  • deltaTransform (double X, double Y)

    Transforms only the vector portion (no translation) of a 2D point.

    • @p X is a double with the input X coordinate.
    • @p Y is a double with the input Y coordinate.
    • @r An AJO holding the resulting javafx.geometry.Point2D.
  • deltaTransform3D (double X, double Y, double Z)

    Transforms only the vector portion (no translation) of a 3D point.

    • @p X is a double with the input X coordinate.
    • @p Y is a double with the input Y coordinate.
    • @p Z is a double with the input Z coordinate.
    • @r An AJO holding the resulting javafx.geometry.Point3D.
  • inverseTransform (double X, double Y)

    Inverse-transforms a 2D point through this scale. Throws NonInvertibleTransformException if not invertible.

    • @p X is a double with the input X coordinate.
    • @p Y is a double with the input Y coordinate.
    • @r An AJO holding the resulting javafx.geometry.Point2D.
  • inverseTransform3D (double X, double Y, double Z)

    Inverse-transforms a 3D point through this scale. Throws NonInvertibleTransformException if not invertible.

    • @p X is a double with the input X coordinate.
    • @p Y is a double with the input Y coordinate.
    • @p Z is a double with the input Z coordinate.
    • @r An AJO holding the resulting javafx.geometry.Point3D.
  • inverseDeltaTransform (double X, double Y)

    Inverse-transforms only the vector portion of a 2D point. Throws NonInvertibleTransformException if not invertible.

    • @p X is a double with the input X coordinate.
    • @p Y is a double with the input Y coordinate.
    • @r An AJO holding the resulting javafx.geometry.Point2D.
  • inverseDeltaTransform3D (double X, double Y, double Z)

    Inverse-transforms only the vector portion of a 3D point. Throws NonInvertibleTransformException if not invertible.

    • @p X is a double with the input X coordinate.
    • @p Y is a double with the input Y coordinate.
    • @p Z is a double with the input Z coordinate.
    • @r An AJO holding the resulting javafx.geometry.Point3D.