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

408 lines
21 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>Shape | @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_shape_.html">&quot;Physics/Shapes/Shape&quot;</a>
</li>
<li>
<a href="../modules/_physics_shapes_shape_.es.html">es</a>
</li>
<li>
<a href="_physics_shapes_shape_.es.shape.html">Shape</a>
</li>
</ul>
<h1>Class Shape</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">Shape</span>
<ul class="tsd-hierarchy">
<li>
<a href="_physics_shapes_polygon_.es.polygon.html" class="tsd-signature-type">Polygon</a>
</li>
<li>
<a href="_physics_shapes_circle_.es.circle.html" class="tsd-signature-type">Circle</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 ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_shapes_shape_.es.shape.html#bounds" class="tsd-kind-icon">bounds</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_shapes_shape_.es.shape.html#center" class="tsd-kind-icon">center</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_shapes_shape_.es.shape.html#position" class="tsd-kind-icon">position</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_shape_.es.shape.html#collideswithline" class="tsd-kind-icon">collides<wbr>With<wbr>Line</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_shapes_shape_.es.shape.html#collideswithshape" class="tsd-kind-icon">collides<wbr>With<wbr>Shape</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_shapes_shape_.es.shape.html#containspoint" class="tsd-kind-icon">contains<wbr>Point</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_shapes_shape_.es.shape.html#overlaps" class="tsd-kind-icon">overlaps</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_shapes_shape_.es.shape.html#pointcollideswithshape" class="tsd-kind-icon">point<wbr>Collides<wbr>With<wbr>Shape</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_shapes_shape_.es.shape.html#recalculatebounds" class="tsd-kind-icon">recalculate<wbr>Bounds</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="bounds" class="tsd-anchor"></a>
<h3>bounds</h3>
<div class="tsd-signature tsd-kind-icon">bounds<span class="tsd-signature-symbol">:</span> <a href="_math_rectangle_.es.rectangle.html" class="tsd-signature-type">Rectangle</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/Shape.ts#L16">src/Physics/Shapes/Shape.ts:16</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="center" class="tsd-anchor"></a>
<h3>center</h3>
<div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/Shape.ts#L14">src/Physics/Shapes/Shape.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>这不是中心。这个值不一定是物体的中心。对撞机更准确。
应用任何转换旋转的localOffset
内部字段</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="position" class="tsd-anchor"></a>
<h3>position</h3>
<div class="tsd-signature tsd-kind-icon">position<span class="tsd-signature-symbol">:</span> <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/Shape.ts#L8">src/Physics/Shapes/Shape.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>有一个单独的位置字段可以让我们改变形状的位置来进行碰撞检查而不是改变entity.position。
触发碰撞器/边界/散列更新的位置。
内部字段</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="collideswithline" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> collides<wbr>With<wbr>Line</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">collides<wbr>With<wbr>Line<span class="tsd-signature-symbol">(</span>start<span class="tsd-signature-symbol">: </span><a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a>, end<span class="tsd-signature-symbol">: </span><a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a>, hit<span class="tsd-signature-symbol">: </span><a href="_physics_raycasthit_.es.raycasthit.html" class="tsd-signature-type">RaycastHit</a><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/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/Shape.ts#L24">src/Physics/Shapes/Shape.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>start: <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></h5>
</li>
<li>
<h5>end: <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></h5>
</li>
<li>
<h5>hit: <a href="_physics_raycasthit_.es.raycasthit.html" class="tsd-signature-type">RaycastHit</a></h5>
</li>
</ul>
<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">
<a name="collideswithshape" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> collides<wbr>With<wbr>Shape</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">collides<wbr>With<wbr>Shape<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><a href="_physics_shapes_shape_.es.shape.html" class="tsd-signature-type">Shape</a>, collisionResult<span class="tsd-signature-symbol">: </span><a href="_physics_shapes_collisionresult_.es.collisionresult.html" class="tsd-signature-type">CollisionResult</a><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/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/Shape.ts#L22">src/Physics/Shapes/Shape.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>other: <a href="_physics_shapes_shape_.es.shape.html" class="tsd-signature-type">Shape</a></h5>
</li>
<li>
<h5>collisionResult: <a href="_physics_shapes_collisionresult_.es.collisionresult.html" class="tsd-signature-type">CollisionResult</a></h5>
</li>
</ul>
<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">
<a name="containspoint" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> contains<wbr>Point</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">contains<wbr>Point<span class="tsd-signature-symbol">(</span>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">)</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/Physics/Shapes/Shape.ts#L26">src/Physics/Shapes/Shape.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>point: <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="overlaps" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> overlaps</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">overlaps<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><a href="_physics_shapes_shape_.es.shape.html" class="tsd-signature-type">Shape</a><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/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/Shape.ts#L20">src/Physics/Shapes/Shape.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>other: <a href="_physics_shapes_shape_.es.shape.html" class="tsd-signature-type">Shape</a></h5>
</li>
</ul>
<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">
<a name="pointcollideswithshape" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> point<wbr>Collides<wbr>With<wbr>Shape</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">point<wbr>Collides<wbr>With<wbr>Shape<span class="tsd-signature-symbol">(</span>point<span class="tsd-signature-symbol">: </span><a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a>, result<span class="tsd-signature-symbol">: </span><a href="_physics_shapes_collisionresult_.es.collisionresult.html" class="tsd-signature-type">CollisionResult</a><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/esengine/egret-framework/blob/562bacb/source/src/Physics/Shapes/Shape.ts#L28">src/Physics/Shapes/Shape.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>point: <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></h5>
</li>
<li>
<h5>result: <a href="_physics_shapes_collisionresult_.es.collisionresult.html" class="tsd-signature-type">CollisionResult</a></h5>
</li>
</ul>
<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">
<a name="recalculatebounds" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> recalculate<wbr>Bounds</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">recalculate<wbr>Bounds<span class="tsd-signature-symbol">(</span>collider<span class="tsd-signature-symbol">: </span><a href="_ecs_components_physics_colliders_collider_.es.collider.html" class="tsd-signature-type">Collider</a><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/Physics/Shapes/Shape.ts#L18">src/Physics/Shapes/Shape.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>collider: <a href="_ecs_components_physics_colliders_collider_.es.collider.html" class="tsd-signature-type">Collider</a></h5>
</li>
</ul>
<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/_physics_shapes_shape_.html">&quot;<wbr>Physics/<wbr>Shapes/<wbr>Shape&quot;</a>
<ul>
<li class="current tsd-kind-namespace tsd-parent-kind-module">
<a href="../modules/_physics_shapes_shape_.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_shape_.es.shape.html" class="tsd-kind-icon">Shape</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#bounds" class="tsd-kind-icon">bounds</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#center" class="tsd-kind-icon">center</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#position" class="tsd-kind-icon">position</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#collideswithline" class="tsd-kind-icon">collides<wbr>With<wbr>Line</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#collideswithshape" class="tsd-kind-icon">collides<wbr>With<wbr>Shape</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#containspoint" class="tsd-kind-icon">contains<wbr>Point</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#overlaps" class="tsd-kind-icon">overlaps</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#pointcollideswithshape" class="tsd-kind-icon">point<wbr>Collides<wbr>With<wbr>Shape</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_shapes_shape_.es.shape.html#recalculatebounds" class="tsd-kind-icon">recalculate<wbr>Bounds</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>