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

354 lines
20 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>ColliderTriggerHelper | @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/_physics_collidertriggerhelper_.html">&quot;Physics/ColliderTriggerHelper&quot;</a>
</li>
<li>
<a href="../modules/_physics_collidertriggerhelper_.es.html">es</a>
</li>
<li>
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html">ColliderTriggerHelper</a>
</li>
</ul>
<h1>Class ColliderTriggerHelper</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>移动器使用的帮助器类用于管理触发器碰撞器交互并调用itriggerlistener</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ColliderTriggerHelper</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 ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#_activetriggerintersections" class="tsd-kind-icon">_active<wbr>Trigger<wbr>Intersections</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#_entity" class="tsd-kind-icon">_entity</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#_previoustriggerintersections" class="tsd-kind-icon">_previous<wbr>Trigger<wbr>Intersections</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#_temptriggerlist" class="tsd-kind-icon">_temp<wbr>Trigger<wbr>List</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 tsd-is-private"><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#checkforexitedcolliders" class="tsd-kind-icon">check<wbr>For<wbr>Exited<wbr>Colliders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#notifytriggerlisteners" class="tsd-kind-icon">notify<wbr>Trigger<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#update" class="tsd-kind-icon">update</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Collider<wbr>Trigger<wbr>Helper<span class="tsd-signature-symbol">(</span>entity<span class="tsd-signature-symbol">: </span><a href="_ecs_entity_.es.entity.html" class="tsd-signature-type">Entity</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html" class="tsd-signature-type">ColliderTriggerHelper</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/Physics/ColliderTriggerHelper.ts#L11">src/Physics/ColliderTriggerHelper.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>entity: <a href="_ecs_entity_.es.entity.html" class="tsd-signature-type">Entity</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html" class="tsd-signature-type">ColliderTriggerHelper</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_activetriggerintersections" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _active<wbr>Trigger<wbr>Intersections</h3>
<div class="tsd-signature tsd-kind-icon">_active<wbr>Trigger<wbr>Intersections<span class="tsd-signature-symbol">:</span> <a href="_utils_pair_.es.pair.html" class="tsd-signature-type">Pair</a><span class="tsd-signature-symbol">&lt;</span><a href="_ecs_components_physics_colliders_collider_.es.collider.html" class="tsd-signature-type">Collider</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/ColliderTriggerHelper.ts#L8">src/Physics/ColliderTriggerHelper.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>存储当前帧中发生的所有活动交集对</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_entity" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _entity</h3>
<div class="tsd-signature tsd-kind-icon">_entity<span class="tsd-signature-symbol">:</span> <a href="_ecs_entity_.es.entity.html" class="tsd-signature-type">Entity</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/ColliderTriggerHelper.ts#L6">src/Physics/ColliderTriggerHelper.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_previoustriggerintersections" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _previous<wbr>Trigger<wbr>Intersections</h3>
<div class="tsd-signature tsd-kind-icon">_previous<wbr>Trigger<wbr>Intersections<span class="tsd-signature-symbol">:</span> <a href="_utils_pair_.es.pair.html" class="tsd-signature-type">Pair</a><span class="tsd-signature-symbol">&lt;</span><a href="_ecs_components_physics_colliders_collider_.es.collider.html" class="tsd-signature-type">Collider</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/ColliderTriggerHelper.ts#L10">src/Physics/ColliderTriggerHelper.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>存储前一帧的交叉对,以便我们可以在移动该帧后检测出口</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_temptriggerlist" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _temp<wbr>Trigger<wbr>List</h3>
<div class="tsd-signature tsd-kind-icon">_temp<wbr>Trigger<wbr>List<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_ecs_components_physics_itriggerlistener_.es.itriggerlistener.html" class="tsd-signature-type">ITriggerListener</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/ColliderTriggerHelper.ts#L11">src/Physics/ColliderTriggerHelper.ts:11</a></li>
</ul>
</aside>
</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 tsd-is-private">
<a name="checkforexitedcolliders" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr>For<wbr>Exited<wbr>Colliders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">check<wbr>For<wbr>Exited<wbr>Colliders<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/Physics/ColliderTriggerHelper.ts#L53">src/Physics/ColliderTriggerHelper.ts:53</a></li>
</ul>
</aside>
<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-private">
<a name="notifytriggerlisteners" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> notify<wbr>Trigger<wbr>Listeners</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">notify<wbr>Trigger<wbr>Listeners<span class="tsd-signature-symbol">(</span>collisionPair<span class="tsd-signature-symbol">: </span><a href="_utils_pair_.es.pair.html" class="tsd-signature-type">Pair</a><span class="tsd-signature-symbol">&lt;</span><a href="_ecs_components_physics_colliders_collider_.es.collider.html" class="tsd-signature-type">Collider</a><span class="tsd-signature-symbol">&gt;</span>, isEntering<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">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/Physics/ColliderTriggerHelper.ts#L77">src/Physics/ColliderTriggerHelper.ts:77</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>collisionPair: <a href="_utils_pair_.es.pair.html" class="tsd-signature-type">Pair</a><span class="tsd-signature-symbol">&lt;</span><a href="_ecs_components_physics_colliders_collider_.es.collider.html" class="tsd-signature-type">Collider</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>isEntering: <span class="tsd-signature-type">boolean</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">
<a name="update" class="tsd-anchor"></a>
<h3>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">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/Physics/ColliderTriggerHelper.ts#L20">src/Physics/ColliderTriggerHelper.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>实体被移动后应该调用更新。它会处理碰撞器重叠的任何itriggerlistener。</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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/_physics_collidertriggerhelper_.html">&quot;<wbr>Physics/<wbr>Collider<wbr>Trigger<wbr>Helper&quot;</a>
<ul>
<li class="current tsd-kind-namespace tsd-parent-kind-module">
<a href="../modules/_physics_collidertriggerhelper_.es.html">es</a>
</li>
</ul>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html" class="tsd-kind-icon">Collider<wbr>Trigger<wbr>Helper</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#_activetriggerintersections" class="tsd-kind-icon">_active<wbr>Trigger<wbr>Intersections</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#_entity" class="tsd-kind-icon">_entity</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#_previoustriggerintersections" class="tsd-kind-icon">_previous<wbr>Trigger<wbr>Intersections</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#_temptriggerlist" class="tsd-kind-icon">_temp<wbr>Trigger<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#checkforexitedcolliders" class="tsd-kind-icon">check<wbr>For<wbr>Exited<wbr>Colliders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#notifytriggerlisteners" class="tsd-kind-icon">notify<wbr>Trigger<wbr>Listeners</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_collidertriggerhelper_.es.collidertriggerhelper.html#update" class="tsd-kind-icon">update</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-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</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-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-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>
</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>