👷 MRjs - Auto Generated Docs 👷

Changes from `github.com/Volumetrics-io/mrjs` at 502e111f437c469fdd38a65c73f53580a4961ca8

-includes folder updates: `js-api`, `js-api-utils`, `js-api-extras`

source/js-api/000MRElement.md

@@ -17,7 +17,6 @@ The first step in MRjs extending an HTMLElement. Used as a base for both `mr-app
         * [new exports.MRElement()](#new_MRElement+MRElement_new)
     * [.add(entity)](#MRElement+add)
     * [.remove(entity)](#MRElement+remove)
-    * [.getBoundingClientRect()](#MRElement+getBoundingClientRect) ⇒ <code>object</code>
 
 <a name="MRElement+MRElement"></a>
 
@@ -50,10 +49,3 @@ Removing an entity as a sub-object of this entity.
 | --- | --- | --- |
 | entity | <code>object</code> | the entity to be removed. |
 
-<a name="MRElement+getBoundingClientRect"></a>
-
-### mrElement.getBoundingClientRect() ⇒ <code>object</code>
-Overrides getBoundingClientRect() to avoid reflow in sync as optimization
-
-**Kind**: instance method of [<code>MRElement</code>](#MRElement)  
-**Returns**: <code>object</code> - rect - the bounding client rect of the HTMLElement representation of this MRElement.  

source/js-api/001MRSystem.md

@@ -19,6 +19,7 @@ The default representation of an MRSystem to be expanded upon by actual details
     * [._update(deltaTime, frame)](#MRSystem+_update)
     * [.update(deltaTime, frame)](#MRSystem+update)
     * [.eventUpdate()](#MRSystem+eventUpdate)
+    * [._onNewEntity(entity)](#MRSystem+_onNewEntity)
     * [.onNewEntity(entity)](#MRSystem+onNewEntity)
     * [.attachedComponent(entity)](#MRSystem+attachedComponent)
     * [.updatedComponent(entity, oldData)](#MRSystem+updatedComponent)
@@ -95,6 +96,17 @@ An event triggered update, called when any global scene level events occur.
 See GLOBAL_UPDATE_EVENTS of MRSystem.js
 
 **Kind**: instance method of [<code>MRSystem</code>](#MRSystem)  
+<a name="MRSystem+_onNewEntity"></a>
+
+### mrSystem.\_onNewEntity(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+onNewEntity"></a>
 
 ### mrSystem.onNewEntity(entity)
@@ -109,7 +121,7 @@ Called when a new entity is added to the scene
 <a name="MRSystem+attachedComponent"></a>
 
 ### mrSystem.attachedComponent(entity)
-Called when the entity component is initialized
+(async) Called when the entity component is initialized
 
 **Kind**: instance method of [<code>MRSystem</code>](#MRSystem)  
 
@@ -143,7 +155,7 @@ Called when the entity component is removed
 <a name="MRSystem+onAttach"></a>
 
 ### mrSystem.onAttach(event)
-Handles the component and registry aspect of the event when an entity component attaches to this system.
+(async) Handles the component and registry aspect of the event when an entity component attaches to this system.
 
 **Kind**: instance method of [<code>MRSystem</code>](#MRSystem)  
 

source/js-api/013MaterialStyleSystem.md

@@ -16,7 +16,6 @@ Handles style updates for all items.
     * [.MaterialStyleSystem](#MaterialStyleSystem+MaterialStyleSystem)
         * [new exports.MaterialStyleSystem()](#new_MaterialStyleSystem+MaterialStyleSystem_new)
     * [._updateSpecificEntity(entity)](#MaterialStyleSystem+_updateSpecificEntity)
-    * [.eventUpdate()](#MaterialStyleSystem+eventUpdate)
     * [.update(deltaTime, frame)](#MaterialStyleSystem+update)
     * [.onNewEntity(entity)](#MaterialStyleSystem+onNewEntity)
     * [.setBackground(entity)](#MaterialStyleSystem+setBackground)
@@ -42,12 +41,6 @@ The per entity triggered update call. Handles updating all 3D items to match wha
 | --- | --- | --- |
 | entity | <code>object</code> | the MREntity being updated. |
 
-<a name="MaterialStyleSystem+eventUpdate"></a>
-
-### materialStyleSystem.eventUpdate()
-The per global scene event update call. Handles updating all 3D items to match whatever geometry/style is expected whether that be a 2D setup or a 3D change.
-
-**Kind**: instance method of [<code>MaterialStyleSystem</code>](#MaterialStyleSystem)  
 <a name="MaterialStyleSystem+update"></a>
 
 ### materialStyleSystem.update(deltaTime, frame)

source/js-api/016AnimationSystem.md

@@ -50,7 +50,7 @@ Updates each animation mixer in the registry. This function should be called
 <a name="AnimationSystem+attachedComponent"></a>
 
 ### animationSystem.attachedComponent(entity)
-Called when the entity component is initialized
+(async) Called when the entity component is initialized
 
 **Kind**: instance method of [<code>AnimationSystem</code>](#AnimationSystem)  
 

source/js-api/017ControlSystem.md

@@ -24,6 +24,7 @@ This system supports interaction event information including mouse and controlle
     * [.hoverStart(collider1, collider2, entity)](#ControlSystem+hoverStart)
     * [.hoverEnd(entity)](#ControlSystem+hoverEnd)
     * [.pointerRay()](#ControlSystem+pointerRay)
+    * [.clearPointer()](#ControlSystem+clearPointer)
     * [.mouseOver(event)](#ControlSystem+mouseOver)
     * [.onMouseDown(event)](#ControlSystem+onMouseDown)
     * [.onMouseUp(event)](#ControlSystem+onMouseUp)
@@ -139,6 +140,12 @@ Handles the end of hovering over/around a specific entity.
 ### controlSystem.pointerRay()
 Fills in the this.origin,direction,ray, and hit values based on the rapier world
 
+**Kind**: instance method of [<code>ControlSystem</code>](#ControlSystem)  
+<a name="ControlSystem+clearPointer"></a>
+
+### controlSystem.clearPointer()
+clears the gaze/pinch pointer from the scene
+
 **Kind**: instance method of [<code>ControlSystem</code>](#ControlSystem)  
 <a name="ControlSystem+mouseOver"></a>
 

source/js-api/021MREntity.md

@@ -149,7 +149,7 @@ Loads all attributes of this entity's stored dataset including components, attac
 <a name="MREntity+connected"></a>
 
 ### mrEntity.connected()
-Callback function of MREntity - does nothing. Is called by the connectedCallback.
+(async) does nothing. Is called by the connectedCallback.
 
 **Kind**: instance method of [<code>MREntity</code>](#MREntity)  
 <a name="MREntity+connectedCallback"></a>

source/js-api/022MRVolumeEntity.md

@@ -31,6 +31,6 @@ Creates the volume as a base THREE.js object3D
 <a name="MRVolumeEntity+connected"></a>
 
 ### mrVolumeEntity.connected()
-Callback function of MREntity - handles creating clipping geometry around the entire volume for visible restrictions.
+(async) handles creating clipping geometry around the entire volume for visible restrictions.
 
 **Kind**: instance method of [<code>MRVolumeEntity</code>](#MRVolumeEntity)  

source/js-api/023MRTextAreaEntity.md

@@ -38,7 +38,7 @@ The text area element that simulates the behavior of an HTML <textarea> tag,
 <a name="MRTextAreaEntity+connected"></a>
 
 ### mrTextAreaEntity.connected()
-Overrides the connected method to include setup for handling multiline text.
+(async) sets up the textObject of the text item.
 
 **Kind**: instance method of [<code>MRTextAreaEntity</code>](#MRTextAreaEntity)  
 <a name="MRTextAreaEntity+updateTextDisplay"></a>

source/js-api/024MRLightEntity.md

@@ -30,13 +30,13 @@ Constructs the base 3D object.
 <a name="MRLightEntity+connected"></a>
 
 ### mrLightEntity.connected()
-Callback function of MREntity - handles setting up this Light once it is connected to run as an entity component.
+(async) handles setting up this Light once it is connected to run as an entity component.
 
 **Kind**: instance method of [<code>MRLightEntity</code>](#MRLightEntity)  
 <a name="MRLightEntity+mutated"></a>
 
 ### mrLightEntity.mutated(mutation)
-Callback function of MREntity - Updates the lights color and intensity as requested.
+(async) Updates the lights color and intensity as requested.
 
 **Kind**: instance method of [<code>MRLightEntity</code>](#MRLightEntity)  
 

source/js-api/025MRTextEntity.md

@@ -35,7 +35,7 @@ Constructor for the MRTextEntity object.
 <a name="MRTextEntity+connected"></a>
 
 ### mrTextEntity.connected()
-Callback function of MREntity - sets up the textObject of the text item.
+(async) sets up the textObject of the text item.
 
 **Kind**: instance method of [<code>MRTextEntity</code>](#MRTextEntity)  
 <a name="MRTextEntity+triggerTextStyleUpdate"></a>

source/js-api/026MRDivEntity.md

@@ -77,6 +77,6 @@ Removing an entity as a sub-object of this panel (for example an mr-model, butto
 <a name="MRDivEntity+connected"></a>
 
 ### mrDivEntity.connected()
-Callback function of MREntity - connects the background geometry of this item to an actual UIPlane geometry.
+(async) connects the background geometry of this item to an actual UIPlane geometry.
 
 **Kind**: instance method of [<code>MRDivEntity</code>](#MRDivEntity)  

source/js-api/027MRModelEntity.md

@@ -62,7 +62,7 @@ Async function that fills in this Model object based on src file information
 <a name="MRModelEntity+connected"></a>
 
 ### mrModelEntity.connected()
-Callback function of MREntity - handles setting up this Model once it is connected to run as an entity component.
+(async) Callback function of MREntity - handles setting up this Model once it is connected to run as an entity component.
 Includes loading up the model and associated data.
 
 **Kind**: instance method of [<code>MRModelEntity</code>](#MRModelEntity)  

source/js-api/028MRImageEntity.md

@@ -47,7 +47,7 @@ Gets the height of the internal media object
 <a name="MRImageEntity+connected"></a>
 
 ### mrImageEntity.connected()
-Callback function of MREntity - handles setting up this Image and associated 3D geometry style (from css) once it is connected to run as an entity component.
+(async) handles setting up this Image and associated 3D geometry style (from css) once it is connected to run as an entity component.
 
 **Kind**: instance method of [<code>MRImageEntity</code>](#MRImageEntity)  
 <a name="MRImageEntity+loadMediaTexture"></a>

source/js-api/030MRVideoEntity.md

@@ -55,7 +55,7 @@ Loads the associated video into 3D based on its html properties.
 <a name="MRVideoEntity+connected"></a>
 
 ### mrVideoEntity.connected()
-Callback function of MREntity - handles setting up this video and associated 3D geometry style (from css) once it is connected to run as an entity component.
+(async) handles setting up this video and associated 3D geometry style (from css) once it is connected to run as an entity component.
 
 **Kind**: instance method of [<code>MRVideoEntity</code>](#MRVideoEntity)  
 <a name="MRVideoEntity+srcObject"></a>

source/js-api/031MRMediaEntity.md

@@ -84,7 +84,7 @@ by children.
 <a name="MRMediaEntity+connected"></a>
 
 ### mrMediaEntity.connected()
-Callback function of MREntity - handles setting up this media and associated 3D geometry style (from css) once it is connected to run as an entity component.
+(async) handles setting up this media and associated 3D geometry style (from css) once it is connected to run as an entity component.
 
 **Kind**: instance method of [<code>MRMediaEntity</code>](#MRMediaEntity)  
 <a name="MRMediaEntity+mutated"></a>

source/js-api/032MRSkyBoxEntity.md

@@ -44,7 +44,7 @@ Callback function triggered when the texture is successfully loaded.
 <a name="MRSkyBoxEntity+connected"></a>
 
 ### mrSkyBoxEntity.connected()
-Lifecycle method that is called when the entity is connected.
+(async) Lifecycle method that is called when the entity is connected.
              This method initializes and starts the texture loading process.
 
 **Kind**: instance method of [<code>MRSkyBoxEntity</code>](#MRSkyBoxEntity)  

source/js-api/034MRTextInputEntity.md

@@ -56,7 +56,7 @@ Constructor for the textArea entity component.
 <a name="MRTextInputEntity+connected"></a>
 
 ### mrTextInputEntity.connected()
-Callback function of MREntity - handles setting up this textarea once it is connected to run as an entity component.
+(async) handles setting up this textarea once it is connected to run as an entity component.
 
 **Kind**: instance method of [<code>MRTextInputEntity</code>](#MRTextInputEntity)  
 <a name="MRTextInputEntity+_createCursor"></a>

source/js-api/036MRHyperlinkEntity.md

@@ -26,7 +26,7 @@ target attributes.</p>
 <dd><p>Sets the href of the link object</p>
 </dd>
 <dt><a href="#connected">connected()</a></dt>
-<dd><p>Callback function of MREntity - makes sure the link object is created and sets up event
+<dd><p>(async) makes sure the link object is created and sets up event
 listeners for touchstart and click.</p>
 </dd>
 </dl>
@@ -66,7 +66,7 @@ Sets the href of the link object
 <a name="connected"></a>
 
 ## connected()
-Callback function of MREntity - makes sure the link object is created and sets up event
+(async) makes sure the link object is created and sets up event
 listeners for touchstart and click.
 
 **Kind**: global function  

source/js-api/037MRPanelEntity.md

@@ -41,7 +41,7 @@ Gets the height of the current panel in 2D or 3D space (depending on the xr user
 <a name="MRPanelEntity+connected"></a>
 
 ### mrPanelEntity.connected()
-Callback function of MREntity - handles setting up this Panel once it is connected to run as an entity component.
+(async) Callback function of MREntity - handles setting up this Panel once it is connected to run as an entity component.
              Relevant tasks include setting up clipping and setting up for all necessary dispatchEvent connections including mutations and scrolling.
 
 **Kind**: instance method of [<code>MRPanelEntity</code>](#MRPanelEntity)