From 92ade285beea6ac9ef1f54f92ffb373b4b9cf18b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 3 Apr 2024 21:58:15 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=91=B7=20MRjs=20-=20Auto=20Generated=20Do?= =?UTF-8?q?cs=20=F0=9F=91=B7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 | 8 -------- source/js-api/001MRSystem.md | 16 ++++++++++++++-- source/js-api/013MaterialStyleSystem.md | 7 ------- source/js-api/016AnimationSystem.md | 2 +- source/js-api/017ControlSystem.md | 7 +++++++ source/js-api/021MREntity.md | 2 +- source/js-api/022MRVolumeEntity.md | 2 +- source/js-api/023MRTextAreaEntity.md | 2 +- source/js-api/024MRLightEntity.md | 4 ++-- source/js-api/025MRTextEntity.md | 2 +- source/js-api/026MRDivEntity.md | 2 +- source/js-api/027MRModelEntity.md | 2 +- source/js-api/028MRImageEntity.md | 2 +- source/js-api/030MRVideoEntity.md | 2 +- source/js-api/031MRMediaEntity.md | 2 +- source/js-api/032MRSkyBoxEntity.md | 2 +- source/js-api/034MRTextInputEntity.md | 2 +- source/js-api/036MRHyperlinkEntity.md | 4 ++-- source/js-api/037MRPanelEntity.md | 2 +- 19 files changed, 38 insertions(+), 34 deletions(-) diff --git a/source/js-api/000MRElement.md b/source/js-api/000MRElement.md index 4813740..8642792 100644 --- a/source/js-api/000MRElement.md +++ b/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) ⇒ object @@ -50,10 +49,3 @@ Removing an entity as a sub-object of this entity. | --- | --- | --- | | entity | object | the entity to be removed. | - - -### mrElement.getBoundingClientRect() ⇒ object -Overrides getBoundingClientRect() to avoid reflow in sync as optimization - -**Kind**: instance method of [MRElement](#MRElement) -**Returns**: object - rect - the bounding client rect of the HTMLElement representation of this MRElement. diff --git a/source/js-api/001MRSystem.md b/source/js-api/001MRSystem.md index a94cff1..260ccb6 100644 --- a/source/js-api/001MRSystem.md +++ b/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 [MRSystem](#MRSystem) + + +### mrSystem.\_onNewEntity(entity) +internal function, called when a new entity is added to the scene + +**Kind**: instance method of [MRSystem](#MRSystem) + +| Param | Type | Description | +| --- | --- | --- | +| entity | MREntity | the entity being added. | + ### mrSystem.onNewEntity(entity) @@ -109,7 +121,7 @@ Called when a new entity is added to the scene ### mrSystem.attachedComponent(entity) -Called when the entity component is initialized +(async) Called when the entity component is initialized **Kind**: instance method of [MRSystem](#MRSystem) @@ -143,7 +155,7 @@ Called when the entity component is removed ### 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 [MRSystem](#MRSystem) diff --git a/source/js-api/013MaterialStyleSystem.md b/source/js-api/013MaterialStyleSystem.md index 369b145..3b2a169 100644 --- a/source/js-api/013MaterialStyleSystem.md +++ b/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 | object | the MREntity being updated. | - - -### 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 [MaterialStyleSystem](#MaterialStyleSystem) ### materialStyleSystem.update(deltaTime, frame) diff --git a/source/js-api/016AnimationSystem.md b/source/js-api/016AnimationSystem.md index 6bb10f2..2431b69 100644 --- a/source/js-api/016AnimationSystem.md +++ b/source/js-api/016AnimationSystem.md @@ -50,7 +50,7 @@ Updates each animation mixer in the registry. This function should be called ### animationSystem.attachedComponent(entity) -Called when the entity component is initialized +(async) Called when the entity component is initialized **Kind**: instance method of [AnimationSystem](#AnimationSystem) diff --git a/source/js-api/017ControlSystem.md b/source/js-api/017ControlSystem.md index f664f8a..e16950e 100644 --- a/source/js-api/017ControlSystem.md +++ b/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 [ControlSystem](#ControlSystem) + + +### controlSystem.clearPointer() +clears the gaze/pinch pointer from the scene + **Kind**: instance method of [ControlSystem](#ControlSystem) diff --git a/source/js-api/021MREntity.md b/source/js-api/021MREntity.md index 4418b81..f86b2c1 100644 --- a/source/js-api/021MREntity.md +++ b/source/js-api/021MREntity.md @@ -149,7 +149,7 @@ Loads all attributes of this entity's stored dataset including components, attac ### 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 [MREntity](#MREntity) diff --git a/source/js-api/022MRVolumeEntity.md b/source/js-api/022MRVolumeEntity.md index 86fe720..c4dbf7a 100644 --- a/source/js-api/022MRVolumeEntity.md +++ b/source/js-api/022MRVolumeEntity.md @@ -31,6 +31,6 @@ Creates the volume as a base THREE.js object3D ### 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 [MRVolumeEntity](#MRVolumeEntity) diff --git a/source/js-api/023MRTextAreaEntity.md b/source/js-api/023MRTextAreaEntity.md index cc7f7db..feb3d9e 100644 --- a/source/js-api/023MRTextAreaEntity.md +++ b/source/js-api/023MRTextAreaEntity.md @@ -38,7 +38,7 @@ The text area element that simulates the behavior of an HTML