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   (1-x)*pivotX ]
              [ 0   y   0   (1-y)*pivotY ]
              [ 0   0   z   (1-z)*pivotZ ]
 

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	getMxx() Gets the X coordinate scaling element of the 3x4 matrix.
double	getMyy() Gets the Y coordinate scaling element of the 3x4 matrix.
double	getMzz() Gets the Z coordinate scaling element of the 3x4 matrix.
double	getPivotX() Gets the value of the property pivotX.
double	getPivotY() Gets the value of the property pivotY.
double	getPivotZ() Gets the value of the property pivotZ.
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.
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) Sets the value of the property pivotX.
void	setPivotY(double value) Sets the value of the property pivotY.
void	setPivotZ(double value) Sets the value of the property pivotZ.
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 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, getMxy, getMxz, getMyx, getMyz, getMzx, getMzy, 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

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)

y

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)

z

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)

pivotX

public final DoubleProperty pivotXProperty

Defines the X coordinate about which point the scale occurs.

See Also:

getPivotX(), setPivotX(double)

pivotY

public final DoubleProperty pivotYProperty

Defines the Y coordinate about which point the scale occurs.

See Also:

getPivotY(), setPivotY(double)

pivotZ

public final DoubleProperty pivotZProperty

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)

Sets the value of the property x.

Property description:

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

getX

public final double getX()

Gets the value of the property x.

Property description:

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)

Sets the value of the property y.

Property description:

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

getY

public final double getY()

Gets the value of the property y.

Property description:

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)

Sets the value of the property z.

Property description:

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

getZ

public final double getZ()

Gets the value of the property z.

Property description:

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)

Sets the value of the property pivotX.

Property description:

Defines the X coordinate about which point the scale occurs.

getPivotX

public final double getPivotX()

Gets the value of the property pivotX.

Property description:

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)

Sets the value of the property pivotY.

Property description:

Defines the Y coordinate about which point the scale occurs.

getPivotY

public final double getPivotY()

Gets the value of the property pivotY.

Property description:

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)

Sets the value of the property pivotZ.

Property description:

Defines the Z coordinate about which point the scale occurs.

getPivotZ

public final double getPivotZ()

Gets the value of the property pivotZ.

Property description:

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)

getMxx

public double getMxx()

Description copied from class: Transform

Gets the X coordinate scaling element of the 3x4 matrix.

Overrides:

getMxx in class Transform

getMyy

public double getMyy()

Description copied from class: Transform

Gets the Y coordinate scaling element of the 3x4 matrix.

Overrides:

getMyy in class Transform

getMzz

public double getMzz()

Description copied from class: Transform

Gets the Z coordinate scaling element of the 3x4 matrix.

Overrides:

getMzz in class Transform

getTx

public double getTx()

Description copied from class: Transform

Gets the X coordinate translation element of the 3x4 matrix.

Overrides:

getTx in class Transform

getTy

public double getTy()

Description copied from class: Transform

Gets the Y coordinate translation element of the 3x4 matrix.

Overrides:

getTy in class Transform

getTz

public double getTz()

Description copied from class: Transform

Gets the Z coordinate translation element of the 3x4 matrix.

Overrides:

getTz in class Transform

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.