public final class ZoomEvent extends GestureEvent
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: zoomFactor
is the zooming amount
of this event, totalZoomFactor
is the zooming amount of the whole
gesture. The values work well when multiplied with the node's scale
properties (values greater than 1
for zooming in).
As all gestures, zooming 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 ZOOM
events are surounded by ZOOM_STARTED
and ZOOM_FINISHED
events. If zooming inertia is active on the
given platform, some ZOOM
events with isInertia()
returning
true
can come after ZOOM_FINISHED
.
Modifier and Type | Field and Description |
---|---|
static EventType<ZoomEvent> |
ANY
Common supertype for all zoom event types.
|
static EventType<ZoomEvent> |
ZOOM
This event occurs when user performs a zooming gesture such as
dragging two fingers apart.
|
static EventType<ZoomEvent> |
ZOOM_FINISHED
This event occurs when a zooming gesture ends.
|
static EventType<ZoomEvent> |
ZOOM_STARTED
This event occurs when a zooming gesture is detected.
|
consumed, eventType, NULL_SOURCE_TARGET, target
source
Constructor and Description |
---|
ZoomEvent(EventType<ZoomEvent> eventType,
double x,
double y,
double screenX,
double screenY,
boolean shiftDown,
boolean controlDown,
boolean altDown,
boolean metaDown,
boolean direct,
boolean inertia,
double zoomFactor,
double totalZoomFactor,
PickResult pickResult)
Constructs new ZoomEvent event with null source and target.
|
ZoomEvent(Object source,
EventTarget target,
EventType<ZoomEvent> eventType,
double x,
double y,
double screenX,
double screenY,
boolean shiftDown,
boolean controlDown,
boolean altDown,
boolean metaDown,
boolean direct,
boolean inertia,
double zoomFactor,
double totalZoomFactor,
PickResult pickResult)
Constructs new ZoomEvent event.
|
Modifier and Type | Method and Description |
---|---|
ZoomEvent |
copyFor(Object newSource,
EventTarget newTarget)
Creates and returns a copy of this event with the specified event source
and target.
|
ZoomEvent |
copyFor(Object newSource,
EventTarget newTarget,
EventType<ZoomEvent> type)
Creates a copy of the given event with the given fields substituted.
|
EventType<ZoomEvent> |
getEventType()
Gets the event type of this event.
|
double |
getTotalZoomFactor()
Gets the zooming amount of this gesture.
|
double |
getZoomFactor()
Gets the zooming amount of this event.
|
String |
toString()
Returns a string representation of this
ZoomEvent object. |
getPickResult, getSceneX, getSceneY, getScreenX, getScreenY, getX, getY, getZ, isAltDown, isControlDown, isDirect, isInertia, isMetaDown, isShiftDown, isShortcutDown
getSource
public static final EventType<ZoomEvent> ZOOM
public static final EventType<ZoomEvent> ZOOM_STARTED
public ZoomEvent(Object source, EventTarget target, EventType<ZoomEvent> eventType, double x, double y, double screenX, double screenY, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean direct, boolean inertia, double zoomFactor, double totalZoomFactor, PickResult pickResult)
source
- the source of the event. Can be null.target
- the target of the event. Can be null.eventType
- The type of the event.x
- The x with respect to the scene.y
- The y with respect to the scene.screenX
- The x coordinate relative to screen.screenY
- The y coordinate relative to screen.shiftDown
- true if shift modifier was pressed.controlDown
- true if control modifier was pressed.altDown
- true if alt modifier was pressed.metaDown
- true if meta modifier was pressed.direct
- true if the event was caused by direct input device. See GestureEvent.isDirect()
touchCount
- number of touch pointsinertia
- if represents inertia of an already finished gesture.zoomFactor
- zoom amounttotalZoomFactor
- cumulative zoom amountpickResult
- 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 targetpublic ZoomEvent(EventType<ZoomEvent> eventType, double x, double y, double screenX, double screenY, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean direct, boolean inertia, double zoomFactor, double totalZoomFactor, PickResult pickResult)
eventType
- The type of the event.x
- The x with respect to the scene.y
- The y with respect to the scene.screenX
- The x coordinate relative to screen.screenY
- The y coordinate relative to screen.shiftDown
- true if shift modifier was pressed.controlDown
- true if control modifier was pressed.altDown
- true if alt modifier was pressed.metaDown
- true if meta modifier was pressed.direct
- true if the event was caused by direct input device. See GestureEvent.isDirect()
touchCount
- number of touch pointsinertia
- if represents inertia of an already finished gesture.zoomFactor
- zoom amounttotalZoomFactor
- cumulative zoom amountpickResult
- pick result. Can be null, in this case a 2D pick result
without any further values is constructed
based on the scene coordinatespublic double getZoomFactor()
scale
properties (values greater
than 1
for zooming in, values between 0
and 1
for zooming out).public double getTotalZoomFactor()
scale
properties (values greater
than 1
for zooming in, values between 0
and 1
for zooming out).public String toString()
ZoomEvent
object.toString
in class GestureEvent
ZoomEvent
object.public ZoomEvent copyFor(Object newSource, EventTarget newTarget)
Event
null
, it is
replaced by the NULL_SOURCE_TARGET
value.copyFor
in class GestureEvent
newSource
- the new source of the copied eventnewTarget
- the new target of the copied eventpublic ZoomEvent copyFor(Object newSource, EventTarget newTarget, EventType<ZoomEvent> type)
source
- the new source of the copied eventtarget
- the new target of the copied eventeventType
- the new eventTypepublic EventType<ZoomEvent> getEventType()
Event
Event
class can have different event types. These event types further specify
what kind of event occurred.getEventType
in class GestureEvent
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.