👷 MRjs - Auto Generated Docs 👷

Changes from `github.com/Volumetrics-io/mrjs` at a1d7780b17e412636e109ea9f2c997e21abaed25 -includes folder updates: `js-api`, `js-api-utils`, `js-api-extras`
Volumetrics-io · Apr 9, 2024 · 3c90ce6 · 3c90ce6
1 parent e4ee9d4
commit 3c90ce6
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 17 deletions.
diff --git a/source/js-api/000MRElement.md b/source/js-api/000MRElement.md
@@ -16,7 +16,7 @@ The first step in MRjs extending an HTMLElement. Used as a base for both `mr-app
     * [.MRElement](#MRElement+MRElement)
         * [new exports.MRElement()](#new_MRElement+MRElement_new)
     * [.add(entity)](#MRElement+add)
-    * [.remove(entity)](#MRElement+remove)
+    * [.removeEntity(entity)](#MRElement+removeEntity)
 
 <a name="MRElement+MRElement"></a>
 
@@ -38,9 +38,9 @@ Adding an entity as a sub-object of this entity.
 | --- | --- | --- |
 | entity | <code>object</code> | the entity to be added. |
 
-<a name="MRElement+remove"></a>
+<a name="MRElement+removeEntity"></a>
 
-### mrElement.remove(entity)
+### mrElement.removeEntity(entity)
 Removing an entity as a sub-object of this entity.
 
 **Kind**: instance method of [<code>MRElement</code>](#MRElement)  

diff --git a/source/js-api/001MRSystem.md b/source/js-api/001MRSystem.md
@@ -21,6 +21,8 @@ The default representation of an MRSystem to be expanded upon by actual details
     * [.eventUpdate()](#MRSystem+eventUpdate)
     * [._onNewEntity(entity)](#MRSystem+_onNewEntity)
     * [.onNewEntity(entity)](#MRSystem+onNewEntity)
+    * [._entityRemoved(entity)](#MRSystem+_entityRemoved)
+    * [.entityRemoved(entity)](#MRSystem+entityRemoved)
     * [.attachedComponent(entity)](#MRSystem+attachedComponent)
     * [.updatedComponent(entity, oldData)](#MRSystem+updatedComponent)
     * [.detachedComponent(entity)](#MRSystem+detachedComponent)
@@ -118,6 +120,28 @@ Called when a new entity is added to the scene
 | --- | --- | --- |
 | entity | <code>MREntity</code> | the entity being added. |
 
+<a name="MRSystem+_entityRemoved"></a>
+
+### mrSystem.\_entityRemoved(entity)
+internal function, called when a new entity is added to the scene
+
+**Kind**: instance method of [<code>MRSystem</code>](#MRSystem)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| entity | <code>MREntity</code> | the entity being added. |
+
+<a name="MRSystem+entityRemoved"></a>
+
+### mrSystem.entityRemoved(entity)
+Called when a new entity is added to the scene
+
+**Kind**: instance method of [<code>MRSystem</code>](#MRSystem)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| entity | <code>MREntity</code> | the entity being added. |
+
 <a name="MRSystem+attachedComponent"></a>
 
 ### mrSystem.attachedComponent(entity)

diff --git a/source/js-api/002MRApp.md b/source/js-api/002MRApp.md
@@ -28,7 +28,7 @@ The engine handler for running MRjs as an App. `mr-app`
         * [.registerSystem(system)](#MRApp+registerSystem)
         * [.unregisterSystem(system)](#MRApp+unregisterSystem)
         * [.add(entity)](#MRApp+add)
-        * [.remove(entity)](#MRApp+remove)
+        * [.removeEntity(entity)](#MRApp+removeEntity)
         * [.onWindowResize()](#MRApp+onWindowResize)
         * [.render(timeStamp, frame)](#MRApp+render)
     * _static_
@@ -146,9 +146,9 @@ Adding an entity as an object in this MRApp engine's scene.
 | --- | --- | --- |
 | entity | <code>MREntity</code> | the entity to be added. |
 
-<a name="MRApp+remove"></a>
+<a name="MRApp+removeEntity"></a>
 
-### mrApp.remove(entity)
+### mrApp.removeEntity(entity)
 Removing an entity as an object in this MRApp engine's scene.
 
 **Kind**: instance method of [<code>MRApp</code>](#MRApp)  

diff --git a/source/js-api/005BoundaryVisibilitySystem.md b/source/js-api/005BoundaryVisibilitySystem.md
@@ -15,7 +15,7 @@ github-path: https://github.com/volumetrics-io/mrjs/edit/main/src/core/component
 ## Functions
 
 <dl>
-<dt><a href="#observe">observe(root, target)</a></dt>
+<dt><a href="#observe">observe(root, target)</a> ⇒ <code>IntersectionObserver</code></dt>
 <dd><p>Observe a target MRDivEntity and make the associated object visible only if it is in visible position in a root MRDivEntity</p>
 </dd>
 </dl>
@@ -32,6 +32,7 @@ Makes the entities invisible if they are outside of their parent panels
     * [.BoundaryVisibilitySystem](#BoundaryVisibilitySystem+BoundaryVisibilitySystem)
         * [new exports.BoundaryVisibilitySystem()](#new_BoundaryVisibilitySystem+BoundaryVisibilitySystem_new)
     * [.onNewEntity(entity)](#BoundaryVisibilitySystem+onNewEntity)
+    * [._entityRemoved(entity)](#BoundaryVisibilitySystem+_entityRemoved)
 
 <a name="BoundaryVisibilitySystem+BoundaryVisibilitySystem"></a>
 
@@ -53,12 +54,24 @@ Called when a new entity is added to the scene.
 | --- | --- | --- |
 | entity | <code>object</code> | the entity being added. |
 
+<a name="BoundaryVisibilitySystem+_entityRemoved"></a>
+
+### boundaryVisibilitySystem.\_entityRemoved(entity)
+Called when an entity is removed from the scene.
+
+**Kind**: instance method of [<code>BoundaryVisibilitySystem</code>](#BoundaryVisibilitySystem)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| entity | <code>object</code> | the entity being added. |
+
 <a name="observe"></a>
 
-## observe(root, target)
+## observe(root, target) ⇒ <code>IntersectionObserver</code>
 Observe a target MRDivEntity and make the associated object visible only if it is in visible position in a root MRDivEntity
 
 **Kind**: global function  
+**Returns**: <code>IntersectionObserver</code> - - an observer for tracking visiblity  
 
 | Param | Type | Description |
 | --- | --- | --- |

diff --git a/source/js-api/009PhysicsSystem.md b/source/js-api/009PhysicsSystem.md
@@ -27,6 +27,7 @@ attribute for more detailed control.
     * [.entityEventUpdate(e)](#PhysicsSystem+entityEventUpdate)
     * [.update(deltaTime, frame)](#PhysicsSystem+update)
     * [.onNewEntity(entity)](#PhysicsSystem+onNewEntity)
+    * [.entityRemoved(entity)](#PhysicsSystem+entityRemoved)
     * [.initPhysicsBody(entity)](#PhysicsSystem+initPhysicsBody)
     * [.initUIEntityBody(entity)](#PhysicsSystem+initUIEntityBody)
     * [.initSimpleBody(entity)](#PhysicsSystem+initSimpleBody)
@@ -85,6 +86,17 @@ When a new entity is created, adds it to the physics registry and initializes th
 | --- | --- | --- |
 | entity | <code>MREntity</code> | the entity being set up |
 
+<a name="PhysicsSystem+entityRemoved"></a>
+
+### physicsSystem.entityRemoved(entity)
+when an entity is removed, remove and destroy it's physics body
+
+**Kind**: instance method of [<code>PhysicsSystem</code>](#PhysicsSystem)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| entity | <code>MREntity</code> | the removed entity |
+
 <a name="PhysicsSystem+initPhysicsBody"></a>
 
 ### physicsSystem.initPhysicsBody(entity)

diff --git a/source/js-api/021MREntity.md b/source/js-api/021MREntity.md
@@ -35,7 +35,7 @@ The default representation of an MRElement to be expanded upon by actual details
     * [.mutationCallback(mutationList, observer)](#MREntity+mutationCallback)
     * [.componentMutated(mutation)](#MREntity+componentMutated)
     * [.add(entity)](#MREntity+add)
-    * [.remove(entity)](#MREntity+remove)
+    * [.removeEntity(entity)](#MREntity+removeEntity)
     * [.traverse(callBack)](#MREntity+traverse)
     * [.traverseObjects(callBack)](#MREntity+traverseObjects)
 
@@ -215,9 +215,9 @@ Adding an entity as a sub-object of this entity.
 | --- | --- | --- |
 | entity | [<code>MREntity</code>](#MREntity) | the entity to be added. |
 
-<a name="MREntity+remove"></a>
+<a name="MREntity+removeEntity"></a>
 
-### mrEntity.remove(entity)
+### mrEntity.removeEntity(entity)
 Removing an entity as a sub-object of this entity.
 
 **Kind**: instance method of [<code>MREntity</code>](#MREntity)  

diff --git a/source/js-api/026MRDivEntity.md b/source/js-api/026MRDivEntity.md
@@ -19,7 +19,7 @@ The MREntity that is used to solely describe UI Elements. Defaults as the html `
     * [.width()](#MRDivEntity+width) ⇒ <code>number</code>
     * [.borderRadii()](#MRDivEntity+borderRadii) ⇒ <code>number</code>
     * [.add(entity)](#MRDivEntity+add)
-    * [.remove(entity)](#MRDivEntity+remove)
+    * [.removeEntity(entity)](#MRDivEntity+removeEntity)
     * [.connected()](#MRDivEntity+connected)
 
 <a name="MRDivEntity+MRDivEntity"></a>
@@ -63,9 +63,9 @@ Adding an entity as a sub-object of this panel (for example an mr-model, button,
 | --- | --- | --- |
 | entity | <code>MREntity</code> | the entity to be added. |
 
-<a name="MRDivEntity+remove"></a>
+<a name="MRDivEntity+removeEntity"></a>
 
-### mrDivEntity.remove(entity)
+### mrDivEntity.removeEntity(entity)
 Removing an entity as a sub-object of this panel (for example an mr-model, button, etc).
 
 **Kind**: instance method of [<code>MRDivEntity</code>](#MRDivEntity)  

diff --git a/source/js-api/037MRPanelEntity.md b/source/js-api/037MRPanelEntity.md
@@ -18,7 +18,7 @@ The main panel entity DOM used for webpages and UI elements in 3D space. `mr-pan
     * [.height()](#MRPanelEntity+height) ⇒ <code>number</code>
     * [.connected()](#MRPanelEntity+connected)
     * [.add(entity)](#MRPanelEntity+add)
-    * [.remove(entity)](#MRPanelEntity+remove)
+    * [.removeEntity(entity)](#MRPanelEntity+removeEntity)
     * [.onTouch(event)](#MRPanelEntity+onTouch)
     * [.onScroll(event)](#MRPanelEntity+onScroll)
 
@@ -56,9 +56,9 @@ Adding an entity as a sub-object of this entity.
 | --- | --- | --- |
 | entity | <code>MREntity</code> | the entity to be added. |
 
-<a name="MRPanelEntity+remove"></a>
+<a name="MRPanelEntity+removeEntity"></a>
 
-### mrPanelEntity.remove(entity)
+### mrPanelEntity.removeEntity(entity)
 Remove an entity as a sub-object of this entity.
 
 **Kind**: instance method of [<code>MRPanelEntity</code>](#MRPanelEntity)