Skip to content

Commit

Permalink
πŸ‘· MR.js - Auto Generated Docs πŸ‘·
Browse files Browse the repository at this point in the history
Changes at d761fd670594923360459bb30ac501aedb093536
  • Loading branch information
github-actions[bot] committed Jan 25, 2024
1 parent acd8780 commit b5f0ad8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions source/pages/02Javascript API.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ The default representation of an MRSystem to be expanded upon by actual details
* [.MRSystem](#MRSystem+MRSystem)
* [new exports.MRSystem(useComponents, frameRate)](#new_MRSystem+MRSystem_new)
* [.alwaysNeedsSystemUpdate()](#MRSystem+alwaysNeedsSystemUpdate) β‡’ <code>boolean</code>
* [.alwaysNeedsSystemUpdate()](#MRSystem+alwaysNeedsSystemUpdate)
* [.needsSystemUpdate()](#MRSystem+needsSystemUpdate) β‡’ <code>boolean</code>
* [.needsSystemUpdate()](#MRSystem+needsSystemUpdate)
* [._update(deltaTime, frame)](#MRSystem+_update)
Expand Down Expand Up @@ -102,6 +103,13 @@ Useful for readability and to not need to check against undefined often.

**Kind**: instance method of [<code>MRSystem</code>](#MRSystem)
**Returns**: <code>boolean</code> - true if the internal _needsSystemUpdate is set to 'undefined', false otherwise.
<a name="MRSystem+alwaysNeedsSystemUpdate"></a>

### mrSystem.alwaysNeedsSystemUpdate()
Sets the system ito always run (true) or to be in a state that allows for toggling on and off (false).
Useful for readability and to not need to check against undefined often.

**Kind**: instance method of [<code>MRSystem</code>](#MRSystem)
<a name="MRSystem+needsSystemUpdate"></a>

### mrSystem.needsSystemUpdate() β‡’ <code>boolean</code>
Expand Down Expand Up @@ -1547,6 +1555,8 @@ creates and manages WebXR anchors in the MR scene.
* [AnchorSystem](#AnchorSystem) ⇐ <code>MRSystem</code>
* [.AnchorSystem](#AnchorSystem+AnchorSystem)
* [new exports.AnchorSystem()](#new_AnchorSystem+AnchorSystem_new)
* [.needsSystemUpdate()](#AnchorSystem+needsSystemUpdate) β‡’ <code>boolean</code>
* [.needsSystemUpdate()](#AnchorSystem+needsSystemUpdate)
* [.update(deltaTime, frame)](#AnchorSystem+update)
* [.attachedComponent(entity)](#AnchorSystem+attachedComponent)
* [.updatedComponent(entity)](#AnchorSystem+updatedComponent)
Expand All @@ -1569,6 +1579,22 @@ creates and manages WebXR anchors in the MR scene.
#### new exports.AnchorSystem()
AnchorSystem's default constructor including setting up event listeners for XR initialization, user interaction, and the MRPlaneManager

<a name="AnchorSystem+needsSystemUpdate"></a>

### anchorSystem.needsSystemUpdate() β‡’ <code>boolean</code>
Getter to checks if we need to run this system's update call. Overridden implementation returns true if there are any items in this
systems anchoringQueue that need to be run OR the default systemUpdateCheck is true
(see [MRSystem.needsSystemUpdate](https://docs.mrjs.io/javascript-api/#mrsystem.needssystemupdate) for default).

**Kind**: instance method of [<code>AnchorSystem</code>](#AnchorSystem)
**Returns**: <code>boolean</code> - true if the system is in a state where this system is needed to update, false otherwise
<a name="AnchorSystem+needsSystemUpdate"></a>

### anchorSystem.needsSystemUpdate()
Since this class overrides the default `get` for the `needsSystemUpdate` call, the `set` pair is needed for javascript to be happy.
Relies on the parent's implementation. (see [MRSystem.needsSystemUpdate](https://docs.mrjs.io/javascript-api/#mrsystem.needssystemupdate) for default).

**Kind**: instance method of [<code>AnchorSystem</code>](#AnchorSystem)
<a name="AnchorSystem+update"></a>

### anchorSystem.update(deltaTime, frame)
Expand Down

0 comments on commit b5f0ad8

Please sign in to comment.