317 lines
15 KiB
HTML
317 lines
15 KiB
HTML
<!doctype html>
|
||
<html class="default no-js">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<title>CollisionResult | @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_shapes_collisionresult_.html">"Physics/Shapes/CollisionResult"</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/_physics_shapes_collisionresult_.es.html">es</a>
|
||
</li>
|
||
<li>
|
||
<a href="_physics_shapes_collisionresult_.es.collisionresult.html">CollisionResult</a>
|
||
</li>
|
||
</ul>
|
||
<h1>Class CollisionResult</h1>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="container container-main">
|
||
<div class="row">
|
||
<div class="col-8 col-content">
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h3>Hierarchy</h3>
|
||
<ul class="tsd-hierarchy">
|
||
<li>
|
||
<span class="target">CollisionResult</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>Properties</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_shapes_collisionresult_.es.collisionresult.html#collider" class="tsd-kind-icon">collider</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_shapes_collisionresult_.es.collisionresult.html#minimumtranslationvector" class="tsd-kind-icon">minimum<wbr>Translation<wbr>Vector</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_shapes_collisionresult_.es.collisionresult.html#normal" class="tsd-kind-icon">normal</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_shapes_collisionresult_.es.collisionresult.html#point" class="tsd-kind-icon">point</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="_physics_shapes_collisionresult_.es.collisionresult.html#invertresult" class="tsd-kind-icon">invert<wbr>Result</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_shapes_collisionresult_.es.collisionresult.html#removehorizontal" class="tsd-kind-icon">remove<wbr>Horizontal</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_shapes_collisionresult_.es.collisionresult.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
|
||
</ul>
|
||
</section>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Properties</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
<a name="collider" class="tsd-anchor"></a>
|
||
<h3>collider</h3>
|
||
<div class="tsd-signature tsd-kind-icon">collider<span class="tsd-signature-symbol">:</span> <a href="_ecs_components_physics_colliders_collider_.es.collider.html" class="tsd-signature-type">Collider</a></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/CollisionResult.ts#L6">src/Physics/Shapes/CollisionResult.ts:6</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">
|
||
<a name="minimumtranslationvector" class="tsd-anchor"></a>
|
||
<h3>minimum<wbr>Translation<wbr>Vector</h3>
|
||
<div class="tsd-signature tsd-kind-icon">minimum<wbr>Translation<wbr>Vector<span class="tsd-signature-symbol">:</span> <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a><span class="tsd-signature-symbol"> = Vector2.zero</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/CollisionResult.ts#L14">src/Physics/Shapes/CollisionResult.ts:14</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">
|
||
<a name="normal" class="tsd-anchor"></a>
|
||
<h3>normal</h3>
|
||
<div class="tsd-signature tsd-kind-icon">normal<span class="tsd-signature-symbol">:</span> <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a><span class="tsd-signature-symbol"> = Vector2.zero</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/CollisionResult.ts#L10">src/Physics/Shapes/CollisionResult.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">
|
||
<a name="point" class="tsd-anchor"></a>
|
||
<h3>point</h3>
|
||
<div class="tsd-signature tsd-kind-icon">point<span class="tsd-signature-symbol">:</span> <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a><span class="tsd-signature-symbol"> = Vector2.zero</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/CollisionResult.ts#L18">src/Physics/Shapes/CollisionResult.ts:18</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>不是所有冲突类型都使用!在依赖这个字段之前，请检查ShapeCollisions切割类!</p>
|
||
</div>
|
||
</div>
|
||
</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="invertresult" class="tsd-anchor"></a>
|
||
<h3>invert<wbr>Result</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-kind-icon">invert<wbr>Result<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</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/Shapes/CollisionResult.ts#L37">src/Physics/Shapes/CollisionResult.ts:37</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||
<a name="removehorizontal" class="tsd-anchor"></a>
|
||
<h3>remove<wbr>Horizontal</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-kind-icon">remove<wbr>Horizontal<span class="tsd-signature-symbol">(</span>deltaMovement<span class="tsd-signature-symbol">: </span><a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a><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/Shapes/CollisionResult.ts#L24">src/Physics/Shapes/CollisionResult.ts:24</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>改变最小平移向量，如果没有相同方向上的运动，它将移除平移的x分量。</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>deltaMovement: <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</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="tostring" class="tsd-anchor"></a>
|
||
<h3>to<wbr>String</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/Shapes/CollisionResult.ts#L43">src/Physics/Shapes/CollisionResult.ts:43</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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_shapes_collisionresult_.html">"<wbr>Physics/<wbr>Shapes/<wbr>Collision<wbr>Result"</a>
|
||
<ul>
|
||
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
||
<a href="../modules/_physics_shapes_collisionresult_.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_shapes_collisionresult_.es.collisionresult.html" class="tsd-kind-icon">Collision<wbr>Result</a>
|
||
<ul>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
<a href="_physics_shapes_collisionresult_.es.collisionresult.html#collider" class="tsd-kind-icon">collider</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
<a href="_physics_shapes_collisionresult_.es.collisionresult.html#minimumtranslationvector" class="tsd-kind-icon">minimum<wbr>Translation<wbr>Vector</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
<a href="_physics_shapes_collisionresult_.es.collisionresult.html#normal" class="tsd-kind-icon">normal</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
<a href="_physics_shapes_collisionresult_.es.collisionresult.html#point" class="tsd-kind-icon">point</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
<a href="_physics_shapes_collisionresult_.es.collisionresult.html#invertresult" class="tsd-kind-icon">invert<wbr>Result</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
<a href="_physics_shapes_collisionresult_.es.collisionresult.html#removehorizontal" class="tsd-kind-icon">remove<wbr>Horizontal</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||
<a href="_physics_shapes_collisionresult_.es.collisionresult.html#tostring" class="tsd-kind-icon">to<wbr>String</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-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>
|
||
</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-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> |