docs: arena-ui schema updates

content/schemas/message/arenaui-button-panel.md

@@ -0,0 +1,70 @@
+---
+title: ARENAUI Button Panel
+nav_order: 4
+layout: default
+parent: Objects Schema
+grand_parent: ARENA Objects
+---
+
+<!--CAUTION: This file is autogenerated from https://github.com/arenaxr/arena-schemas. Changes made here may be overwritten.-->
+
+
+ARENAUI Button Panel
+====================
+
+
+ARENAUI element which displays a vertical or horizontal panel of buttons.
+
+All wire objects have a set of basic attributes ```{object_id, action, type, persist, data}```. The ```data``` attribute defines the object-specific attributes
+
+ARENAUI Button Panel Attributes
+--------------------------------
+
+|Attribute|Type|Default|Description|Required|
+| :--- | :--- | :--- | :--- | :--- |
+|object_id|string||A uuid or otherwise unique identifier for this object|Yes|
+|persist|boolean|```True```|Persist this object in the database (default true = persist on server)|Yes|
+|type|string; Must be: ```object```|```'object'```|AFrame 3D Object|Yes|
+|action|string; One of: ```['create', 'delete', 'update', 'clientEvent']```|```'create'```|One of 3 basic Create/Update/Delete actions or a special client event action (e.g. a click)|Yes|
+|ttl|integer||When applied to an entity, the entity will remove itself from DOM after the specified number of seconds. Update is allowed, which will reset the timer to start from that moment.|No|
+|data|ARENAUI Button Panel data||Button Panel Data|Yes|
+
+### ARENAUI Button Panel Data Attributes
+
+|Attribute|Type|Default|Description|Required|
+| :--- | :--- | :--- | :--- | :--- |
+|object_type|string; Must be: ```arenaui-button-panel```|```arenaui-panel```|3D object type.|Yes|
+|buttons|array|```['Confirm', 'Cancel']```|Buttons|Yes|
+|title|string|``````|Title to display above buttons (optional).|Yes|
+|vertical|boolean|```False```|Vertical button layout|Yes|
+|font|string; One of: ```['Roboto', 'Roboto-Mono']```|```'Roboto'```|Font to use for button text|No|
+|parent|string||Parent's object_id. Child objects inherit attributes of their parent, for example scale and translation.|No|
+|position|[position](position)|```{'x': 0, 'y': 0, 'z': 0}```|3D object position|No|
+|rotation|[rotation](rotation)|```{'w': 1, 'x': 0, 'y': 0, 'z': 0}```|3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|No|
+|scale|[scale](scale)||3D object scale|No|
+|animation|[animation](animation)||Animate and tween values. |No|
+|armarker|[armarker](armarker)||A location marker (such as an AprilTag, a lightAnchor, or an UWB tag), used to anchor scenes, or scene objects, in the real world.|No|
+|click-listener|[click-listener](click-listener)||Object will listen for clicks|No|
+|box-collision-listener|[box-collision-listener](box-collision-listener)||Listen for bounding-box collisions with user camera and hands. Must be applied to an object or model with geometric mesh. Collisions are determined by course bounding-box overlaps|No|
+|collision-listener|string||Name of the collision-listener, default can be empty string. Collisions trigger click events|No|
+|color|string|```'#ffa500'```|(deprecated) Color of the material. Please use material.color instead.|No|
+|dynamic-body|[dynamic-body](dynamic-body)||Physics type attached to the object. |No|
+|goto-landmark|[goto-landmark](goto-landmark)||Teleports user to the landmark with the given name; Requires click-listener|No|
+|goto-url|[goto-url](goto-url)||Goto given URL; Requires click-listener|No|
+|hide-on-enter-ar|boolean; Must be: ```True```|```True```|Hide object when entering AR. Remove component to *not* hide|No|
+|hide-on-enter-vr|boolean; Must be: ```True```|```True```|Hide object when entering VR. Remove component to *not* hide|No|
+|show-on-enter-ar|boolean; Must be: ```True```|```True```|Show object when entering AR. Hidden otherwise|No|
+|show-on-enter-vr|boolean; Must be: ```True```|```True```|Show object when entering VR. Hidden otherwise|No|
+|impulse|[impulse](impulse)||The force applied using physics. Requires click-listener|No|
+|landmark|[landmark](landmark)||Define entities as a landmark; Landmarks appears in the landmark list and you can move (teleport) to them; You can define the behavior of the teleport: if you will be at a fixed or random distance, looking at the landmark, fixed offset or if it is constrained by a navmesh (when it exists)|No|
+|material-extras|[material-extras](material-extras)||Define extra material properties, namely texture encoding, whether to render the material's color and render order. The properties set here access directly Three.js material component. |No|
+|shadow|[shadow](shadow)||shadow|No|
+|sound|[sound](sound)||The sound component defines the entity as a source of sound or audio. The sound component is positional and is thus affected by the component's position. |No|
+|textinput|[textinput](textinput)||Opens an HTML prompt when clicked. Sends text input as an event on MQTT. Requires click-listener.|No|
+|url|string||Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)|No|
+|screenshareable|boolean|```True```|Whether or not a user can screenshare on an object|No|
+|remote-render|[remote-render](remote-render)||Whether or not an object should be remote rendered [Experimental]|No|
+|video-control|[video-control](video-control)||Video Control|No|
+|attribution|[attribution](attribution)||Attribution Component. Saves attribution data in any entity.|No|
+|particle-system|[particle-system](particle-system)||Particle system component for A-Frame. |No|
+|spe-particles|[spe-particles](spe-particles)||GPU based particle systems in A-Frame. |No|

content/schemas/message/arenaui-card.md

@@ -0,0 +1,77 @@
+---
+title: ARENAUI Card Panel
+nav_order: 5
+layout: default
+parent: Objects Schema
+grand_parent: ARENA Objects
+---
+
+<!--CAUTION: This file is autogenerated from https://github.com/arenaxr/arena-schemas. Changes made here may be overwritten.-->
+
+
+ARENAUI Card Panel
+==================
+
+
+ARENAUI element which displays text and optionally an image.
+
+All wire objects have a set of basic attributes ```{object_id, action, type, persist, data}```. The ```data``` attribute defines the object-specific attributes
+
+ARENAUI Card Panel Attributes
+------------------------------
+
+|Attribute|Type|Default|Description|Required|
+| :--- | :--- | :--- | :--- | :--- |
+|object_id|string||A uuid or otherwise unique identifier for this object|Yes|
+|persist|boolean|```True```|Persist this object in the database (default true = persist on server)|Yes|
+|type|string; Must be: ```object```|```'object'```|AFrame 3D Object|Yes|
+|action|string; One of: ```['create', 'delete', 'update', 'clientEvent']```|```'create'```|One of 3 basic Create/Update/Delete actions or a special client event action (e.g. a click)|Yes|
+|ttl|integer||When applied to an entity, the entity will remove itself from DOM after the specified number of seconds. Update is allowed, which will reset the timer to start from that moment.|No|
+|data|ARENAUI Card Panel data||Card Panel Data|Yes|
+
+### ARENAUI Card Panel Data Attributes
+
+|Attribute|Type|Default|Description|Required|
+| :--- | :--- | :--- | :--- | :--- |
+|object_type|string; Must be: ```arenaui-card```|```arenaui-card-panel```|3D object type.|Yes|
+|title|string|``````|Title|Yes|
+|body|string|``````|This is the text body of the card.|Yes|
+|bodyAlign|string; One of: ```['left', 'center', 'right', 'justify']```|```left```|Body Text Alignment|No|
+|img|string|``````|This image will be embedded alongside the body text|Yes|
+|imgCaption|string|``````|This will caption the image|No|
+|imgDirection|string; One of: ```['left', 'right']```|```'right'```|Image Direction|No|
+|imgSize|string; One of: ```['cover', 'contain', 'stretch']```|```cover```|Image sizing|No|
+|fontSize|number|```0.035```|Font Size|No|
+|widthScale|number|```1```|Width scale multiplier|No|
+|closeButton|boolean|```True```|Show close button|No|
+|font|string; One of: ```['Roboto', 'Roboto-Mono']```|```'Roboto'```|Font to use for button text|No|
+|parent|string||Parent's object_id. Child objects inherit attributes of their parent, for example scale and translation.|No|
+|position|[position](position)|```{'x': 0, 'y': 0, 'z': 0}```|3D object position|No|
+|rotation|[rotation](rotation)|```{'w': 1, 'x': 0, 'y': 0, 'z': 0}```|3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|No|
+|scale|[scale](scale)||3D object scale|No|
+|animation|[animation](animation)||Animate and tween values. |No|
+|armarker|[armarker](armarker)||A location marker (such as an AprilTag, a lightAnchor, or an UWB tag), used to anchor scenes, or scene objects, in the real world.|No|
+|click-listener|[click-listener](click-listener)||Object will listen for clicks|No|
+|box-collision-listener|[box-collision-listener](box-collision-listener)||Listen for bounding-box collisions with user camera and hands. Must be applied to an object or model with geometric mesh. Collisions are determined by course bounding-box overlaps|No|
+|collision-listener|string||Name of the collision-listener, default can be empty string. Collisions trigger click events|No|
+|color|string|```'#ffa500'```|(deprecated) Color of the material. Please use material.color instead.|No|
+|dynamic-body|[dynamic-body](dynamic-body)||Physics type attached to the object. |No|
+|goto-landmark|[goto-landmark](goto-landmark)||Teleports user to the landmark with the given name; Requires click-listener|No|
+|goto-url|[goto-url](goto-url)||Goto given URL; Requires click-listener|No|
+|hide-on-enter-ar|boolean; Must be: ```True```|```True```|Hide object when entering AR. Remove component to *not* hide|No|
+|hide-on-enter-vr|boolean; Must be: ```True```|```True```|Hide object when entering VR. Remove component to *not* hide|No|
+|show-on-enter-ar|boolean; Must be: ```True```|```True```|Show object when entering AR. Hidden otherwise|No|
+|show-on-enter-vr|boolean; Must be: ```True```|```True```|Show object when entering VR. Hidden otherwise|No|
+|impulse|[impulse](impulse)||The force applied using physics. Requires click-listener|No|
+|landmark|[landmark](landmark)||Define entities as a landmark; Landmarks appears in the landmark list and you can move (teleport) to them; You can define the behavior of the teleport: if you will be at a fixed or random distance, looking at the landmark, fixed offset or if it is constrained by a navmesh (when it exists)|No|
+|material-extras|[material-extras](material-extras)||Define extra material properties, namely texture encoding, whether to render the material's color and render order. The properties set here access directly Three.js material component. |No|
+|shadow|[shadow](shadow)||shadow|No|
+|sound|[sound](sound)||The sound component defines the entity as a source of sound or audio. The sound component is positional and is thus affected by the component's position. |No|
+|textinput|[textinput](textinput)||Opens an HTML prompt when clicked. Sends text input as an event on MQTT. Requires click-listener.|No|
+|url|string||Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)|No|
+|screenshareable|boolean|```True```|Whether or not a user can screenshare on an object|No|
+|remote-render|[remote-render](remote-render)||Whether or not an object should be remote rendered [Experimental]|No|
+|video-control|[video-control](video-control)||Video Control|No|
+|attribution|[attribution](attribution)||Attribution Component. Saves attribution data in any entity.|No|
+|particle-system|[particle-system](particle-system)||Particle system component for A-Frame. |No|
+|spe-particles|[spe-particles](spe-particles)||GPU based particle systems in A-Frame. |No|

content/schemas/message/arenaui-prompt.md

@@ -0,0 +1,71 @@
+---
+title: ARENAUI Prompt
+nav_order: 6
+layout: default
+parent: Objects Schema
+grand_parent: ARENA Objects
+---
+
+<!--CAUTION: This file is autogenerated from https://github.com/arenaxr/arena-schemas. Changes made here may be overwritten.-->
+
+
+ARENAUI Prompt
+==============
+
+
+ARENAUI element which displays prompt with button actions.
+
+All wire objects have a set of basic attributes ```{object_id, action, type, persist, data}```. The ```data``` attribute defines the object-specific attributes
+
+ARENAUI Prompt Attributes
+--------------------------
+
+|Attribute|Type|Default|Description|Required|
+| :--- | :--- | :--- | :--- | :--- |
+|object_id|string||A uuid or otherwise unique identifier for this object|Yes|
+|persist|boolean|```True```|Persist this object in the database (default true = persist on server)|Yes|
+|type|string; Must be: ```object```|```'object'```|AFrame 3D Object|Yes|
+|action|string; One of: ```['create', 'delete', 'update', 'clientEvent']```|```'create'```|One of 3 basic Create/Update/Delete actions or a special client event action (e.g. a click)|Yes|
+|ttl|integer||When applied to an entity, the entity will remove itself from DOM after the specified number of seconds. Update is allowed, which will reset the timer to start from that moment.|No|
+|data|ARENAUI Prompt data||Prompt Data|Yes|
+
+### ARENAUI Prompt Data Attributes
+
+|Attribute|Type|Default|Description|Required|
+| :--- | :--- | :--- | :--- | :--- |
+|object_type|string; Must be: ```arenaui-prompt```|```arenaui-prompt```|3D object type.|Yes|
+|title|string|```Prompt```|Title|Yes|
+|description|string|```This is a prompt. Please confirm or cancel.```|Description|No|
+|buttons|array|```['Confirm', 'Cancel']```|Buttons|Yes|
+|width|number|```1.5```|Override width|Yes|
+|font|string; One of: ```['Roboto', 'Roboto-Mono']```|```'Roboto'```|Font to use for button text|No|
+|parent|string||Parent's object_id. Child objects inherit attributes of their parent, for example scale and translation.|No|
+|position|[position](position)|```{'x': 0, 'y': 0, 'z': 0}```|3D object position|No|
+|rotation|[rotation](rotation)|```{'w': 1, 'x': 0, 'y': 0, 'z': 0}```|3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|No|
+|scale|[scale](scale)||3D object scale|No|
+|animation|[animation](animation)||Animate and tween values. |No|
+|armarker|[armarker](armarker)||A location marker (such as an AprilTag, a lightAnchor, or an UWB tag), used to anchor scenes, or scene objects, in the real world.|No|
+|click-listener|[click-listener](click-listener)||Object will listen for clicks|No|
+|box-collision-listener|[box-collision-listener](box-collision-listener)||Listen for bounding-box collisions with user camera and hands. Must be applied to an object or model with geometric mesh. Collisions are determined by course bounding-box overlaps|No|
+|collision-listener|string||Name of the collision-listener, default can be empty string. Collisions trigger click events|No|
+|color|string|```'#ffa500'```|(deprecated) Color of the material. Please use material.color instead.|No|
+|dynamic-body|[dynamic-body](dynamic-body)||Physics type attached to the object. |No|
+|goto-landmark|[goto-landmark](goto-landmark)||Teleports user to the landmark with the given name; Requires click-listener|No|
+|goto-url|[goto-url](goto-url)||Goto given URL; Requires click-listener|No|
+|hide-on-enter-ar|boolean; Must be: ```True```|```True```|Hide object when entering AR. Remove component to *not* hide|No|
+|hide-on-enter-vr|boolean; Must be: ```True```|```True```|Hide object when entering VR. Remove component to *not* hide|No|
+|show-on-enter-ar|boolean; Must be: ```True```|```True```|Show object when entering AR. Hidden otherwise|No|
+|show-on-enter-vr|boolean; Must be: ```True```|```True```|Show object when entering VR. Hidden otherwise|No|
+|impulse|[impulse](impulse)||The force applied using physics. Requires click-listener|No|
+|landmark|[landmark](landmark)||Define entities as a landmark; Landmarks appears in the landmark list and you can move (teleport) to them; You can define the behavior of the teleport: if you will be at a fixed or random distance, looking at the landmark, fixed offset or if it is constrained by a navmesh (when it exists)|No|
+|material-extras|[material-extras](material-extras)||Define extra material properties, namely texture encoding, whether to render the material's color and render order. The properties set here access directly Three.js material component. |No|
+|shadow|[shadow](shadow)||shadow|No|
+|sound|[sound](sound)||The sound component defines the entity as a source of sound or audio. The sound component is positional and is thus affected by the component's position. |No|
+|textinput|[textinput](textinput)||Opens an HTML prompt when clicked. Sends text input as an event on MQTT. Requires click-listener.|No|
+|url|string||Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)|No|
+|screenshareable|boolean|```True```|Whether or not a user can screenshare on an object|No|
+|remote-render|[remote-render](remote-render)||Whether or not an object should be remote rendered [Experimental]|No|
+|video-control|[video-control](video-control)||Video Control|No|
+|attribution|[attribution](attribution)||Attribution Component. Saves attribution data in any entity.|No|
+|particle-system|[particle-system](particle-system)||Particle system component for A-Frame. |No|
+|spe-particles|[spe-particles](spe-particles)||GPU based particle systems in A-Frame. |No|

content/schemas/message/armarker.md

@@ -1,6 +1,6 @@
 ---
 title: ARMarker
-nav_order: 4
+nav_order: 7
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/attribution.md

@@ -1,6 +1,6 @@
 ---
 title: Attribution
-nav_order: 5
+nav_order: 8
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/box-collision-listener.md

@@ -1,6 +1,6 @@
 ---
 title: Box Collision Listener
-nav_order: 6
+nav_order: 9
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/box.md

@@ -1,6 +1,6 @@
 ---
 title: Box
-nav_order: 7
+nav_order: 10
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/capsule.md

@@ -1,6 +1,6 @@
 ---
 title: Capsule
-nav_order: 8
+nav_order: 11
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/circle.md

@@ -1,6 +1,6 @@
 ---
 title: Circle
-nav_order: 9
+nav_order: 12
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/click-listener.md

@@ -1,6 +1,6 @@
 ---
 title: Click Listener
-nav_order: 10
+nav_order: 13
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/cone.md

@@ -1,6 +1,6 @@
 ---
 title: Cone
-nav_order: 11
+nav_order: 14
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/cube.md

@@ -1,6 +1,6 @@
 ---
 title: Cube (deprecated; don't use)
-nav_order: 12
+nav_order: 15
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/cylinder.md

@@ -1,6 +1,6 @@
 ---
 title: Cylinder
-nav_order: 13
+nav_order: 16
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/dodecahedron.md

@@ -1,6 +1,6 @@
 ---
 title: Dodecahedron
-nav_order: 14
+nav_order: 17
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/dynamic-body.md

@@ -1,6 +1,6 @@
 ---
 title: Physics
-nav_order: 15
+nav_order: 18
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/entity.md

@@ -1,6 +1,6 @@
 ---
 title: Entity (generic object)
-nav_order: 16
+nav_order: 19
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/environment-presets.md

@@ -1,6 +1,6 @@
 ---
 title: Environment Presets
-nav_order: 17
+nav_order: 20
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/event.md

@@ -1,6 +1,6 @@
 ---
 title: Event
-nav_order: 18
+nav_order: 21
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/gltf-model-lod.md

@@ -1,6 +1,6 @@
 ---
 title: GLTF Model Level of Detail
-nav_order: 19
+nav_order: 22
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects

content/schemas/message/gltf-model.md

@@ -1,6 +1,6 @@
 ---
 title: GLTF Model
-nav_order: 20
+nav_order: 23
 layout: default
 parent: Objects Schema
 grand_parent: ARENA Objects