Files
esengine/source/docs/classes/_utils_input_virtual_virtualinput_.es.virtualinput.html
2020-11-20 14:07:34 +08:00

256 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>VirtualInput | @esengine/egret-framework</title>
<meta name="description" content="Documentation for @esengine/egret-framework">
<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.json" 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">@esengine/egret-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="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_utils_input_virtual_virtualinput_.html">&quot;Utils/Input/Virtual/VirtualInput&quot;</a>
</li>
<li>
<a href="../modules/_utils_input_virtual_virtualinput_.es.html">es</a>
</li>
<li>
<a href="_utils_input_virtual_virtualinput_.es.virtualinput.html">VirtualInput</a>
</li>
</ul>
<h1>Class VirtualInput</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>虚拟按钮其状态由其VirtualInputNodes的状态决定</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">VirtualInput</span>
<ul class="tsd-hierarchy">
<li>
<a href="_utils_input_virtual_virtualintegeraxis_.es.virtualintegeraxis.html" class="tsd-signature-type">VirtualIntegerAxis</a>
</li>
<li>
<a href="_utils_input_virtual_virtualaxis_.es.virtualaxis.html" class="tsd-signature-type">VirtualAxis</a>
</li>
<li>
<a href="_utils_input_virtual_virtualbutton_.es.virtualbutton.html" class="tsd-signature-type">VirtualButton</a>
</li>
</ul>
</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-private-protected">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-protected"><a href="_utils_input_virtual_virtualinput_.es.virtualinput.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_input_virtual_virtualinput_.es.virtualinput.html#deregister" class="tsd-kind-icon">deregister</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_utils_input_virtual_virtualinput_.es.virtualinput.html#update" class="tsd-kind-icon">update</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
<a name="constructor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">new <wbr>Virtual<wbr>Input<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_utils_input_virtual_virtualinput_.es.virtualinput.html" class="tsd-signature-type">VirtualInput</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Utils/Input/Virtual/VirtualInput.ts#L21">src/Utils/Input/Virtual/VirtualInput.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_utils_input_virtual_virtualinput_.es.virtualinput.html" class="tsd-signature-type">VirtualInput</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deregister" class="tsd-anchor"></a>
<h3>deregister</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">deregister<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/esengine/egret-framework/blob/562bacb/source/src/Utils/Input/Virtual/VirtualInput.ts#L29">src/Utils/Input/Virtual/VirtualInput.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>从输入系统取消虚拟输入的注册。在轮询VirtualInput之后调用这个函数</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">
<a name="update" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> update</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Utils/Input/Virtual/VirtualInput.ts#L33">src/Utils/Input/Virtual/VirtualInput.ts:33</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_utils_input_virtual_virtualinput_.html">&quot;<wbr>Utils/<wbr>Input/<wbr>Virtual/<wbr>Virtual<wbr>Input&quot;</a>
<ul>
<li class="current tsd-kind-namespace tsd-parent-kind-module">
<a href="../modules/_utils_input_virtual_virtualinput_.es.html">es</a>
</li>
</ul>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/_utils_input_virtual_virtualinput_.es.overlapbehavior.html" class="tsd-kind-icon">Overlap<wbr>Behavior</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="_utils_input_virtual_virtualinput_.es.virtualinput.html" class="tsd-kind-icon">Virtual<wbr>Input</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-protected">
<a href="_utils_input_virtual_virtualinput_.es.virtualinput.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_input_virtual_virtualinput_.es.virtualinput.html#deregister" class="tsd-kind-icon">deregister</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_utils_input_virtual_virtualinput_.es.virtualinput.html#update" class="tsd-kind-icon">update</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="_utils_input_virtual_virtualinput_.es.virtualinputnode.html" class="tsd-kind-icon">Virtual<wbr>Input<wbr>Node</a>
</li>
</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://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>