diff --git a/source/js-api/000MRElement.md b/source/js-api/000MRElement.md index 8642792..e75b3a9 100644 --- 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) @@ -38,9 +38,9 @@ Adding an entity as a sub-object of this entity. | --- | --- | --- | | entity | object | the entity to be added. | - + -### mrElement.remove(entity) +### mrElement.removeEntity(entity) Removing an entity as a sub-object of this entity. **Kind**: instance method of [MRElement](#MRElement) diff --git a/source/js-api/001MRSystem.md b/source/js-api/001MRSystem.md index 260ccb6..5f15ae3 100644 --- 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 | MREntity | the entity being added. | + + +### mrSystem.\_entityRemoved(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.entityRemoved(entity) +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.attachedComponent(entity) diff --git a/source/js-api/002MRApp.md b/source/js-api/002MRApp.md index 6c6165b..654a435 100644 --- 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 | MREntity | the entity to be added. | - + -### mrApp.remove(entity) +### mrApp.removeEntity(entity) Removing an entity as an object in this MRApp engine's scene. **Kind**: instance method of [MRApp](#MRApp) diff --git a/source/js-api/005BoundaryVisibilitySystem.md b/source/js-api/005BoundaryVisibilitySystem.md index e28c89b..a9b61da 100644 --- 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
-
observe(root, target)
+
observe(root, target)IntersectionObserver

Observe a target MRDivEntity and make the associated object visible only if it is in visible position in a root MRDivEntity

@@ -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) @@ -53,12 +54,24 @@ Called when a new entity is added to the scene. | --- | --- | --- | | entity | object | the entity being added. | + + +### boundaryVisibilitySystem.\_entityRemoved(entity) +Called when an entity is removed from the scene. + +**Kind**: instance method of [BoundaryVisibilitySystem](#BoundaryVisibilitySystem) + +| Param | Type | Description | +| --- | --- | --- | +| entity | object | the entity being added. | + -## observe(root, target) +## observe(root, target) ⇒ IntersectionObserver 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**: IntersectionObserver - - an observer for tracking visiblity | Param | Type | Description | | --- | --- | --- | diff --git a/source/js-api/009PhysicsSystem.md b/source/js-api/009PhysicsSystem.md index 7154abb..6d4f92d 100644 --- 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 | MREntity | the entity being set up | + + +### physicsSystem.entityRemoved(entity) +when an entity is removed, remove and destroy it's physics body + +**Kind**: instance method of [PhysicsSystem](#PhysicsSystem) + +| Param | Type | Description | +| --- | --- | --- | +| entity | MREntity | the removed entity | + ### physicsSystem.initPhysicsBody(entity) diff --git a/source/js-api/021MREntity.md b/source/js-api/021MREntity.md index f86b2c1..401fa02 100644 --- 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 | [MREntity](#MREntity) | the entity to be added. | - + -### mrEntity.remove(entity) +### mrEntity.removeEntity(entity) Removing an entity as a sub-object of this entity. **Kind**: instance method of [MREntity](#MREntity) diff --git a/source/js-api/026MRDivEntity.md b/source/js-api/026MRDivEntity.md index b135908..b5a130e 100644 --- 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) ⇒ number * [.borderRadii()](#MRDivEntity+borderRadii) ⇒ number * [.add(entity)](#MRDivEntity+add) - * [.remove(entity)](#MRDivEntity+remove) + * [.removeEntity(entity)](#MRDivEntity+removeEntity) * [.connected()](#MRDivEntity+connected) @@ -63,9 +63,9 @@ Adding an entity as a sub-object of this panel (for example an mr-model, button, | --- | --- | --- | | entity | MREntity | the entity to be added. | - + -### 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 [MRDivEntity](#MRDivEntity) diff --git a/source/js-api/037MRPanelEntity.md b/source/js-api/037MRPanelEntity.md index f490fc1..218e8e1 100644 --- 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) ⇒ number * [.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 | MREntity | the entity to be added. | - + -### mrPanelEntity.remove(entity) +### mrPanelEntity.removeEntity(entity) Remove an entity as a sub-object of this entity. **Kind**: instance method of [MRPanelEntity](#MRPanelEntity)