<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>PhysicsAggregate | Babylon.js API documentation</title><meta name="description" content="Documentation for Babylon.js API documentation"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"></head><body><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"></div><div class="field"><div id="tsd-toolbar-links"></div></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">Babylon.js API documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Babylon.js API documentation</a></li><li><a href="../modules/BABYLON.html">BABYLON</a></li><li><a href="BABYLON.PhysicsAggregate.html">PhysicsAggregate</a></li></ul><h1>Class PhysicsAggregate</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Helper class to create and interact with a PhysicsAggregate.
This is a transition object that works like Physics Plugin V1 Impostors.
This helper instantiates all mandatory physics objects to get a body/shape and material.
It's less efficient than handling body and shapes independently but for prototyping or
a small numbers of physics objects, it's good enough.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in .temp/typedoc/docdirectory/doc.d.ts:28483</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="BABYLON.PhysicsAggregate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="BABYLON.PhysicsAggregate.html#body" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>body</span></a>
<a href="BABYLON.PhysicsAggregate.html#material" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>material</span></a>
<a href="BABYLON.PhysicsAggregate.html#shape" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shape</span></a>
<a href="BABYLON.PhysicsAggregate.html#transformnode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transform<wbr>Node</span></a>
<a href="BABYLON.PhysicsAggregate.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="BABYLON.PhysicsAggregate.html#dispose" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispose</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorphysicsaggregate" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">PhysicsAggregate</span><span class="tsd-signature-symbol">(</span><br>    <span class="tsd-kind-parameter">transformNode</span><span class="tsd-signature-symbol">:</span> <a href="BABYLON.TransformNode.html" class="tsd-signature-type tsd-kind-class">TransformNode</a><span class="tsd-signature-symbol">,</span><br>    <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <a href="BABYLON.PhysicsShape.html" class="tsd-signature-type tsd-kind-class">PhysicsShape</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/BABYLON.PhysicsShapeType.html" class="tsd-signature-type tsd-kind-enum">PhysicsShapeType</a><span class="tsd-signature-symbol">,</span><br>    <span class="tsd-kind-parameter">_options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/BABYLON.PhysicsAggregateParameters.html" class="tsd-signature-type tsd-kind-interface">PhysicsAggregateParameters</a><span class="tsd-signature-symbol">,</span><br>    <span class="tsd-kind-parameter">_scene</span><span class="tsd-signature-symbol">?:</span> <a href="BABYLON.Scene.html" class="tsd-signature-type tsd-kind-class">Scene</a><span class="tsd-signature-symbol">,</span><br><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BABYLON.PhysicsAggregate.html" class="tsd-signature-type tsd-kind-class">PhysicsAggregate</a><a href="#constructorphysicsaggregate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">transformNode</span>: <a href="BABYLON.TransformNode.html" class="tsd-signature-type tsd-kind-class">TransformNode</a></span><div class="tsd-comment tsd-typography"><p>The physics-enabled object used as the physics aggregate</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">type</span>: <a href="BABYLON.PhysicsShape.html" class="tsd-signature-type tsd-kind-class">PhysicsShape</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/BABYLON.PhysicsShapeType.html" class="tsd-signature-type tsd-kind-enum">PhysicsShapeType</a></span><div class="tsd-comment tsd-typography"><p>The type of the physics aggregate</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">_options</span>: <a href="../interfaces/BABYLON.PhysicsAggregateParameters.html" class="tsd-signature-type tsd-kind-interface">PhysicsAggregateParameters</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">_scene</span>: <a href="BABYLON.Scene.html" class="tsd-signature-type tsd-kind-class">Scene</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BABYLON.PhysicsAggregate.html" class="tsd-signature-type tsd-kind-class">PhysicsAggregate</a></h4><aside class="tsd-sources"><ul><li>Defined in .temp/typedoc/docdirectory/doc.d.ts:28508</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="body" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>body</span><a href="#body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">:</span> <a href="BABYLON.PhysicsBody.html" class="tsd-signature-type tsd-kind-class">PhysicsBody</a></div><div class="tsd-comment tsd-typography"><p>The body that is associated with this aggregate</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in .temp/typedoc/docdirectory/doc.d.ts:28497</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="material" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>material</span><a href="#material" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">material</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/BABYLON.PhysicsMaterial.html" class="tsd-signature-type tsd-kind-interface">PhysicsMaterial</a></div><div class="tsd-comment tsd-typography"><p>The material that is associated with this aggregate</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in .temp/typedoc/docdirectory/doc.d.ts:28505</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="shape" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>shape</span><a href="#shape" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">shape</span><span class="tsd-signature-symbol">:</span> <a href="BABYLON.PhysicsShape.html" class="tsd-signature-type tsd-kind-class">PhysicsShape</a></div><div class="tsd-comment tsd-typography"><p>The shape that is associated with this aggregate</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in .temp/typedoc/docdirectory/doc.d.ts:28501</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transformnode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transform<wbr>Node</span><a href="#transformnode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transformNode</span><span class="tsd-signature-symbol">:</span> <a href="BABYLON.TransformNode.html" class="tsd-signature-type tsd-kind-class">TransformNode</a></div><div class="tsd-comment tsd-typography"><p>The physics-enabled object used as the physics aggregate</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in .temp/typedoc/docdirectory/doc.d.ts:28487</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <a href="BABYLON.PhysicsShape.html" class="tsd-signature-type tsd-kind-class">PhysicsShape</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/BABYLON.PhysicsShapeType.html" class="tsd-signature-type tsd-kind-enum">PhysicsShapeType</a></div><div class="tsd-comment tsd-typography"><p>The type of the physics aggregate</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in .temp/typedoc/docdirectory/doc.d.ts:28491</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="dispose" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dispose</span><a href="#dispose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="dispose-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dispose</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#dispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Releases the body, shape and material</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in .temp/typedoc/docdirectory/doc.d.ts:28523</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#body" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>body</span></a><a href="#material" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>material</span></a><a href="#shape" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shape</span></a><a href="#transformnode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transform<wbr>Node</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#dispose" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispose</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Babylon.js API documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
