Link Search Menu Expand Document

Rendering Support

The ARENA MQTT and Persistance system of communication and storage support the following entities and components for rendering and interaction. Version support for the arena-web-core repository for Web browsers, the arena-py repository for Python apps, and the arena-unity repository for Unity builds are detailed here.

ARENA Entity Web Python Unity Description
arenaui-button-panel 1.21.0 0.6.0 - Flat UI displays a vertical or horizontal panel of buttons
arenaui-card 1.21.0 0.6.0 - Flat UI displays text and optionally an image
arenaui-prompt 1.21.0 0.6.0 - Flat UI displays prompt with button actions
box 1.0.0 0.1.12 0.0.1 Box geometry
capsule 1.11.0 0.9.0 0.0.12 Capsule geometry
circle 1.0.0 0.1.12 0.0.11 Circle geometry
cone 1.0.0 0.1.12 0.0.11 Cone geometry
cylinder 1.0.0 0.1.12 0.0.1 Cylinder geometry
dodecahedron 1.0.0 0.1.12 0.0.12 Dodecahedron geometry
entity 1.0.0 0.1.12 0.0.1 Entities are the base of all objects in the scene.
environment 1.0.0 - - A-Frame Environment and presets.
gaussian_splatting 1.24.0 0.9.0 - Load a Gaussian Splat model
gltf-model 1.0.0 0.1.12 0.0.2 Load a GLTF model
icosahedron 1.0.0 0.1.12 0.0.11 Icosahedron geometry
image 1.0.0 0.1.12 0.0.7 Display an image on a plane
light 1.0.0 0.1.12 0.0.5 A light
line 1.0.0 0.1.12 0.9.0 Draw a line
obj-model 1.28.0 0.10.1 - Load a OBJ model
ocean 1.18.0 0.9.0 - Oceans, water
octahedron 1.0.0 0.1.12 0.0.11 Octahedron geometry
pcd-model 1.0.0 0.9.0 - Load a PCD model
plane 1.0.0 0.1.12 0.0.1 Plane geometry
post-processing 1.20.0 - - These effects are enabled in desktop and XR views
program 1.0.0 0.9.0 N/A ARENA program data
renderer-settings 1.0.0 - - These settings are fed into three.js WebGLRenderer properties
ring 1.0.0 0.1.12 0.0.11 Ring geometry
roundedbox 1.14.0 0.9.0 - Rounded Box geometry
scene-options 1.0.0 - - ARENA Scene Options
sphere 1.0.0 0.1.12 0.0.1 Sphere geometry
tetrahedron 1.0.0 0.1.12 0.0.12 Tetrahedron geometry
text 1.0.0 0.1.12 0.3.0 Display text
thickline 1.0.0 0.1.12 0.4.0 Draw a line that can have a custom width
threejs-scene 1.0.0 0.9.0 - Load a three.js Scene
torus 1.0.0 0.1.12 0.0.11 Torus geometry
torusKnot 1.0.0 0.1.12 0.10.2 Torus Knot geometry
triangle 1.0.0 0.1.12 0.0.12 Triangle geometry
urdf-model 1.27.0 0.10.0 - Load a URDF model
videosphere 1.10.0 0.9.0 N/A Videosphere 360 video
ARENA Component Web Python Unity Description
animation-mixer 1.0.0 0.1.12 0.7.0 A list of available animations in model file will play by default.
animation 1.0.0 0.1.12 - Animate and tween values.
arena-camera 1.23.3 N/A 0.11.0 Tracking camera movement in real time. Emits camera/VIO pose updates. (Format change 2023-11-02)
arena-hand 1.0.0 N/A - Tracking VR helmet controller movement in real time. Emits controller pose updates.
arena-user 1.23.3 0.8.0 0.11.0 Another user’s camera in the ARENA, renders Jitsi/displayName updates. (Format change 2023-11-02)
armarker 1.0.0 0.9.0 - A location marker used to anchor scenes, or scene objects, in the real world.
attribution 1.0.0 0.9.0 - Attribution component. Saves attribution data in any entity.
blip 1.23.0 0.9.0 - Objects animate in/out of the scene instead of appearing/disappearing instantly.
box-collision-listener 1.17.0 0.9.0 - AABB collision detection for entities with a mesh
buffer 1.0.0 0.1.12 N/A Transform geometry into a BufferGeometry: reduce memory usage while being harder to manipulate.
click-listener 1.0.0 0.1.12 0.8.0 Keep track of mouse events and publish corresponding events
collision-listener 1.0.0 0.9.0 - Listen for collisions, callback on event.
dynamic-body 1.0.0 0.1.12 - Physics type attached to the object.
geometry 1.0.0 0.1.12 0.10.0 Primitive mesh geometry support in A-Frame.
gesture-detector 1.0.0 N/A - Detect multi-finger touch gestures. Publish events accordingly.
gltf-model-lod 1.0.0 0.9.0 - GLTF lod switching between models based on distance.
gltf-morph 1.0.0 0.1.12 - GLTF 3D morphable model controls
goto-landmark 1.0.0 0.1.12 - Teleports user to the landmark with the given name; Requires click-listener
goto-url 1.0.0 0.1.12 - Goto given URL; Requires click-listener
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.
hide-on-enter-vr 1.8.0 0.1.12 - Hide object when entering VR. Remove component to not hide.
impulse 1.0.0 0.1.12 - The force applied using physics. Requires click-listener
jitsi-video 1.0.0 0.1.39 N/A Apply a Jitsi video source to the geometry
landmark 1.0.0 0.1.13 N/A Define entities as a landmark; appear in landmarks list, you can move (teleport) to them.
look-at 1.0.0 0.1.13 - An entity can dynamically rotate or face towards another entity or position.
material-extras 1.0.0 0.9.0 - Extra material properties: texture encoding, whether to render the material’s color, render order.
material 1.0.0 0.1.12 0.0.10 The material properties of the object’s surface.
modelUpdate 1.17.0 0.9.0 - GLTF child components can also be manually manipulated
multisrc 1.0.0 0.9.0 - Define multiple visual sources applied to an object.
parent 1.0.0 0.1.12 0.0.7 Parent’s object_id. Child objects inherit attributes of their parent: scale and translation.
position 1.0.0 0.1.12 0.0.1 3D object position
remote-render N/A N/A 0.10.1 Whether or not an object should be remote rendered
rotation 1.0.0 0.1.12 0.0.1 3D object rotation in quaternion representation; Right-handed coordinate system.
scale 1.0.0 0.1.12 0.0.1 3D object scale
screenshareable 1.0.0 0.1.12 N/A Screenshare-able component. Allows an object to be screenshared upon
shadow 1.0.0 0.9.0 0.0.10 Whether the entity cast/receives shadows onto the surrounding scene.
show-on-enter-ar 1.20.0 0.1.12 - Show object when entering AR. Hidden otherwise.
show-on-enter-vr 1.20.0 0.1.12 - Show object when entering VR. Hidden otherwise.
skipCache 1.0.0 0.1.12 - Disable retrieving the shared geometry object from the cache.
sound 1.0.0 0.1.12 - The sound component defines the entity as a source of sound or audio.
spe-particles 1.18.0 0.7.0 - GPU based particle systems in A-Frame: supports single textures and spritesheets.
textinput 1.0.0 0.1.24 - Opens an HTML prompt when clicked. Sends text input as an event on MQTT. Requires click-listener.
video-control 1.0.0 0.3.0 - Adds a video to an entity and controls its playback.
visible 1.0.0 1.0.0 0.10.1 Whether or not an object should rendered visible.