Skip to content

Commit

Permalink
docs: add obj-model support
Browse files Browse the repository at this point in the history
  • Loading branch information
mwfarb committed Aug 14, 2024
1 parent 5cbfe82 commit 3bf633a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
5 changes: 5 additions & 0 deletions content/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ Thumbnail images can be clicked for a larger view. Multiple links are provided t
| Navigation Keys | [![][i-nav-keys]][i-nav-keys] | Using the VR Desktop keyboard keys to move around a scene. | [User:][user] [Tutorial][t-navigation] |
| Network Graph | [![][i-network]][i-network] | A web interface of MQTT message traffic | [Application][a-network] [Tutorial][t-network] |
| Null | | Any JSON attribute may be removed by setting it equal to `null` | [Graph:][grph] [Python][p-null] [Tutorial][t-null] |
| OBJ Model | [![][i-obj]][i-obj] | OBJ Models use Wavefront (.OBJ) files | [Object:][obj3] [Schema][s-obj] [Python][p-obj] |
| Object ID | | The scene graph name ID for the entity, must be unique in the scene. | [Graph:][grph] |
| Ocean | [![][i-ocean]][i-ocean] | Ocean | [Object:][obj3] [Schema][s-ocean] [Python][p-ocean] |
| Octahedron | [![][i-octahedron]][i-octahedron] | Octahedron Geometry | [Object:][obj3] [Schema][s-octahedron] [Python][p-octahedron] |
Expand Down Expand Up @@ -218,6 +219,8 @@ These effects are enabled in desktop and XR views. For reference, a list of [all
{:width="100px"}
[i-urdf]: /assets/img/examples/objects/urdf.png
{:width="100px"}
[i-obj]: /
{:width="100px"}
[i-hand]: /assets/img/xr/quest-2.png
{:width="100px"}
[i-hand]: /assets/img/xr/quest-2.png
Expand Down Expand Up @@ -470,6 +473,7 @@ These effects are enabled in desktop and XR views. For reference, a list of [all
[s-material]: /content/schemas/message/material
[s-modelUpdate]: /content/schemas/message/modelUpdate
[s-multisrc]: /content/schemas/message/multisrc
[s-obj]: /content/schemas/message/obj-model
[s-ocean]: /content/schemas/message/ocean
[s-octahedron]: /content/schemas/message/octahedron
[s-parent]: /content/schemas/message/entity#entity-generic-object-data-attributes
Expand Down Expand Up @@ -603,6 +607,7 @@ These effects are enabled in desktop and XR views. For reference, a list of [all
[p-modelUpdate]: https://github.com/arenaxr/arena-py/blob/master/examples/attributes/modelUpdate.py
[p-multisrc]: https://github.com/arenaxr/arena-py/blob/master/examples/attributes/multisrc.py
[p-null]: /content/python/objects#removing-object-attributes
[p-obj]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/obj_model.py
[p-ocean]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/ocean.py
[p-octahedron]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/octahedron.py
[p-parent]: https://github.com/arenaxr/arena-py/blob/master/examples/simple/earth-moon.py
Expand Down
11 changes: 9 additions & 2 deletions content/python/objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,12 @@ Create a thin [line]:
Line(start, end, color, ...)
```

## [OBJ](/content/python-api/objects/obj_model)
Create a [OBJ][obj] 3D model:
```python
ObjModel(url, joints, ...)
```

## [Ocean](/content/python-api/objects/ocean)
Create an animated [ocean] plane:
```python
Expand Down Expand Up @@ -296,12 +302,12 @@ Object(object_type, ...)
[dodecahedron]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/dodecahedron.py
[entity]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/entity.py
[gltf]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/gltf.py
[urdf]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/urdf.py
[hands]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/hands.py
[icosahedron]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/icosahedron.py
[image]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/image.py
[light]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/light.py
[line]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/line.py
[obj]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/obj_model.py
[ocean]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/ocean.py
[octahedron]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/octahedron.py
[parent]: https://github.com/arenaxr/arena-py/blob/master/examples/simple/earth-moon.py
Expand All @@ -315,7 +321,8 @@ Object(object_type, ...)
[text]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/text.py
[thick-line]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/thickline.py
[three-js]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/threejs_scene.py
[torus]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/torus.py
[torus-knot]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/torus_knot.py
[torus]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/torus.py
[triangle]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/triangle.py
[urdf]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/urdf.py
[videosphere]: https://github.com/arenaxr/arena-py/blob/master/examples/objects/videosphere.py

0 comments on commit 3bf633a

Please sign in to comment.