Top Description Fields Constructors Methods
javafx.scene.input

public final Class RotateEvent

extends GestureEvent
Class Inheritance
Imports
javafx.beans.NamedArg, javafx.event.EventTarget, .EventType

Rotate event indicates that user performed rotating gesture such as dragging two fingers around each other on track pad, touch screen or other similar device.

The event is delivered to the top-most node picked on the gesture coordinates in time of the gesture start - the whole gesture is delivered to the same node even if the coordinates change during the gesture.

The event provides two values: angle is the rotation angle of this event, totalAngle is the rotation angle of the whole gesture. Both values are in degrees and work well when added to the node's rotate property value (positive values for clockwise rotation).

As all gestures, rotation can be direct (performed directly at the concrete coordinates as on touch screen - the center point among all the touches is usually used as the gesture coordinates) or indirect (performed indirectly as on track pad - the mouse cursor location is usually used as the gesture coordinates).

The gesture's ROTATE events are surrounded by ROTATION_STARTED and ROTATION_FINISHED events. If rotation inertia is active on the given platform, some ROTATE events with isInertia() returning true can come after ROTATION_FINISHED.

Since
JavaFX 2.2

Field Summary

Modifier and TypeField and Description
private final double
public static final EventType<RotateEvent>
ANY

Hides javafx.scene.input.GestureEvent.ANY.

Common supertype for all rotate event types.
public static final EventType<RotateEvent>
ROTATE

This event occurs when user performs a rotating gesture such as dragging two fingers around each other.

public static final EventType<RotateEvent>
ROTATION_FINISHED

This event occurs when a rotating gesture ends.

public static final EventType<RotateEvent>
ROTATION_STARTED

This event occurs when a rotating gesture is detected.

private static final long
private final double

Constructor Summary

AccessConstructor and Description
public
RotateEvent(Object
the source of the event. Can be null.
source
,
EventTarget
the target of the event. Can be null.
target
,
final EventType<RotateEvent>
The type of the event.
eventType
,
double
The x with respect to the scene.
x
,
double
The y with respect to the scene.
y
,
double
The x coordinate relative to screen.
screenX
,
double
The y coordinate relative to screen.
screenY
,
boolean
true if shift modifier was pressed.
shiftDown
,
boolean
true if control modifier was pressed.
controlDown
,
boolean
true if alt modifier was pressed.
altDown
,
boolean
true if meta modifier was pressed.
metaDown
,
boolean
true if the event was caused by direct input device. See isDirect()
direct
,
boolean
if represents inertia of an already finished gesture.
inertia
,
double
the rotational angle
angle
,
double
the cumulative rotational angle
totalAngle
,
PickResult
pick result. Can be null, in this case a 2D pick result without any further values is constructed based on the scene coordinates and the target
pickResult
)

Constructs new RotateEvent event.

public
RotateEvent(final EventType<RotateEvent>
The type of the event.
eventType
,
double
The x with respect to the scene.
x
,
double
The y with respect to the scene.
y
,
double
The x coordinate relative to screen.
screenX
,
double
The y coordinate relative to screen.
screenY
,
boolean
true if shift modifier was pressed.
shiftDown
,
boolean
true if control modifier was pressed.
controlDown
,
boolean
true if alt modifier was pressed.
altDown
,
boolean
true if meta modifier was pressed.
metaDown
,
boolean
true if the event was caused by direct input device. See isDirect()
direct
,
boolean
if represents inertia of an already finished gesture.
inertia
,
double
the rotational angle
angle
,
double
the cumulative rotational angle
totalAngle
,
PickResult
pick result. Can be null, in this case a 2D pick result without any further values is constructed based on the scene coordinates
pickResult
)

Constructs new RotateEvent event with null source and target

Method Summary

Modifier and TypeMethod and Description
public RotateEvent
copyFor(Object newSource, EventTarget newTarget)

Overrides javafx.scene.input.GestureEvent.copyFor.

Creates and returns a copy of this event with the specified event source and target.

public RotateEvent

Returns:

the event copy with the fields substituted
copyFor
(Object
the new source of the copied event
newSource
,
EventTarget
the new target of the copied event
newTarget
,
EventType<RotateEvent>
the new eventType
type
)

Creates a copy of the given event with the given fields substituted.

public double

Returns:

The rotation angle of this event
getAngle
()

Gets the rotation angle of this event.

public EventType<RotateEvent>
getEventType()

Overrides javafx.scene.input.GestureEvent.getEventType.

Gets the event type of this event.

public double

Returns:

The cumulative rotation angle of this gesture
getTotalAngle
()

Gets the cumulative rotation angle of this gesture.

public String

Returns:

a string representation of this RotateEvent object.
toString
()

Overrides javafx.scene.input.GestureEvent.toString.

Returns a string representation of this RotateEvent object.

Inherited from javafx.scene.input.GestureEvent:
getPickResultgetSceneXgetSceneYgetScreenXgetScreenYgetXgetYgetZisAltDownisControlDownisDirectisInertiaisMetaDownisShiftDownisShortcutDown

Field Detail

angleback to summary
private final double angle
Annotations
@SuppressWarnings:doclint:missing
ANYback to summary
public static final EventType<RotateEvent> ANY

Hides javafx.scene.input.GestureEvent.ANY.

Common supertype for all rotate event types.

ROTATEback to summary
public static final EventType<RotateEvent> ROTATE

This event occurs when user performs a rotating gesture such as dragging two fingers around each other.

ROTATION_FINISHEDback to summary
public static final EventType<RotateEvent> ROTATION_FINISHED

This event occurs when a rotating gesture ends.

ROTATION_STARTEDback to summary
public static final EventType<RotateEvent> ROTATION_STARTED

This event occurs when a rotating gesture is detected.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javafx.scene.input.GestureEvent.serialVersionUID.

totalAngleback to summary
private final double totalAngle
Annotations
@SuppressWarnings:doclint:missing

Constructor Detail

RotateEventback to summary
public RotateEvent(Object source, EventTarget target, final EventType<RotateEvent> eventType, double x, double y, double screenX, double screenY, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean direct, boolean inertia, double angle, double totalAngle, PickResult pickResult)

Constructs new RotateEvent event.

Parameters
source:Object

the source of the event. Can be null.

target:EventTarget

the target of the event. Can be null.

eventType:EventType<RotateEvent>

The type of the event.

x:double

The x with respect to the scene.

y:double

The y with respect to the scene.

screenX:double

The x coordinate relative to screen.

screenY:double

The y coordinate relative to screen.

shiftDown:boolean

true if shift modifier was pressed.

controlDown:boolean

true if control modifier was pressed.

altDown:boolean

true if alt modifier was pressed.

metaDown:boolean

true if meta modifier was pressed.

direct:boolean

true if the event was caused by direct input device. See isDirect()

inertia:boolean

if represents inertia of an already finished gesture.

angle:double

the rotational angle

totalAngle:double

the cumulative rotational angle

pickResult:PickResult

pick result. Can be null, in this case a 2D pick result without any further values is constructed based on the scene coordinates and the target

Since
JavaFX 8.0
RotateEventback to summary
public RotateEvent(final EventType<RotateEvent> eventType, double x, double y, double screenX, double screenY, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean direct, boolean inertia, double angle, double totalAngle, PickResult pickResult)

Constructs new RotateEvent event with null source and target

Parameters
eventType:EventType<RotateEvent>

The type of the event.

x:double

The x with respect to the scene.

y:double

The y with respect to the scene.

screenX:double

The x coordinate relative to screen.

screenY:double

The y coordinate relative to screen.

shiftDown:boolean

true if shift modifier was pressed.

controlDown:boolean

true if control modifier was pressed.

altDown:boolean

true if alt modifier was pressed.

metaDown:boolean

true if meta modifier was pressed.

direct:boolean

true if the event was caused by direct input device. See isDirect()

inertia:boolean

if represents inertia of an already finished gesture.

angle:double

the rotational angle

totalAngle:double

the cumulative rotational angle

pickResult:PickResult

pick result. Can be null, in this case a 2D pick result without any further values is constructed based on the scene coordinates

Since
JavaFX 8.0

Method Detail

copyForback to summary
public RotateEvent copyFor(Object newSource, EventTarget newTarget)

Overrides javafx.scene.input.GestureEvent.copyFor.

Doc from javafx.scene.input.GestureEvent.copyFor.

Creates and returns a copy of this event with the specified event source and target. If the source or target is set to null, it is replaced by the NULL_SOURCE_TARGET value.

Annotations
@Override
copyForback to summary
public RotateEvent copyFor(Object newSource, EventTarget newTarget, EventType<RotateEvent> type)

Creates a copy of the given event with the given fields substituted.

Parameters
newSource:Object

the new source of the copied event

newTarget:EventTarget

the new target of the copied event

type:EventType<RotateEvent>

the new eventType

Returns:RotateEvent

the event copy with the fields substituted

Since
JavaFX 8.0
getAngleback to summary
public double getAngle()

Gets the rotation angle of this event. The angle is in degrees and work well when added to the node's rotate property value (positive values for clockwise rotation).

Returns:double

The rotation angle of this event

getEventTypeback to summary
public EventType<RotateEvent> getEventType()

Overrides javafx.scene.input.GestureEvent.getEventType.

Doc from javafx.event.Event.getEventType.

Gets the event type of this event. Objects of the same Event class can have different event types. These event types further specify what kind of event occurred.

Annotations
@Override
getTotalAngleback to summary
public double getTotalAngle()

Gets the cumulative rotation angle of this gesture. The angle is in degrees and work well when added to the node's rotate property value (positive values for clockwise rotation).

Returns:double

The cumulative rotation angle of this gesture

toStringback to summary
public String toString()

Overrides javafx.scene.input.GestureEvent.toString.

Returns a string representation of this RotateEvent object.

Returns:String

a string representation of this RotateEvent object.

Annotations
@Override