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

441 lines
22 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RaycastHit | @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_raycasthit_.html">&quot;Physics/RaycastHit&quot;</a>
</li>
<li>
<a href="../modules/_physics_raycasthit_.es.html">es</a>
</li>
<li>
<a href="_physics_raycasthit_.es.raycasthit.html">RaycastHit</a>
</li>
</ul>
<h1>Class RaycastHit</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">RaycastHit</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_raycasthit_.es.raycasthit.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<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_raycasthit_.es.raycasthit.html#centroid" class="tsd-kind-icon">centroid</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_raycasthit_.es.raycasthit.html#collider" class="tsd-kind-icon">collider</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_raycasthit_.es.raycasthit.html#distance" class="tsd-kind-icon">distance</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_raycasthit_.es.raycasthit.html#fraction" class="tsd-kind-icon">fraction</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_raycasthit_.es.raycasthit.html#normal" class="tsd-kind-icon">normal</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_raycasthit_.es.raycasthit.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_raycasthit_.es.raycasthit.html#reset" class="tsd-kind-icon">reset</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_raycasthit_.es.raycasthit.html#setvalues" class="tsd-kind-icon">set<wbr>Values</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_raycasthit_.es.raycasthit.html#setvaluesnoncollider" class="tsd-kind-icon">set<wbr>Values<wbr>Non<wbr>Collider</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_raycasthit_.es.raycasthit.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>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>Raycast<wbr>Hit<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>, fraction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, distance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, point<span class="tsd-signature-symbol">?: </span><a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a>, 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">)</span><span class="tsd-signature-symbol">: </span><a href="_physics_raycasthit_.es.raycasthit.html" class="tsd-signature-type">RaycastHit</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/RaycastHit.ts#L31">src/Physics/RaycastHit.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> collider: <a href="_ecs_components_physics_colliders_collider_.es.collider.html" class="tsd-signature-type">Collider</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fraction: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> distance: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> point: <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> normal: <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_physics_raycasthit_.es.raycasthit.html" class="tsd-signature-type">RaycastHit</a></h4>
</li>
</ul>
</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="centroid" class="tsd-anchor"></a>
<h3>centroid</h3>
<div class="tsd-signature tsd-kind-icon">centroid<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/RaycastHit.ts#L31">src/Physics/RaycastHit.ts:31</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="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/RaycastHit.ts#L6">src/Physics/RaycastHit.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="distance" class="tsd-anchor"></a>
<h3>distance</h3>
<div class="tsd-signature tsd-kind-icon">distance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/RaycastHit.ts#L16">src/Physics/RaycastHit.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="fraction" class="tsd-anchor"></a>
<h3>fraction</h3>
<div class="tsd-signature tsd-kind-icon">fraction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/RaycastHit.ts#L11">src/Physics/RaycastHit.ts:11</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/RaycastHit.ts#L26">src/Physics/RaycastHit.ts:26</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/RaycastHit.ts#L21">src/Physics/RaycastHit.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>世界空间中光线击中对撞机表面的点</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="reset" class="tsd-anchor"></a>
<h3>reset</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">reset<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/RaycastHit.ts#L55">src/Physics/RaycastHit.ts:55</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">
<a name="setvalues" class="tsd-anchor"></a>
<h3>set<wbr>Values</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Values<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>, fraction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, distance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">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/RaycastHit.ts#L41">src/Physics/RaycastHit.ts:41</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>
<li>
<h5>fraction: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>distance: <span class="tsd-signature-type">number</span></h5>
</li>
<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">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setvaluesnoncollider" class="tsd-anchor"></a>
<h3>set<wbr>Values<wbr>Non<wbr>Collider</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Values<wbr>Non<wbr>Collider<span class="tsd-signature-symbol">(</span>fraction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, distance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, point<span class="tsd-signature-symbol">: </span><a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a>, 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">)</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/RaycastHit.ts#L48">src/Physics/RaycastHit.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fraction: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>distance: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>point: <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a></h5>
</li>
<li>
<h5>normal: <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">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/RaycastHit.ts#L60">src/Physics/RaycastHit.ts:60</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_raycasthit_.html">&quot;<wbr>Physics/<wbr>Raycast<wbr>Hit&quot;</a>
<ul>
<li class="current tsd-kind-namespace tsd-parent-kind-module">
<a href="../modules/_physics_raycasthit_.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_raycasthit_.es.raycasthit.html" class="tsd-kind-icon">Raycast<wbr>Hit</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#centroid" class="tsd-kind-icon">centroid</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#collider" class="tsd-kind-icon">collider</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#distance" class="tsd-kind-icon">distance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#fraction" class="tsd-kind-icon">fraction</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#normal" class="tsd-kind-icon">normal</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#point" class="tsd-kind-icon">point</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#reset" class="tsd-kind-icon">reset</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#setvalues" class="tsd-kind-icon">set<wbr>Values</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.html#setvaluesnoncollider" class="tsd-kind-icon">set<wbr>Values<wbr>Non<wbr>Collider</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_raycasthit_.es.raycasthit.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-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>
</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>