The Multitouch class manages and provides information about the current environment's support for handling contact from user input devices, including contact that has two or more touch points (such as a user's fingers on a touch screen). When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically touches the screen with his or her fingers or a pointing device. While there is a broad range of pointing devices, such as a mouse or a stylus, many of these devices only have a single point of contact with an application. For pointing devices with a single point of contact, user interaction events can be handled as a mouse event, or using a basic set of touch events (called "touch point" events). However, for pointing devices that have several points of contact and perform complex movement, such as the human hand, Flash runtimes support an additional set of event handling API called gesture events. The API for handling user interaction with these gesture events includes the following classes:
- openfl.events.TouchEvent
- openfl.events.GestureEvent
- openfl.events.GesturePhase
- openfl.events.TransformGestureEvent
- openfl.events.PressAndTapGestureEvent
Use the listed classes to write code that handles touch events. Use the Multitouch class to determine the current environment's support for touch interaction, and to manage the support of touch interaction if the current environment supports touch input.
You cannot create a Multitouch object directly from Haxe code.
If you call new Multitouch(), an exception is thrown.
Note: The Multitouch feature is not supported for SWF files embedded in HTML running on Mac OS.
Static variables
staticinputMode:MultitouchInputMode
Identifies the multi-touch mode for touch and gesture event handling. Use this property to manage whether or not events are dispatched as touch events with multiple points of contact and specific events for different gestures(such as rotation and pan), or only a single point of contact (such as tap), or none at all (contact is handled as a mouse event). To set this property, use values from the openfl.ui.MultitouchInputMode class.
staticread onlymaxTouchPoints:Int
The maximum number of concurrent touch points supported by the current environment.
staticread onlysupportedGestures:Vector<String>
A Vector array (a typed array of string values) of multi-touch contact
types supported in the current environment. The array of strings can be
used as event types to register event listeners. Possible values are
constants from the GestureEvent, PressAndTapGestureEvent, and
TransformGestureEvent classes (such as GESTURE_PAN).
If the Flash runtime is in an environment that does not support any
multi-touch gestures, the value is null.
Note: For Mac OS 10.5.3 and later,
Multitouch.supportedGestures returns non-null values
(possibly indicating incorrectly that gesture events are supported) even
if the current hardware does not support gesture input.
Use this property to test for multi-touch gesture support. Then, use event handlers for the available multi-touch gestures. For those gestures that are not supported in the current evironment, you'll need to create alternative event handling.
staticread onlysupportsGestureEvents:Bool
Indicates whether the current environment supports gesture input, such as rotating two fingers around a touch screen. Gesture events are listed in the TransformGestureEvent, PressAndTapGestureEvent, and GestureEvent classes.
Note: For Mac OS 10.5.3 and later, this value is always
true. Multitouch.supportsGestureEvent returns
true even if the hardware does not support gesture
events.
staticread onlysupportsTouchEvents:Bool
Indicates whether the current environment supports basic touch input, such as a single finger tap. Touch events are listed in the TouchEvent class.