javafx.scene.transform

Class Scale

java.lang.Object

javafx.scene.transform.Transform

javafx.scene.transform.Scale

public class Scale
extends Transform

This class represents an Affine object that scales coordinates by the specified factors. The matrix representing the scaling transformation is as follows:

              [ x    0   0   0 ]
              [ 0    y   0   0 ]
              [ 0    0   z   0 ]
 

Property Summary

Properties

Type	Property and Description
DoubleProperty	pivotX Defines the X coordinate about which point the scale occurs.
DoubleProperty	pivotY Defines the Y coordinate about which point the scale occurs.
DoubleProperty	pivotZ Defines the Z coordinate about which point the scale occurs.
DoubleProperty	x Defines the factor by which coordinates are scaled along the X axis direction.
DoubleProperty	y Defines the factor by which coordinates are scaled along the Y axis direction.
DoubleProperty	z Defines the factor by which coordinates are scaled along the Z axis direction.

Constructor Summary

Constructors

Constructor and Description
Scale() Creates a default Scale (identity).
Scale(double x, double y) Creates a two-dimensional Scale.
Scale(double x, double y, double z) Creates a three-dimensional Scale.
Scale(double x, double y, double pivotX, double pivotY) Creates a two-dimensional Scale with pivot.
Scale(double x, double y, double z, double pivotX, double pivotY, double pivotZ) Creates a three-dimensional Scale with pivot.

Method Summary

Methods

Modifier and Type	Method and Description
double	getPivotX() Defines the X coordinate about which point the scale occurs.
double	getPivotY() Defines the Y coordinate about which point the scale occurs.
double	getPivotZ() Defines the Z coordinate about which point the scale occurs.
double	getX() Defines the factor by which coordinates are scaled along the X axis direction.
double	getY() Defines the factor by which coordinates are scaled along the Y axis direction.
double	getZ() Defines the factor by which coordinates are scaled along the Z axis direction.
DoubleProperty	pivotXProperty() Defines the X coordinate about which point the scale occurs.
DoubleProperty	pivotYProperty() Defines the Y coordinate about which point the scale occurs.
DoubleProperty	pivotZProperty() Defines the Z coordinate about which point the scale occurs.
void	setPivotX(double value) Defines the X coordinate about which point the scale occurs.
void	setPivotY(double value) Defines the Y coordinate about which point the scale occurs.
void	setPivotZ(double value) Defines the Z coordinate about which point the scale occurs.
void	setX(double value) Defines the factor by which coordinates are scaled along the X axis direction.
void	setY(double value) Defines the factor by which coordinates are scaled along the Y axis direction.
void	setZ(double value) Defines the factor by which coordinates are scaled along the Z axis direction.
java.lang.String	toString() Returns a string representation of this Scale object.
DoubleProperty	xProperty() Defines the factor by which coordinates are scaled along the X axis direction.
DoubleProperty	yProperty() Defines the factor by which coordinates are scaled along the Y axis direction.
DoubleProperty	zProperty() Defines the factor by which coordinates are scaled along the Z axis direction.

Methods inherited from class javafx.scene.transform.Transform

affine, affine, rotate, scale, scale, shear, shear, translate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

x

Defines the factor by which coordinates are scaled along the X axis direction. The default value is 1.0.

See Also:

getX(), setX(double)

y

Defines the factor by which coordinates are scaled along the Y axis direction. The default value is 1.0.

See Also:

getY(), setY(double)

z

Defines the factor by which coordinates are scaled along the Z axis direction. The default value is 1.0.

See Also:

getZ(), setZ(double)

pivotX

Defines the X coordinate about which point the scale occurs.

See Also:

getPivotX(), setPivotX(double)

pivotY

Defines the Y coordinate about which point the scale occurs.

See Also:

getPivotY(), setPivotY(double)

pivotZ

Defines the Z coordinate about which point the scale occurs.

See Also:

getPivotZ(), setPivotZ(double)

Constructor Detail

Scale

public Scale()

Creates a default Scale (identity).

Scale

public Scale(double x,
     double y)

Creates a two-dimensional Scale.

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.

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 Detail

setX

public final void setX(double value)

Defines the factor by which coordinates are scaled along the X axis direction. The default value is 1.0.

getX

public final double getX()

Defines the factor by which coordinates are scaled along the X axis direction. The default value is 1.0.

xProperty

public final DoubleProperty xProperty()

Defines the factor by which coordinates are scaled along the X axis direction. The default value is 1.0.

See Also:

getX(), setX(double)

setY

public final void setY(double value)

Defines the factor by which coordinates are scaled along the Y axis direction. The default value is 1.0.

getY

public final double getY()

Defines the factor by which coordinates are scaled along the Y axis direction. The default value is 1.0.

yProperty

public final DoubleProperty yProperty()

Defines the factor by which coordinates are scaled along the Y axis direction. The default value is 1.0.

See Also:

getY(), setY(double)

setZ

public final void setZ(double value)

Defines the factor by which coordinates are scaled along the Z axis direction. The default value is 1.0.

getZ

public final double getZ()

Defines the factor by which coordinates are scaled along the Z axis direction. The default value is 1.0.

zProperty

public final DoubleProperty zProperty()

Defines the factor by which coordinates are scaled along the Z axis direction. The default value is 1.0.

See Also:

getZ(), setZ(double)

setPivotX

public final void setPivotX(double value)

Defines the X coordinate about which point the scale occurs.

getPivotX

public final double getPivotX()

Defines the X coordinate about which point the scale occurs.

pivotXProperty

public final DoubleProperty pivotXProperty()

Defines the X coordinate about which point the scale occurs.

See Also:

getPivotX(), setPivotX(double)

setPivotY

public final void setPivotY(double value)

Defines the Y coordinate about which point the scale occurs.

getPivotY

public final double getPivotY()

Defines the Y coordinate about which point the scale occurs.

pivotYProperty

public final DoubleProperty pivotYProperty()

Defines the Y coordinate about which point the scale occurs.

See Also:

getPivotY(), setPivotY(double)

setPivotZ

public final void setPivotZ(double value)

Defines the Z coordinate about which point the scale occurs.

getPivotZ

public final double getPivotZ()

Defines the Z coordinate about which point the scale occurs.

pivotZProperty

public final DoubleProperty pivotZProperty()

Defines the Z coordinate about which point the scale occurs.

See Also:

getPivotZ(), setPivotZ(double)

toString

public java.lang.String toString()

Returns a string representation of this Scale object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this Scale object.