starling-framework

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>TouchProcessor | starling-framework</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">starling-framework</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">starling</a> </li> <li> <a href="../modules/starling.events.html">events</a> </li> <li> <a href="starling.events.touchprocessor.html">TouchProcessor</a> </li> </ul> <h1>Class TouchProcessor</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 TouchProcessor is used to convert mouse and touch events of the conventional Flash stage to Starling's TouchEvents.</p> </div> <p>The Starling instance listens to mouse and touch events on the native stage. The attributes of those events are enqueued (right as they are happening) in the TouchProcessor.</p> <p>Once per frame, the "advanceTime" method is called. It analyzes the touch queue and figures out which touches are active at that moment; the properties of all touch objects are updated accordingly.</p> <p>Once the list of touches has been finalized, the "processTouches" method is called (that might happen several times in one "advanceTime" execution; no information is discarded). It's responsible for dispatching the actual touch events to the Starling display tree.</p> <p> <strong>Subclassing TouchProcessor</strong></p> <p>You can extend the TouchProcessor if you need to have more control over touch and mouse input. For example, you could filter the touches by overriding the "processTouches" method, throwing away any touches you're not interested in and passing the rest to the super implementation.</p> <p>To use your custom TouchProcessor, assign it to the "Starling.touchProcessor" property.</p> <p>Note that you should not dispatch TouchEvents yourself, since they are much more complex to handle than conventional events (e.g. it must be made sure that an object receives a TouchEvent only once, even if it's manipulated with several fingers). Always use the base implementation of "processTouches" to let them be dispatched. That said: you can always dispatch your own custom events, of course.</p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">TouchProcessor</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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <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-external"><a href="starling.events.touchprocessor.html#multitapdistance" class="tsd-kind-icon">multitap<wbr>Distance</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#multitaptime" class="tsd-kind-icon">multitap<wbr>Time</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#numcurrenttouches" class="tsd-kind-icon">num<wbr>Current<wbr>Touches</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#root" class="tsd-kind-icon">root</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#simulatemultitouch" class="tsd-kind-icon">simulate<wbr>Multitouch</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#stage" class="tsd-kind-icon">stage</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#advancetime" class="tsd-kind-icon">advance<wbr>Time</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#canceltouches" class="tsd-kind-icon">cancel<wbr>Touches</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#dispose" class="tsd-kind-icon">dispose</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#enqueue" class="tsd-kind-icon">enqueue</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.events.touchprocessor.html#enqueuemouseleftstage" class="tsd-kind-icon">enqueue<wbr>Mouse<wbr>Left<wbr>Stage</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#get_multitapdistance" class="tsd-kind-icon">get_<wbr>multitap<wbr>Distance</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#get_multitaptime" class="tsd-kind-icon">get_<wbr>multitap<wbr>Time</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#get_numcurrenttouches" class="tsd-kind-icon">get_<wbr>num<wbr>Current<wbr>Touches</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#get_root" class="tsd-kind-icon">get_<wbr>root</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#get_simulatemultitouch" class="tsd-kind-icon">get_<wbr>simulate<wbr>Multitouch</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#get_stage" class="tsd-kind-icon">get_<wbr>stage</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#set_multitapdistance" class="tsd-kind-icon">set_<wbr>multitap<wbr>Distance</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#set_multitaptime" class="tsd-kind-icon">set_<wbr>multitap<wbr>Time</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#set_root" class="tsd-kind-icon">set_<wbr>root</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.events.touchprocessor.html#set_simulatemultitouch" class="tsd-kind-icon">set_<wbr>simulate<wbr>Multitouch</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">new <wbr>Touch<wbr>Processor<span class="tsd-signature-symbol">(</span>stage<span class="tsd-signature-symbol">: </span><a href="starling.display.stage.html" class="tsd-signature-type">Stage</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.events.touchprocessor.html" class="tsd-signature-type">TouchProcessor</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L47">lib/starling/events/TouchProcessor.d.ts:47</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates a new TouchProcessor that will dispatch events to the given stage.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>stage: <a href="starling.display.stage.html" class="tsd-signature-type">Stage</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="starling.events.touchprocessor.html" class="tsd-signature-type">TouchProcessor</a></h4> </li> </ul> </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-external"> <a name="multitapdistance" class="tsd-anchor"></a> <h3>multitap<wbr>Distance</h3> <div class="tsd-signature tsd-kind-icon">multitap<wbr>Distance<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/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L91">lib/starling/events/TouchProcessor.d.ts:91</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The distance (in points) describing how close two touches must be to each other to be recognized as a multitap gesture.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="multitaptime" class="tsd-anchor"></a> <h3>multitap<wbr>Time</h3> <div class="tsd-signature tsd-kind-icon">multitap<wbr>Time<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/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L85">lib/starling/events/TouchProcessor.d.ts:85</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The time period (in seconds) in which two touches must occur to be recognized as a multitap gesture.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="numcurrenttouches" class="tsd-anchor"></a> <h3>num<wbr>Current<wbr>Touches</h3> <div class="tsd-signature tsd-kind-icon">num<wbr>Current<wbr>Touches<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/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L107">lib/starling/events/TouchProcessor.d.ts:107</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the number of fingers / touch points that are currently on the stage.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="root" class="tsd-anchor"></a> <h3>root</h3> <div class="tsd-signature tsd-kind-icon">root<span class="tsd-signature-symbol">:</span> <a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L98">lib/starling/events/TouchProcessor.d.ts:98</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The base object that will be used for hit testing. Per default, this reference points to the stage; however, you can limit touch processing to certain parts of your game by assigning a different object.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="simulatemultitouch" class="tsd-anchor"></a> <h3>simulate<wbr>Multitouch</h3> <div class="tsd-signature tsd-kind-icon">simulate<wbr>Multitouch<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/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L79">lib/starling/events/TouchProcessor.d.ts:79</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Indicates if it multitouch simulation should be activated. When the user presses ctrl/cmd (and optionally shift), he'll see a second touch curser that mimics the first. That's an easy way to develop and test multitouch when there's only a mouse available.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="stage" class="tsd-anchor"></a> <h3>stage</h3> <div class="tsd-signature tsd-kind-icon">stage<span class="tsd-signature-symbol">:</span> <a href="starling.display.stage.html" class="tsd-signature-type">Stage</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L103">lib/starling/events/TouchProcessor.d.ts:103</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The stage object to which the touch objects are (per default) dispatched.</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="advancetime" class="tsd-anchor"></a> <h3>advance<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">advance<wbr>Time<span class="tsd-signature-symbol">(</span>passedTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L56">lib/starling/events/TouchProcessor.d.ts:56</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Analyzes the current touch queue and processes the list of current touches, emptying the queue while doing so. This method is called by Starling once per frame.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>passedTime: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="canceltouches" class="tsd-anchor"></a> <h3>cancel<wbr>Touches</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">cancel<wbr>Touches<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L73">lib/starling/events/TouchProcessor.d.ts:73</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Force-end all current touches. Changes the phase of all touches to 'ENDED' and immediately dispatches a new TouchEvent (if touches are present). Called automatically when the app receives a 'DEACTIVATE' event.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="dispose" class="tsd-anchor"></a> <h3>dispose</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L52">lib/starling/events/TouchProcessor.d.ts:52</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Removes all event handlers on the stage and releases any acquired resources.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="enqueue" class="tsd-anchor"></a> <h3>enqueue</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">enqueue<span class="tsd-signature-symbol">(</span>touchID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, phase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, globalX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, globalY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, pressure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L59">lib/starling/events/TouchProcessor.d.ts:59</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enqueues a new touch our mouse event with the given properties.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>touchID: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>phase: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>globalX: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>globalY: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pressure: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> width: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> height: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="enqueuemouseleftstage" class="tsd-anchor"></a> <h3>enqueue<wbr>Mouse<wbr>Left<wbr>Stage</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">enqueue<wbr>Mouse<wbr>Left<wbr>Stage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L68">lib/starling/events/TouchProcessor.d.ts:68</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enqueues an artificial touch that represents the mouse leaving the stage.</p> </div> <p>On OS X, we get mouse events from outside the stage; on Windows, we do not. This method enqueues an artificial hover point that is just outside the stage. That way, objects listening for HOVERs over them will get notified everywhere.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="get_multitapdistance" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>multitap<wbr>Distance</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get_<wbr>multitap<wbr>Distance<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L92">lib/starling/events/TouchProcessor.d.ts:92</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="get_multitaptime" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>multitap<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get_<wbr>multitap<wbr>Time<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L86">lib/starling/events/TouchProcessor.d.ts:86</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="get_numcurrenttouches" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>num<wbr>Current<wbr>Touches</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get_<wbr>num<wbr>Current<wbr>Touches<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L108">lib/starling/events/TouchProcessor.d.ts:108</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="get_root" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>root</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get_<wbr>root<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L99">lib/starling/events/TouchProcessor.d.ts:99</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="get_simulatemultitouch" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>simulate<wbr>Multitouch</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get_<wbr>simulate<wbr>Multitouch<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L80">lib/starling/events/TouchProcessor.d.ts:80</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="get_stage" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>stage</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get_<wbr>stage<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.display.stage.html" class="tsd-signature-type">Stage</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L104">lib/starling/events/TouchProcessor.d.ts:104</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="starling.display.stage.html" class="tsd-signature-type">Stage</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="set_multitapdistance" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> set_<wbr>multitap<wbr>Distance</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">set_<wbr>multitap<wbr>Distance<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L93">lib/starling/events/TouchProcessor.d.ts:93</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="set_multitaptime" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> set_<wbr>multitap<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">set_<wbr>multitap<wbr>Time<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L87">lib/starling/events/TouchProcessor.d.ts:87</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="set_root" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> set_<wbr>root</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">set_<wbr>root<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L100">lib/starling/events/TouchProcessor.d.ts:100</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="set_simulatemultitouch" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> set_<wbr>simulate<wbr>Multitouch</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">set_<wbr>simulate<wbr>Multitouch<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/TouchProcessor.d.ts#L81">lib/starling/events/TouchProcessor.d.ts:81</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">boolean</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </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/starling.animation.html">starling.animation</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.assets.html">starling.assets</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.core.html">starling.core</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.display.html">starling.display</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.errors.html">starling.errors</a> </li> <li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.events.html">starling.events</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.extensions.html">starling.extensions</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.filters.html">starling.filters</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.geom.html">starling.geom</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.rendering.html">starling.rendering</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.styles.html">starling.styles</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.text.html">starling.text</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.textures.html">starling.textures</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.utils.html">starling.utils</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.enterframeevent.html" class="tsd-kind-icon">Enter<wbr>Frame<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.event.html" class="tsd-kind-icon">Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.keyboardevent.html" class="tsd-kind-icon">Keyboard<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.resizeevent.html" class="tsd-kind-icon">Resize<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.touch.html" class="tsd-kind-icon">Touch</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.touchdata.html" class="tsd-kind-icon">Touch<wbr>Data</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.touchevent.html" class="tsd-kind-icon">Touch<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.touchmarker.html" class="tsd-kind-icon">Touch<wbr>Marker</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.touchphase.html" class="tsd-kind-icon">Touch<wbr>Phase</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.events.touchprocessor.html" class="tsd-kind-icon">Touch<wbr>Processor</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#multitapdistance" class="tsd-kind-icon">multitap<wbr>Distance</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#multitaptime" class="tsd-kind-icon">multitap<wbr>Time</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#numcurrenttouches" class="tsd-kind-icon">num<wbr>Current<wbr>Touches</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#root" class="tsd-kind-icon">root</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#simulatemultitouch" class="tsd-kind-icon">simulate<wbr>Multitouch</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#stage" class="tsd-kind-icon">stage</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#advancetime" class="tsd-kind-icon">advance<wbr>Time</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#canceltouches" class="tsd-kind-icon">cancel<wbr>Touches</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#dispose" class="tsd-kind-icon">dispose</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#enqueue" class="tsd-kind-icon">enqueue</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.events.touchprocessor.html#enqueuemouseleftstage" class="tsd-kind-icon">enqueue<wbr>Mouse<wbr>Left<wbr>Stage</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#get_multitapdistance" class="tsd-kind-icon">get_<wbr>multitap<wbr>Distance</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#get_multitaptime" class="tsd-kind-icon">get_<wbr>multitap<wbr>Time</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#get_numcurrenttouches" class="tsd-kind-icon">get_<wbr>num<wbr>Current<wbr>Touches</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#get_root" class="tsd-kind-icon">get_<wbr>root</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#get_simulatemultitouch" class="tsd-kind-icon">get_<wbr>simulate<wbr>Multitouch</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#get_stage" class="tsd-kind-icon">get_<wbr>stage</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#set_multitapdistance" class="tsd-kind-icon">set_<wbr>multitap<wbr>Distance</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#set_multitaptime" class="tsd-kind-icon">set_<wbr>multitap<wbr>Time</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#set_root" class="tsd-kind-icon">set_<wbr>root</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.events.touchprocessor.html#set_simulatemultitouch" class="tsd-kind-icon">set_<wbr>simulate<wbr>Multitouch</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-