Skip to content

Commit

Permalink
docs: updated schema defaults
Browse files Browse the repository at this point in the history
  • Loading branch information
mwfarb committed Oct 19, 2023
1 parent 0be13a5 commit b494c42
Show file tree
Hide file tree
Showing 60 changed files with 207 additions and 180 deletions.
2 changes: 1 addition & 1 deletion content/schemas/message/Vector3.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Vector3
nav_order: 66
nav_order: 67
layout: default
parent: Objects Schema
grand_parent: ARENA Objects
Expand Down
11 changes: 6 additions & 5 deletions content/schemas/message/arenaui-button-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,15 @@ ARENAUI Button Panel 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|
|object_type|string; Must be: ```arenaui-button-panel```|```arenaui-button-panel```|3D object type.|Yes|
|buttons|array|```[{'name': 'Option 1'}, {'name': 'Option 2'}]```|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|
|theme|string; One of: ```['light', 'dark']```|```'light'```|Color Theme|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
21 changes: 11 additions & 10 deletions content/schemas/message/arenaui-card.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,23 @@ ARENAUI Card Panel 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|
|object_type|string; Must be: ```arenaui-card```|```arenaui-card```|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|
|imgSize|string; One of: ```['cover', 'contain', 'stretch']```|```'cover'```|Image sizing|No|
|textImageRatio|number|```0.5```|Text to Image Width Ratio|No|
|fontSize|number|```0.035```|Font Size|No|
|widthScale|number|```1```|Width scale multiplier|No|
|closeButton|boolean|```True```|Show close button|No|
|closeButton|boolean|```False```|Show close button|No|
|font|string; One of: ```['Roboto', 'Roboto-Mono']```|```'Roboto'```|Font to use for button text|No|
|theme|string; One of: ```['light', 'dark']```|```'light'```|Color Theme|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
9 changes: 5 additions & 4 deletions content/schemas/message/arenaui-prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,15 @@ ARENAUI Prompt 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|
|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|
|theme|string; One of: ```['light', 'dark']```|```'light'```|Color Theme|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
7 changes: 4 additions & 3 deletions content/schemas/message/armarker.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,12 @@ ARMarker Attributes
|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|publish|boolean|```False```|Publish detections. Send detections to external agents (e.g. external builder script that places new markers in the scene). If dynamic=true and publish=true, object position is not updated (left up to external agent).|No|
|dynamic|boolean|```False```|Dynamic tag, not used for localization. E.g., to move object to which this ARMarker component is attached to. Requires permissions to update the scene (if dynamic=true).|No|
|buildable|boolean|```False```|Whether tag has 'dynamic' toggled on click. Used to position a tag, then lock into position.|Yes|
|dynamic|boolean|```False```|Dynamic tag, not used for localization. E.g., to move object to which this ARMarker component is attached to. Requires permissions to update the scene (if dynamic=true).|Yes|
|ele|number|```0```|Tag elevation in meters.|No|
|lat|number|```0```|Tag latitude.|No|
|long|number|```0```|Tag longitude.|No|
|markerid|string|```0```|The marker id (e.g. for AprilTag 36h11 family, an integer in the range [0, 586])|Yes|
|markertype|string; One of: ```['apriltag_36h11', 'lightanchor', 'uwb']```|```apriltag_36h11```|The marker type (apriltag_36h11, lightanchor, uwb)|Yes|
|markerid|string|```'0'```|The marker id (e.g. for AprilTag 36h11 family, an integer in the range [0, 586])|Yes|
|markertype|string; One of: ```['apriltag_36h11', 'lightanchor', 'uwb']```|```'apriltag_36h11'```|The marker type (apriltag_36h11, lightanchor, uwb)|Yes|
|size|number|```150```|Tag size in millimeters|Yes|
|url|string|```''```|URL associated with the tag|No|
4 changes: 2 additions & 2 deletions content/schemas/message/box.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ Box Attributes
|segmentsWidth|integer|```1```|segments width|No|
|width|number|```1```|width|Yes|
|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
4 changes: 2 additions & 2 deletions content/schemas/message/capsule.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Capsule Attributes
|segmentsCap|integer|```18```|segments capsule|No|
|segmentsRadial|integer|```36```|segments radial|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
4 changes: 2 additions & 2 deletions content/schemas/message/circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Circle Attributes
|thetaLength|number|```360```|theta length|No|
|thetaStart|number|```0```|theta start|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
6 changes: 3 additions & 3 deletions content/schemas/message/cone.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ Cone Attributes
|height|number|```1```|height|Yes|
|openEnded|boolean|```False```|open ended|No|
|radiusBottom|number|```1```|radius bottom|Yes|
|radiusTop|number|```0.01```|radius top|No|
|radiusTop|number|```0.01```|radius top|Yes|
|segmentsHeight|integer|```18```|segments height|No|
|segmentsRadial|integer|```36```|segments radial|No|
|thetaLength|number|```360```|theta length|No|
|thetaStart|number|```0```|theta start|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
12 changes: 6 additions & 6 deletions content/schemas/message/cube.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Cube (deprecated; don't use) Attributes
|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|object_type|string; Must be: ```cube```|```cube```|3D object type.|Yes|
|depth|number|```1```|depth|No|
|height|number|```1```|height|No|
|depth|number|```1```|depth|Yes|
|height|number|```1```|height|Yes|
|segmentsDepth|integer|```1```|segments depth|No|
|segmentsHeight|integer|```1```|segments height|No|
|segmentsWidth|integer|```1```|segments width|No|
|width|number|```1```|width|No|
|width|number|```1```|width|Yes|
|parent|string||Parent's object_id. Child objects inherit attributes of their parent, for example scale and translation.|No|
|position|[position](position)||3D object position|No|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|No|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down Expand Up @@ -72,7 +72,7 @@ Cube (deprecated; don't use) Attributes
|look-at|string||The look-at component defines the behavior for an entity to dynamically rotate or face towards another entity or position. Use '#my-camera' to face the user camera, otherwise can take either a vec3 position or a query selector to another entity.|No|
|buffer|boolean|```True```|Transform geometry into a BufferGeometry to reduce memory usage at the cost of being harder to manipulate (geometries only: box, circle, cone, ...).|No|
|jitsi-video|[jitsi-video](jitsi-video)||Apply a jitsi video source to the geometry|No|
|material|[material](material)||The material properties of the object’s surface. |No|
|material|[material](material)|```{'color': '#7f7f7f'}```|The material properties of the object’s surface. |No|
|multisrc|[multisrc](multisrc)||Define multiple visual sources applied to an object.|No|
|screenshareable|boolean|```True```|Whether or not a user can screenshare on an object|No|
|skipCache|boolean|```False```|Disable retrieving the shared geometry object from the cache. (geometries only: box, circle, cone, ...).|No|
4 changes: 2 additions & 2 deletions content/schemas/message/cylinder.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ Cylinder Attributes
|thetaLength|number|```360```|theta length|No|
|thetaStart|number|```0```|theta start|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
4 changes: 2 additions & 2 deletions content/schemas/message/dodecahedron.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Dodecahedron Attributes
|detail|integer|```0```|detail|No|
|radius|number|```1```|radius|Yes|
|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|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
6 changes: 3 additions & 3 deletions content/schemas/message/entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Entity (generic object) Attributes
|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|object_type|string; Must be: ```entity```|```entity```|3D object type.|Yes|
|geometry|||geometry|No|
|geometry|[geometry](geometry)||The primitive mesh geometry.|No|
|panel|[panel](panel)||The rounded UI panel primitive.|No|
|parent|string||Parent's object_id. Child objects inherit attributes of their parent, for example scale and translation.|No|
|position|[position](position)||3D object position|No|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|No|
|position|[position](position)||3D object position|Yes|
|rotation|[rotation](rotation)||3D object rotation in quaternion representation; Right-handed coordinate system. Euler degrees are deprecated in wire message format.|Yes|
|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|
Expand Down
2 changes: 1 addition & 1 deletion content/schemas/message/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ Event Attributes
|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|source|string||The `object_id` of event origination. e.g camera or client program connection id.|Yes|
|position|[position](position)|```{'x': 0, 'y': 0, 'z': 0}```|The event destination position in 3D.|Yes|
|position|[position](position)||The event destination position in 3D.|Yes|
|clickPos|[vector3](vector3)|```{'x': 0, 'y': 1.6, 'z': 0}```|The event origination position in 3D.|No|
23 changes: 23 additions & 0 deletions content/schemas/message/geometry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Geometry
nav_order: 23
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.-->


Geometry
========


The primitive mesh geometry.

Geometry Attributes
--------------------

|Attribute|Type|Default|Description|Required|
| :--- | :--- | :--- | :--- | :--- |
|primitive|string; One of: ```['box', 'capsule', 'circle', 'cone', 'cylinder', 'dodecahedron', 'icosahedron', 'octahedron', 'plane', 'ring', 'roundedbox', 'sphere', 'tetrahedron', 'torus', 'torusKnot', 'triangle']```|```'box'```|The geometry primitive.|Yes|
Loading

0 comments on commit b494c42

Please sign in to comment.