Skip to content

Commit 4802ab2

Browse files
mwfarbmwfarb
committed
docs: update render support
1 parent 10de7b5 commit 4802ab2

File tree

1 file changed

+55
-53
lines changed

1 file changed

+55
-53
lines changed

‎content/schemas/render-support.md

Lines changed: 55 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -13,48 +13,48 @@ The ARENA MQTT and Persistance system of communication and storage support the f
1313
- [**Python Changelog**](https://github.com/arenaxr/arena-py/blob/master/CHANGELOG.md)
1414
- [**Unity Changelog**](https://github.com/arenaxr/arena-unity/blob/main/CHANGELOG.md)
1515

16-
| ARENA Entity | Web | Python | Unity | Description |
17-
| ---------------------- | ------ | ------ | ------ | ------------------------------------------------------------- |
18-
| `arenaui-button-panel` | 1.21.0 | 0.6.0 | - | Flat UI displays a vertical or horizontal panel of buttons |
19-
| `arenaui-card` | 1.21.0 | 0.6.0 | - | Flat UI displays text and optionally an image |
20-
| `arenaui-prompt` | 1.21.0 | 0.6.0 | - | Flat UI displays prompt with button actions |
21-
| `box` | 1.0.0 | 0.1.12 | 0.0.1 | Box geometry |
22-
| `capsule` | 1.11.0 | 0.9.0 | 0.0.12 | Capsule geometry |
23-
| `circle` | 1.0.0 | 0.1.12 | 0.0.11 | Circle geometry |
24-
| `cone` | 1.0.0 | 0.1.12 | 0.0.11 | Cone geometry |
25-
| `cylinder` | 1.0.0 | 0.1.12 | 0.0.1 | Cylinder geometry |
26-
| `dodecahedron` | 1.0.0 | 0.1.12 | 0.0.12 | Dodecahedron geometry |
27-
| `entity` | 1.0.0 | 0.1.12 | 0.0.1 | Entities are the base of all objects in the scene. |
28-
| `environment` | 1.0.0 | - | - | A-Frame Environment and presets. |
29-
| `gaussian_splatting` | 1.24.0 | 0.9.0 | - | Load a Gaussian Splat model |
30-
| `gltf-model` | 1.0.0 | 0.1.12 | 0.0.2 | Load a GLTF model |
31-
| `icosahedron` | 1.0.0 | 0.1.12 | 0.0.11 | Icosahedron geometry |
32-
| `image` | 1.0.0 | 0.1.12 | 0.0.7 | Display an image on a plane |
33-
| `light` | 1.0.0 | 0.1.12 | 0.0.5 | A light |
34-
| `line` | 1.0.0 | 0.1.12 | 0.9.0 | Draw a line |
35-
| `obj-model` | 1.28.0 | 0.10.1 | - | Load a OBJ model |
36-
| `ocean` | 1.18.0 | 0.9.0 | - | Oceans, water |
37-
| `octahedron` | 1.0.0 | 0.1.12 | 0.0.11 | Octahedron geometry |
38-
| `pcd-model` | 1.0.0 | 0.9.0 | - | Load a PCD model |
39-
| `plane` | 1.0.0 | 0.1.12 | 0.0.1 | Plane geometry |
40-
| `post-processing` | 1.20.0 | - | - | These effects are enabled in desktop and XR views |
41-
| `program` | 1.0.0 | 0.9.0 | N/A | ARENA program data |
42-
| `renderer-settings` | 1.0.0 | - | - | These settings are fed into three.js WebGLRenderer properties |
43-
| `ring` | 1.0.0 | 0.1.12 | 0.0.11 | Ring geometry |
44-
| `roundedbox` | 1.14.0 | 0.9.0 | - | Rounded Box geometry |
45-
| `scene-options` | 1.0.0 | - | - | ARENA Scene Options |
46-
| `sphere` | 1.0.0 | 0.1.12 | 0.0.1 | Sphere geometry |
47-
| `tetrahedron` | 1.0.0 | 0.1.12 | 0.0.12 | Tetrahedron geometry |
48-
| `text` | 1.0.0 | 0.1.12 | 0.3.0 | Display text |
49-
| `thickline` | 1.0.0 | 0.1.12 | 0.4.0 | Draw a line that can have a custom width |
50-
| `threejs-scene` | 1.0.0 | 0.9.0 | - | Load a `three.js` Scene |
51-
| `torus` | 1.0.0 | 0.1.12 | 0.0.11 | Torus geometry |
52-
| `torusKnot` | 1.0.0 | 0.1.12 | 0.10.2 | Torus Knot geometry |
53-
| `triangle` | 1.0.0 | 0.1.12 | 0.0.12 | Triangle geometry |
54-
| `urdf-model` | 1.27.0 | 0.10.0 | - | Load a URDF model |
55-
| `videosphere` | 1.10.0 | 0.9.0 | N/A | Videosphere 360 video |
16+
| ARENA Entity | Web | Python | Unity | Description |
17+
| ---------------------- | ------ | ------ | ------ | ---------------------------------------------------------- |
18+
| `arenaui-button-panel` | 1.21.0 | 0.6.0 | - | Flat UI displays a vertical or horizontal panel of buttons |
19+
| `arenaui-card` | 1.21.0 | 0.6.0 | - | Flat UI displays text and optionally an image |
20+
| `arenaui-prompt` | 1.21.0 | 0.6.0 | - | Flat UI displays prompt with button actions |
21+
| `box` | 1.0.0 | 0.1.12 | 0.0.1 | Box geometry |
22+
| `capsule` | 1.11.0 | 0.9.0 | 0.0.12 | Capsule geometry |
23+
| `circle` | 1.0.0 | 0.1.12 | 0.0.11 | Circle geometry |
24+
| `cone` | 1.0.0 | 0.1.12 | 0.0.11 | Cone geometry |
25+
| `cylinder` | 1.0.0 | 0.1.12 | 0.0.1 | Cylinder geometry |
26+
| `dodecahedron` | 1.0.0 | 0.1.12 | 0.0.12 | Dodecahedron geometry |
27+
| `entity` | 1.0.0 | 0.1.12 | 0.0.1 | Entities are the base of all objects in the scene. |
28+
| `environment` | 1.0.0 | - | - | A-Frame Environment and presets. |
29+
| `gaussian_splatting` | 1.24.0 | 0.9.0 | - | Load a Gaussian Splat model |
30+
| `gltf-model` | 1.0.0 | 0.1.12 | 0.0.2 | Load a GLTF model |
31+
| `icosahedron` | 1.0.0 | 0.1.12 | 0.0.11 | Icosahedron geometry |
32+
| `image` | 1.0.0 | 0.1.12 | 0.0.7 | Display an image on a plane |
33+
| `light` | 1.0.0 | 0.1.12 | 0.0.5 | A light |
34+
| `line` | 1.0.0 | 0.1.12 | 0.9.0 | Draw a line |
35+
| `obj-model` | 1.28.0 | 0.10.1 | - | Load a OBJ model |
36+
| `ocean` | 1.18.0 | 0.9.0 | - | Oceans, water |
37+
| `octahedron` | 1.0.0 | 0.1.12 | 0.0.11 | Octahedron geometry |
38+
| `pcd-model` | 1.0.0 | 0.9.0 | - | Load a PCD model |
39+
| `plane` | 1.0.0 | 0.1.12 | 0.0.1 | Plane geometry |
40+
| `post-processing` | 1.20.0 | - | - | Visual effects enabled in desktop and XR views |
41+
| `program` | 1.0.0 | 0.9.0 | N/A | ARENA program data |
42+
| `renderer-settings` | 1.0.0 | - | - | `THREE.js` WebGLRenderer properties |
43+
| `ring` | 1.0.0 | 0.1.12 | 0.0.11 | Ring geometry |
44+
| `roundedbox` | 1.14.0 | 0.9.0 | - | Rounded Box geometry |
45+
| `scene-options` | 1.0.0 | - | - | ARENA Scene Options |
46+
| `sphere` | 1.0.0 | 0.1.12 | 0.0.1 | Sphere geometry |
47+
| `tetrahedron` | 1.0.0 | 0.1.12 | 0.0.12 | Tetrahedron geometry |
48+
| `text` | 1.0.0 | 0.1.12 | 0.3.0 | Display text |
49+
| `thickline` | 1.0.0 | 0.1.12 | 0.4.0 | Draw a line that can have a custom width |
50+
| `threejs-scene` | 1.0.0 | 0.9.0 | - | Load a `THREE.js` Scene |
51+
| `torus` | 1.0.0 | 0.1.12 | 0.0.11 | Torus geometry |
52+
| `torusKnot` | 1.0.0 | 0.1.12 | 0.10.2 | Torus Knot geometry |
53+
| `triangle` | 1.0.0 | 0.1.12 | 0.0.12 | Triangle geometry |
54+
| `urdf-model` | 1.27.0 | 0.10.0 | - | Load a URDF model |
55+
| `videosphere` | 1.10.0 | 0.9.0 | N/A | Videosphere 360 video |
5656

57-
| ARENA Component | Web | Python | Unity | Description |
57+
| ARENA Entity Component | Web | Python | Unity | Description |
5858
| ------------------------ | ------ | ------ | ------ | -------------------------------------------------------------------------------------------------- |
5959
| `animation-mixer` | 1.0.0 | 0.1.12 | 0.7.0 | A list of available animations in model file will play by default. |
6060
| `animation` | 1.0.0 | 0.1.12 | - | Animate and tween values. |
@@ -64,39 +64,41 @@ The ARENA MQTT and Persistance system of communication and storage support the f
6464
| `armarker` | 1.0.0 | 0.9.0 | - | A location marker used to anchor scenes, or scene objects, in the real world. |
6565
| `attribution` | 1.0.0 | 0.9.0 | - | Attribution component. Saves attribution data in any entity. |
6666
| `blip` | 1.23.0 | 0.9.0 | - | Objects animate in/out of the scene instead of appearing/disappearing instantly. |
67-
| `box-collision-listener` | 1.17.0 | 0.9.0 | - | AABB collision detection for entities with a mesh |
67+
| `box-collision-listener` | 1.17.0 | 0.9.0 | - | AABB collision detection for entities with a mesh. |
6868
| `buffer` | 1.0.0 | 0.1.12 | N/A | Transform geometry into a BufferGeometry: reduce memory usage while being harder to manipulate. |
6969
| `click-listener` | 1.0.0 | 0.1.12 | 0.8.0 | Keep track of mouse events and publish corresponding events |
7070
| `collision-listener` | 1.0.0 | 0.9.0 | - | Listen for collisions, callback on event. |
71-
| `dynamic-body` | 1.0.0 | 0.1.12 | - | Physics type attached to the object. |
71+
| `dynamic-body` | 1.0.0 | 0.1.12 | - | Physics dynamic type attached to the object. |
7272
| `geometry` | 1.0.0 | 0.1.12 | 0.10.0 | Primitive mesh geometry support in A-Frame. |
7373
| `gesture-detector` | 1.0.0 | N/A | - | Detect multi-finger touch gestures. Publish events accordingly. |
7474
| `gltf-model-lod` | 1.0.0 | 0.9.0 | - | GLTF lod switching between models based on distance. |
75-
| `gltf-morph` | 1.0.0 | 0.1.12 | - | GLTF 3D morphable model controls |
76-
| `goto-landmark` | 1.0.0 | 0.1.12 | - | Teleports user to the landmark with the given name; Requires click-listener |
77-
| `goto-url` | 1.0.0 | 0.1.12 | - | Goto given URL; Requires click-listener |
75+
| `gltf-morph` | 1.0.0 | 0.1.12 | - | GLTF 3D morphable model controls. |
76+
| `goto-landmark` | 1.0.0 | 0.1.12 | - | Teleports user to the landmark with the given name; Requires click-listener. |
77+
| `goto-url` | 1.0.0 | 0.1.12 | - | Goto given URL; Requires click-listener. |
7878
| `hide-on-enter-ar` | 1.8.0 | 0.1.12 | - | Hide object when entering AR. Remove component to _not_ hide. Was hide-in-ar-mode. |
7979
| `hide-on-enter-vr` | 1.8.0 | 0.1.12 | - | Hide object when entering VR. Remove component to _not_ hide. |
80-
| `impulse` | 1.0.0 | 0.1.12 | - | The force applied using physics. Requires click-listener |
81-
| `jitsi-video` | 1.0.0 | 0.1.39 | N/A | Apply a Jitsi video source to the geometry |
80+
| `impulse` | 1.0.0 | 0.1.12 | - | The force applied using physics. Requires click-listener. |
81+
| `jitsi-video` | 1.0.0 | 0.1.39 | N/A | Apply a Jitsi video source to the geometry. |
8282
| `landmark` | 1.0.0 | 0.1.13 | N/A | Define entities as a landmark; appear in landmarks list, you can move (teleport) to them. |
8383
| `look-at` | 1.0.0 | 0.1.13 | - | An entity can dynamically rotate or face towards another entity or position. |
8484
| `material-extras` | 1.0.0 | 0.9.0 | - | Extra material properties: texture encoding, whether to render the material's color, render order. |
8585
| `material` | 1.0.0 | 0.1.12 | 0.0.10 | The material properties of the object’s surface. |
86-
| `modelUpdate` | 1.17.0 | 0.9.0 | - | GLTF child components can also be manually manipulated |
86+
| `model-container` | 2.2.2 | 1.3.0 | - | Overrides absolute size for a 3D model. |
87+
| `modelUpdate` | 1.17.0 | 0.9.0 | - | GLTF child components can also be manually manipulated. |
8788
| `multisrc` | 1.0.0 | 0.9.0 | - | Define multiple visual sources applied to an object. |
8889
| `parent` | 1.0.0 | 0.1.12 | 0.0.7 | Parent's object_id. Child objects inherit attributes of their parent: scale and translation. |
89-
| `position` | 1.0.0 | 0.1.12 | 0.0.1 | 3D object position |
90+
| `position` | 1.0.0 | 0.1.12 | 0.0.1 | 3D object position. |
9091
| `remote-render` | N/A | N/A | 0.10.1 | Whether or not an object should be remote rendered |
9192
| `rotation` | 1.0.0 | 0.1.12 | 0.0.1 | 3D object rotation in quaternion representation; Right-handed coordinate system. |
92-
| `scale` | 1.0.0 | 0.1.12 | 0.0.1 | 3D object scale |
93-
| `screenshareable` | 1.0.0 | 0.1.12 | N/A | Screenshare-able component. Allows an object to be screenshared upon |
93+
| `scale` | 1.0.0 | 0.1.12 | 0.0.1 | 3D object scale. |
94+
| `screenshareable` | 1.0.0 | 0.1.12 | N/A | Screenshare-able component. Allows an object to be screenshared upon. |
9495
| `shadow` | 1.0.0 | 0.9.0 | 0.0.10 | Whether the entity cast/receives shadows onto the surrounding scene. |
9596
| `show-on-enter-ar` | 1.20.0 | 0.1.12 | - | Show object when entering AR. Hidden otherwise. |
9697
| `show-on-enter-vr` | 1.20.0 | 0.1.12 | - | Show object when entering VR. Hidden otherwise. |
9798
| `skipCache` | 1.0.0 | 0.1.12 | - | Disable retrieving the shared geometry object from the cache. |
9899
| `sound` | 1.0.0 | 0.1.12 | - | The sound component defines the entity as a source of sound or audio. |
99100
| `spe-particles` | 1.18.0 | 0.7.0 | - | GPU based particle systems in A-Frame: supports single textures and spritesheets. |
101+
| `static-body` | 1.0.0 | 0.1.12 | - | Physics static type attached to the object. |
100102
| `textinput` | 1.0.0 | 0.1.24 | - | Opens an HTML prompt when clicked. Sends text input as an event on MQTT. Requires click-listener. |
101103
| `video-control` | 1.0.0 | 0.3.0 | - | Adds a video to an entity and controls its playback. |
102-
| `visible` | 1.0.0 | 1.0.0 | 0.10.1 | Whether or not an object should rendered visible. |
104+
| `visible` | 1.0.0 | 0.1.12 | 0.10.1 | Whether or not an object should rendered visible. |

0 commit comments

Comments
 (0)