DSTEngine/hGameTest/node_modules/openfl/docs/classes/openfl.ui.multitouch.html
2025-01-15 19:42:35 +01:00

422 lines
22 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Multitouch | openfl</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">openfl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">openfl</a>
</li>
<li>
<a href="../modules/openfl.ui.html">ui</a>
</li>
<li>
<a href="openfl.ui.multitouch.html">Multitouch</a>
</li>
</ul>
<h1>Class Multitouch</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Multitouch class manages and provides information about the current
environment&#39;s support for handling contact from user input devices,
including contact that has two or more touch points(such as a user&#39;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 &quot;touch point&quot; 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:</p>
</div>
<ul>
<li>flash.events.TouchEvent</li>
<li>flash.events.GestureEvent</li>
<li>flash.events.GesturePhase</li>
<li>flash.events.TransformGestureEvent</li>
<li>flash.events.PressAndTapGestureEvent</li>
</ul>
<p>Use the listed classes to write code that handles touch events. Use the
Multitouch class to determine the current environment&#39;s support for touch
interaction, and to manage the support of touch interaction if the current
environment supports touch input.</p>
<p>You cannot create a Multitouch object directly from ActionScript code.
If you call <code>new Multitouch()</code>, an exception is thrown.</p>
<p><strong>Note:</strong> The Multitouch feature is not supported for SWF files
embedded in HTML running on Mac OS.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Multitouch</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.ui.multitouch.html#inputmode" class="tsd-kind-icon">input<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.ui.multitouch.html#maxtouchpoints" class="tsd-kind-icon">max<wbr>Touch<wbr>Points</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.ui.multitouch.html#supportedgestures" class="tsd-kind-icon">supported<wbr>Gestures</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.ui.multitouch.html#supportsgestureevents" class="tsd-kind-icon">supports<wbr>Gesture<wbr>Events</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="openfl.ui.multitouch.html#supportstouchevents" class="tsd-kind-icon">supports<wbr>Touch<wbr>Events</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="inputmode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> input<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">input<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/openfl.ui.multitouchinputmode.html" class="tsd-signature-type">MultitouchInputMode</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/ui/Multitouch.d.ts#L60">lib/openfl/ui/Multitouch.d.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>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 flash.ui.MultitouchInputMode class.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>gesture</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="maxtouchpoints" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> max<wbr>Touch<wbr>Points</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Touch<wbr>Points<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/ui/Multitouch.d.ts#L70">lib/openfl/ui/Multitouch.d.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The maximum number of concurrent touch points supported by the current
environment.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="supportedgestures" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> supported<wbr>Gestures</h3>
<div class="tsd-signature tsd-kind-icon">supported<wbr>Gestures<span class="tsd-signature-symbol">:</span> <a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">String</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/ui/Multitouch.d.ts#L92">lib/openfl/ui/Multitouch.d.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>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 <code>GESTURE_PAN</code>).</p>
</div>
<p>If the Flash runtime is in an environment that does not support any
multi-touch gestures, the value is <code>null</code>.</p>
<p><strong>Note:</strong> For Mac OS 10.5.3 and later,
<code>Multitouch.supportedGestures</code> returns non-null values
(possibly indicating incorrectly that gesture events are supported) even
if the current hardware does not support gesture input.</p>
<p>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&#39;ll need to create
alternative event handling.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="supportsgestureevents" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> supports<wbr>Gesture<wbr>Events</h3>
<div class="tsd-signature tsd-kind-icon">supports<wbr>Gesture<wbr>Events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/ui/Multitouch.d.ts#L105">lib/openfl/ui/Multitouch.d.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>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.</p>
</div>
<p><strong>Note:</strong> For Mac OS 10.5.3 and later, this value is always
<code>true</code>. <code>Multitouch.supportsGestureEvent</code> returns
<code>true</code> even if the hardware does not support gesture
events.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="supportstouchevents" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> supports<wbr>Touch<wbr>Events</h3>
<div class="tsd-signature tsd-kind-icon">supports<wbr>Touch<wbr>Events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/ui/Multitouch.d.ts#L111">lib/openfl/ui/Multitouch.d.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates whether the current environment supports basic touch input, such
as a single finger tap. Touch events are listed in the TouchEvent class.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="label tsd-is-external">
<span>Externals</span>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.desktop.html">openfl.desktop</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.display.html">openfl.display</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.errors.html">openfl.errors</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.events.html">openfl.events</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.external.html">openfl.external</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.filters.html">openfl.filters</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.geom.html">openfl.geom</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.media.html">openfl.media</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.net.html">openfl.net</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.system.html">openfl.system</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.text.html">openfl.text</a>
</li>
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.ui.html">openfl.ui</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.utils.html">openfl.utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external">
<a href="../enums/openfl.ui.keylocation.html" class="tsd-kind-icon">Key<wbr>Location</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external">
<a href="../enums/openfl.ui.mousecursor.html" class="tsd-kind-icon">Mouse<wbr>Cursor</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external">
<a href="../enums/openfl.ui.multitouchinputmode.html" class="tsd-kind-icon">Multitouch<wbr>Input<wbr>Mode</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.ui.gameinput.html" class="tsd-kind-icon">Game<wbr>Input</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.ui.gameinputcontrol.html" class="tsd-kind-icon">Game<wbr>Input<wbr>Control</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.ui.gameinputdevice.html" class="tsd-kind-icon">Game<wbr>Input<wbr>Device</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.ui.keyboard.html" class="tsd-kind-icon">Keyboard</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.ui.mouse.html" class="tsd-kind-icon">Mouse</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.ui.multitouch.html" class="tsd-kind-icon">Multitouch</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="openfl.ui.multitouch.html#inputmode" class="tsd-kind-icon">input<wbr>Mode</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="openfl.ui.multitouch.html#maxtouchpoints" class="tsd-kind-icon">max<wbr>Touch<wbr>Points</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="openfl.ui.multitouch.html#supportedgestures" class="tsd-kind-icon">supported<wbr>Gestures</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="openfl.ui.multitouch.html#supportsgestureevents" class="tsd-kind-icon">supports<wbr>Gesture<wbr>Events</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="openfl.ui.multitouch.html#supportstouchevents" class="tsd-kind-icon">supports<wbr>Touch<wbr>Events</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>