Skip to content

Commit

Permalink
πŸ‘· MRjs - Auto Generated Docs πŸ‘·
Browse files Browse the repository at this point in the history
Changes from `github.com/Volumetrics-io/mrjs` at b28e4fb1625761626e22a237924edf2041c712ae

-includes folder updates: `js-api`, `js-api-utils`, `js-api-extras`
  • Loading branch information
github-actions[bot] committed Apr 5, 2024
1 parent d6c26b4 commit 304c40b
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
4 changes: 2 additions & 2 deletions source/js-api-utils/000HTML.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Useful namespace for helping with html utility functions
Given the path returns an absolute path resolved so relative linking works as expected.

**Kind**: static method of [<code>html</code>](#html)
**Returns**: <code>string</code> - a.href - the absolute path
**Returns**: <code>string</code> - a.href - the absolute path (or paths)

| Param | Type | Description |
| --- | --- | --- |
| path | <code>string</code> | either a relative or full path inputted to an element. |
| path | <code>string</code> | either a relative or full path inputted to an element. This can also be a path that has items separated by ',' so that you can resolve multiple items at once, since we allow users to send us multiple files that way. |
| baseUrl | <code>string</code> | a separate entry for if you want your url to start differently. this defaults to your window.location.origin. Additionally removes all queries from the end of the url, leaving the input as just the origin and its pathname. For ex: 'https://example.com/images/photo.png?version=2' becomes 'https://example.com/images/photo.png' |

<a name="html.removeUrlQueries"></a>
Expand Down
28 changes: 27 additions & 1 deletion source/js-api-utils/011Model.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Useful namespace for helping with Model utility functions

* [model](#model) : <code>object</code>
* [.loadDAE(filePath)](#model.loadDAE) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
* [.loadOBJ(filePath)](#model.loadOBJ) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
* [.loadOBJWithMTL(filePath)](#model.loadOBJWithMTL) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
* [.loadFBX(filePath)](#model.loadFBX) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
* [.loadGLTF(filePath)](#model.loadGLTF) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
* [.loadSTL(filePath)](#model.loadSTL) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
Expand All @@ -31,6 +33,30 @@ Loads Collada file
| --- | --- | --- |
| filePath | <code>string</code> | The path to the file(s) needing to be loaded. For now this only supports the full path and the relative path directly to the file. |

<a name="model.loadOBJ"></a>

### model.loadOBJ(filePath) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
Loads OBJ file

**Kind**: static method of [<code>model</code>](#model)
**Returns**: <code>Promise.&lt;THREE.Mesh&gt;</code> - - the promise of the loaded mesh object.

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>string</code> | The path to the file(s) needing to be loaded. For now this only supports the full path and the relative path directly to the file. |

<a name="model.loadOBJWithMTL"></a>

### model.loadOBJWithMTL(filePath) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
Loads OBJ file with externally hosted MTL file

**Kind**: static method of [<code>model</code>](#model)
**Returns**: <code>Promise.&lt;THREE.Mesh&gt;</code> - - the promise of the loaded mesh object.

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>string</code> | The path of the form '/path/to/mtlFile.mtl,/path/to/objFile.obj'. |

<a name="model.loadFBX"></a>

### model.loadFBX(filePath) β‡’ <code>Promise.&lt;THREE.Mesh&gt;</code>
Expand Down Expand Up @@ -90,5 +116,5 @@ The main loading function
| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>string</code> | The path to the file(s) needing to be loaded. For now this only supports the full path and the relative path directly to the file. |
| extension | <code>string</code> | The extension of the file type. Current allowed extensions are `fbx`, `glb`, and `stl`. |
| extension | <code>string</code> | The extension of the file type. Current allowed extensions are `dae`, fbx`, `glb`, `obj`, and `stl`. |

0 comments on commit 304c40b

Please sign in to comment.