javafx.scene.transform

Class Rotate

java.lang.Object

javafx.scene.transform.Transform

javafx.scene.transform.Rotate

public class Rotate
extends Transform

This class represents an Affine object that rotates coordinates around an anchor point. This operation is equivalent to translating the coordinates so that the anchor point is at the origin (S1), then rotating them about the new origin (S2), and finally translating so that the intermediate origin is restored to the coordinates of the original anchor point (S3).

For example, the matrix representing the returned transform of new Rotate (theta, x, y, z) around the Z-axis is :

              [   cos(theta)    -sin(theta)   0    x-x*cos+y*sin  ]
              [   sin(theta)     cos(theta)   0    y-x*sin-y*cos  ]
              [      0               0        1          z        ]
 

For example, to rotate a text 30 degrees around the Z-axis at anchor point of (50,30):

 Text text = new Text("This is a test");
 text.setX(10);
 text.setY(50);
 text.setFont(new Font(20));

 text.getTransforms().add(new Rotate(30, 50, 30));
 

Property Summary

Properties

Type	Property and Description
DoubleProperty	angle Defines the angle of rotation measured in degrees.
ObjectProperty<Point3D>	axis Defines the axis of rotation at the pivot point.
DoubleProperty	pivotX Defines the X coordinate of the rotation pivot point.
DoubleProperty	pivotY Defines the Y coordinate of the rotation pivot point.
DoubleProperty	pivotZ Defines the Z coordinate of the rotation pivot point.

Field Summary

Fields

Modifier and Type	Field and Description
static Point3D	X_AXIS Specifies the X-axis as the axis of rotation.
static Point3D	Y_AXIS Specifies the Y-axis as the axis of rotation.
static Point3D	Z_AXIS Specifies the Z-axis as the axis of rotation.

Constructor Summary

Constructors

Constructor and Description
Rotate() Creates a default Rotate transform (identity).
Rotate(double angle) Creates a two-dimensional Rotate transform.
Rotate(double angle, double pivotX, double pivotY) Creates a two-dimensional Rotate transform with pivot.
Rotate(double angle, double pivotX, double pivotY, double pivotZ) Creates a simple Rotate transform with three-dimensional pivot.
Rotate(double angle, double pivotX, double pivotY, double pivotZ, Point3D axis) Creates a three-dimensional Rotate transform with pivot.
Rotate(double angle, Point3D axis) Creates a three-dimensional Rotate transform.

Method Summary

Methods

Modifier and Type	Method and Description
DoubleProperty	angleProperty() Defines the angle of rotation measured in degrees.
ObjectProperty<Point3D>	axisProperty() Defines the axis of rotation at the pivot point.
double	getAngle() Gets the value of the property angle.
Point3D	getAxis() Gets the value of the property axis.
double	getMxx() Gets the X coordinate scaling element of the 3x4 matrix.
double	getMxy() Gets the XY coordinate element of the 3x4 matrix.
double	getMxz() Gets the XZ coordinate element of the 3x4 matrix.
double	getMyx() Gets the YX coordinate element of the 3x4 matrix.
double	getMyy() Gets the Y coordinate scaling element of the 3x4 matrix.
double	getMyz() Gets the YZ coordinate element of the 3x4 matrix.
double	getMzx() Gets the ZX coordinate element of the 3x4 matrix.
double	getMzy() Gets the ZY coordinate 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.
DoubleProperty	pivotXProperty() Defines the X coordinate of the rotation pivot point.
DoubleProperty	pivotYProperty() Defines the Y coordinate of the rotation pivot point.
DoubleProperty	pivotZProperty() Defines the Z coordinate of the rotation pivot point.
void	setAngle(double value) Sets the value of the property angle.
void	setAxis(Point3D value) Sets the value of the property axis.
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.
java.lang.String	toString() Returns a string representation of this Rotate object.

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

angle

public final DoubleProperty angleProperty

Defines the angle of rotation measured in degrees.

See Also:

getAngle(), setAngle(double)

pivotX

public final DoubleProperty pivotXProperty

Defines the X coordinate of the rotation pivot point.

See Also:

getPivotX(), setPivotX(double)

pivotY

public final DoubleProperty pivotYProperty

Defines the Y coordinate of the rotation pivot point.

See Also:

getPivotY(), setPivotY(double)

pivotZ

public final DoubleProperty pivotZProperty

Defines the Z coordinate of the rotation pivot point.

See Also:

getPivotZ(), setPivotZ(double)

axis

public final ObjectProperty<Point3D> axisProperty

Defines the axis of rotation at the pivot point.

See Also:

getAxis(), setAxis(Point3D)

Field Detail

X_AXIS

public static final Point3D X_AXIS

Specifies the X-axis as the axis of rotation.

Y_AXIS

public static final Point3D Y_AXIS

Specifies the Y-axis as the axis of rotation.

Z_AXIS

public static final Point3D Z_AXIS

Specifies the Z-axis as the axis of rotation.

Constructor Detail

Rotate

public Rotate()

Creates a default Rotate transform (identity).

Rotate

public Rotate(double angle)

Creates a two-dimensional Rotate transform.

Parameters:

angle - the angle of rotation measured in degrees

Rotate

public Rotate(double angle,
      Point3D axis)

Creates a three-dimensional Rotate transform.

Parameters:

angle - the angle of rotation measured in degrees

axis - the axis of rotation

Rotate

public Rotate(double angle,
      double pivotX,
      double pivotY)

Creates a two-dimensional Rotate transform with pivot.

Parameters:

angle - the angle of rotation measured in degrees

pivotX - the X coordinate of the rotation pivot point

pivotY - the Y coordinate of the rotation pivot point

Rotate

public Rotate(double angle,
      double pivotX,
      double pivotY,
      double pivotZ)

Creates a simple Rotate transform with three-dimensional pivot.

Parameters:

angle - the angle of rotation measured in degrees

pivotX - the X coordinate of the rotation pivot point

pivotY - the Y coordinate of the rotation pivot point

pivotZ - the Z coordinate of the rotation pivot point

Rotate

public Rotate(double angle,
      double pivotX,
      double pivotY,
      double pivotZ,
      Point3D axis)

Creates a three-dimensional Rotate transform with pivot.

Parameters:

angle - the angle of rotation measured in degrees

pivotX - the X coordinate of the rotation pivot point

pivotY - the Y coordinate of the rotation pivot point

pivotZ - the Z coordinate of the rotation pivot point

axis - the axis of rotation

Method Detail

setAngle

public final void setAngle(double value)

Sets the value of the property angle.

Property description:

Defines the angle of rotation measured in degrees.

getAngle

public final double getAngle()

Gets the value of the property angle.

Property description:

Defines the angle of rotation measured in degrees.

angleProperty

public final DoubleProperty angleProperty()

Defines the angle of rotation measured in degrees.

See Also:

getAngle(), setAngle(double)

setPivotX

public final void setPivotX(double value)

Sets the value of the property pivotX.

Property description:

Defines the X coordinate of the rotation pivot point.

getPivotX

public final double getPivotX()

Gets the value of the property pivotX.

Property description:

Defines the X coordinate of the rotation pivot point.

pivotXProperty

public final DoubleProperty pivotXProperty()

Defines the X coordinate of the rotation pivot point.

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 of the rotation pivot point.

getPivotY

public final double getPivotY()

Gets the value of the property pivotY.

Property description:

Defines the Y coordinate of the rotation pivot point.

pivotYProperty

public final DoubleProperty pivotYProperty()

Defines the Y coordinate of the rotation pivot point.

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 of the rotation pivot point.

getPivotZ

public final double getPivotZ()

Gets the value of the property pivotZ.

Property description:

Defines the Z coordinate of the rotation pivot point.

pivotZProperty

public final DoubleProperty pivotZProperty()

Defines the Z coordinate of the rotation pivot point.

See Also:

getPivotZ(), setPivotZ(double)

setAxis

public final void setAxis(Point3D value)

Sets the value of the property axis.

Property description:

Defines the axis of rotation at the pivot point.

getAxis

public final Point3D getAxis()

Gets the value of the property axis.

Property description:

Defines the axis of rotation at the pivot point.

axisProperty

public final ObjectProperty<Point3D> axisProperty()

Defines the axis of rotation at the pivot point.

See Also:

getAxis(), setAxis(Point3D)

getMxx

public double getMxx()

Description copied from class: Transform

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

Overrides:

getMxx in class Transform

getMxy

public double getMxy()

Description copied from class: Transform

Gets the XY coordinate element of the 3x4 matrix.

Overrides:

getMxy in class Transform

getMxz

public double getMxz()

Description copied from class: Transform

Gets the XZ coordinate element of the 3x4 matrix.

Overrides:

getMxz 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

getMyx

public double getMyx()

Description copied from class: Transform

Gets the YX coordinate element of the 3x4 matrix.

Overrides:

getMyx 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

getMyz

public double getMyz()

Description copied from class: Transform

Gets the YZ coordinate element of the 3x4 matrix.

Overrides:

getMyz 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

getMzx

public double getMzx()

Description copied from class: Transform

Gets the ZX coordinate element of the 3x4 matrix.

Overrides:

getMzx in class Transform

getMzy

public double getMzy()

Description copied from class: Transform

Gets the ZY coordinate element of the 3x4 matrix.

Overrides:

getMzy 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

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 Rotate object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this Rotate object.