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

349 lines
17 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>Composite | @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_verlet_composites_composite_.html">&quot;Physics/Verlet/Composites/Composite&quot;</a>
</li>
<li>
<a href="../modules/_physics_verlet_composites_composite_.es.html">es</a>
</li>
<li>
<a href="_physics_verlet_composites_composite_.es.composite.html">Composite</a>
</li>
</ul>
<h1>Class Composite</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>代表了Verlet世界中的一个对象。由粒子和约束组成并处理更新它们</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Composite</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_verlet_composites_composite_.es.composite.html#_constraints" class="tsd-kind-icon">_constraints</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_verlet_composites_composite_.es.composite.html#collideswithlayers" class="tsd-kind-icon">collides<wbr>With<wbr>Layers</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_verlet_composites_composite_.es.composite.html#friction" class="tsd-kind-icon">friction</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_physics_verlet_composites_composite_.es.composite.html#particles" class="tsd-kind-icon">particles</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_verlet_composites_composite_.es.composite.html#debugrender" class="tsd-kind-icon">debug<wbr>Render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_verlet_composites_composite_.es.composite.html#handleconstraintcollisions" class="tsd-kind-icon">handle<wbr>Constraint<wbr>Collisions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_verlet_composites_composite_.es.composite.html#solveconstraints" class="tsd-kind-icon">solve<wbr>Constraints</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_physics_verlet_composites_composite_.es.composite.html#updateparticles" class="tsd-kind-icon">update<wbr>Particles</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="_constraints" class="tsd-anchor"></a>
<h3>_constraints</h3>
<div class="tsd-signature tsd-kind-icon">_constraints<span class="tsd-signature-symbol">:</span> <a href="_physics_verlet_constraints_constraint_.es.constraint.html" class="tsd-signature-type">Constraint</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/Verlet/Composites/Composite.ts#L16">src/Physics/Verlet/Composites/Composite.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="collideswithlayers" class="tsd-anchor"></a>
<h3>collides<wbr>With<wbr>Layers</h3>
<div class="tsd-signature tsd-kind-icon">collides<wbr>With<wbr>Layers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = Physics.allLayers</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Verlet/Composites/Composite.ts#L13">src/Physics/Verlet/Composites/Composite.ts:13</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="friction" class="tsd-anchor"></a>
<h3>friction</h3>
<div class="tsd-signature tsd-kind-icon">friction<span class="tsd-signature-symbol">:</span> <a href="_math_vector2_.es.vector2.html" class="tsd-signature-type">Vector2</a><span class="tsd-signature-symbol"> = new Vector2(0.98, 1)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Physics/Verlet/Composites/Composite.ts#L9">src/Physics/Verlet/Composites/Composite.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>摩擦作用于所有粒子运动以使其阻尼。值应该非常接近1。</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="particles" class="tsd-anchor"></a>
<h3>particles</h3>
<div class="tsd-signature tsd-kind-icon">particles<span class="tsd-signature-symbol">:</span> <a href="_physics_verlet_particle_.es.particle.html" class="tsd-signature-type">Particle</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/Verlet/Composites/Composite.ts#L15">src/Physics/Verlet/Composites/Composite.ts:15</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">
<a name="debugrender" class="tsd-anchor"></a>
<h3>debug<wbr>Render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">debug<wbr>Render<span class="tsd-signature-symbol">(</span>camera<span class="tsd-signature-symbol">: </span><a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</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/Verlet/Composites/Composite.ts#L60">src/Physics/Verlet/Composites/Composite.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>camera: <a href="_ecs_components_camera_.es.camera.html" class="tsd-signature-type">Camera</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="handleconstraintcollisions" class="tsd-anchor"></a>
<h3>handle<wbr>Constraint<wbr>Collisions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Constraint<wbr>Collisions<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/Verlet/Composites/Composite.ts#L53">src/Physics/Verlet/Composites/Composite.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">
<a name="solveconstraints" class="tsd-anchor"></a>
<h3>solve<wbr>Constraints</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">solve<wbr>Constraints<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/Verlet/Composites/Composite.ts#L20">src/Physics/Verlet/Composites/Composite.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>处理解决所有约束条件</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="updateparticles" class="tsd-anchor"></a>
<h3>update<wbr>Particles</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">update<wbr>Particles<span class="tsd-signature-symbol">(</span>deltaTimeSquared<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, gravity<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/Verlet/Composites/Composite.ts#L31">src/Physics/Verlet/Composites/Composite.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>对每个粒子应用重力并做Velet积分</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>deltaTimeSquared: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>gravity: <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>
</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_verlet_composites_composite_.html">&quot;<wbr>Physics/<wbr>Verlet/<wbr>Composites/<wbr>Composite&quot;</a>
<ul>
<li class="current tsd-kind-namespace tsd-parent-kind-module">
<a href="../modules/_physics_verlet_composites_composite_.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_verlet_composites_composite_.es.composite.html" class="tsd-kind-icon">Composite</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_verlet_composites_composite_.es.composite.html#_constraints" class="tsd-kind-icon">_constraints</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_verlet_composites_composite_.es.composite.html#collideswithlayers" class="tsd-kind-icon">collides<wbr>With<wbr>Layers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_verlet_composites_composite_.es.composite.html#friction" class="tsd-kind-icon">friction</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_physics_verlet_composites_composite_.es.composite.html#particles" class="tsd-kind-icon">particles</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_verlet_composites_composite_.es.composite.html#debugrender" class="tsd-kind-icon">debug<wbr>Render</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_verlet_composites_composite_.es.composite.html#handleconstraintcollisions" class="tsd-kind-icon">handle<wbr>Constraint<wbr>Collisions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_verlet_composites_composite_.es.composite.html#solveconstraints" class="tsd-kind-icon">solve<wbr>Constraints</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_physics_verlet_composites_composite_.es.composite.html#updateparticles" class="tsd-kind-icon">update<wbr>Particles</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>