From b494c423e606bcfa4b6a133d7c5274ef1a50e094 Mon Sep 17 00:00:00 2001 From: mwfarb Date: Thu, 19 Oct 2023 09:12:58 -0400 Subject: [PATCH] docs: updated schema defaults --- content/schemas/message/Vector3.md | 2 +- .../schemas/message/arenaui-button-panel.md | 11 ++++---- content/schemas/message/arenaui-card.md | 21 ++++++++------- content/schemas/message/arenaui-prompt.md | 9 ++++--- content/schemas/message/armarker.md | 7 ++--- content/schemas/message/box.md | 4 +-- content/schemas/message/capsule.md | 4 +-- content/schemas/message/circle.md | 4 +-- content/schemas/message/cone.md | 6 ++--- content/schemas/message/cube.md | 12 ++++----- content/schemas/message/cylinder.md | 4 +-- content/schemas/message/dodecahedron.md | 4 +-- content/schemas/message/entity.md | 6 ++--- content/schemas/message/event.md | 2 +- content/schemas/message/geometry.md | 23 ++++++++++++++++ content/schemas/message/gltf-model-lod.md | 10 +++---- content/schemas/message/gltf-model.md | 8 +++--- content/schemas/message/goto-landmark.md | 2 +- content/schemas/message/goto-url.md | 2 +- content/schemas/message/icosahedron.md | 6 ++--- content/schemas/message/image.md | 12 ++++----- content/schemas/message/impulse.md | 2 +- content/schemas/message/jitsi-video.md | 2 +- content/schemas/message/landmark.md | 8 +++--- content/schemas/message/light.md | 20 +++++++------- content/schemas/message/line.md | 4 +-- content/schemas/message/material-extras.md | 4 +-- content/schemas/message/material.md | 2 +- content/schemas/message/modelUpdate.md | 2 +- content/schemas/message/multisrc.md | 2 +- content/schemas/message/ocean.md | 8 +++--- content/schemas/message/octahedron.md | 6 ++--- content/schemas/message/panel.md | 8 +++--- content/schemas/message/particle-system.md | 2 +- content/schemas/message/pcd-model.md | 10 +++---- content/schemas/message/plane.md | 6 ++--- content/schemas/message/position.md | 2 +- content/schemas/message/post-processing.md | 2 +- content/schemas/message/program.md | 2 +- content/schemas/message/remote-render.md | 2 +- content/schemas/message/renderer-settings.md | 2 +- content/schemas/message/ring.md | 10 +++---- content/schemas/message/rotation.md | 2 +- content/schemas/message/roundedbox.md | 6 ++--- content/schemas/message/scale.md | 2 +- content/schemas/message/scene-options.md | 2 +- content/schemas/message/shadow.md | 6 ++--- content/schemas/message/sound.md | 2 +- content/schemas/message/spe-particles.md | 2 +- content/schemas/message/sphere.md | 8 +++--- content/schemas/message/tetrahedron.md | 6 ++--- content/schemas/message/text.md | 26 +++++++++---------- content/schemas/message/textinput.md | 10 +++---- content/schemas/message/thickline.md | 10 +++---- content/schemas/message/threejs-scene.md | 8 +++--- content/schemas/message/torus.md | 8 +++--- content/schemas/message/torusKnot.md | 8 +++--- content/schemas/message/triangle.md | 6 ++--- content/schemas/message/video-control.md | 2 +- content/schemas/message/videosphere.md | 8 +++--- 60 files changed, 207 insertions(+), 180 deletions(-) create mode 100644 content/schemas/message/geometry.md diff --git a/content/schemas/message/Vector3.md b/content/schemas/message/Vector3.md index 9f00574e..66c9cf6a 100644 --- a/content/schemas/message/Vector3.md +++ b/content/schemas/message/Vector3.md @@ -1,6 +1,6 @@ --- title: Vector3 -nav_order: 66 +nav_order: 67 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/arenaui-button-panel.md b/content/schemas/message/arenaui-button-panel.md index e4c3684d..d17dcf13 100644 --- a/content/schemas/message/arenaui-button-panel.md +++ b/content/schemas/message/arenaui-button-panel.md @@ -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| diff --git a/content/schemas/message/arenaui-card.md b/content/schemas/message/arenaui-card.md index a3ffe145..015d08c4 100644 --- a/content/schemas/message/arenaui-card.md +++ b/content/schemas/message/arenaui-card.md @@ -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| diff --git a/content/schemas/message/arenaui-prompt.md b/content/schemas/message/arenaui-prompt.md index fc33ec89..d762de12 100644 --- a/content/schemas/message/arenaui-prompt.md +++ b/content/schemas/message/arenaui-prompt.md @@ -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| diff --git a/content/schemas/message/armarker.md b/content/schemas/message/armarker.md index e04b826a..03457b37 100644 --- a/content/schemas/message/armarker.md +++ b/content/schemas/message/armarker.md @@ -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| diff --git a/content/schemas/message/box.md b/content/schemas/message/box.md index 0c81a3c2..268df941 100644 --- a/content/schemas/message/box.md +++ b/content/schemas/message/box.md @@ -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| diff --git a/content/schemas/message/capsule.md b/content/schemas/message/capsule.md index 690e3075..862fc738 100644 --- a/content/schemas/message/capsule.md +++ b/content/schemas/message/capsule.md @@ -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| diff --git a/content/schemas/message/circle.md b/content/schemas/message/circle.md index 0e0dedbc..44fa44f1 100644 --- a/content/schemas/message/circle.md +++ b/content/schemas/message/circle.md @@ -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| diff --git a/content/schemas/message/cone.md b/content/schemas/message/cone.md index ddc88c91..7e9889ed 100644 --- a/content/schemas/message/cone.md +++ b/content/schemas/message/cone.md @@ -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| diff --git a/content/schemas/message/cube.md b/content/schemas/message/cube.md index 4fc29c1a..6e187c9b 100644 --- a/content/schemas/message/cube.md +++ b/content/schemas/message/cube.md @@ -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| @@ -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| diff --git a/content/schemas/message/cylinder.md b/content/schemas/message/cylinder.md index 78052424..ba709b48 100644 --- a/content/schemas/message/cylinder.md +++ b/content/schemas/message/cylinder.md @@ -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| diff --git a/content/schemas/message/dodecahedron.md b/content/schemas/message/dodecahedron.md index 36177a72..efd9470b 100644 --- a/content/schemas/message/dodecahedron.md +++ b/content/schemas/message/dodecahedron.md @@ -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| diff --git a/content/schemas/message/entity.md b/content/schemas/message/entity.md index 2f6b41dc..eb89c541 100644 --- a/content/schemas/message/entity.md +++ b/content/schemas/message/entity.md @@ -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| diff --git a/content/schemas/message/event.md b/content/schemas/message/event.md index f8286664..985499dc 100644 --- a/content/schemas/message/event.md +++ b/content/schemas/message/event.md @@ -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| diff --git a/content/schemas/message/geometry.md b/content/schemas/message/geometry.md new file mode 100644 index 00000000..17183a17 --- /dev/null +++ b/content/schemas/message/geometry.md @@ -0,0 +1,23 @@ +--- +title: Geometry +nav_order: 23 +layout: default +parent: Objects Schema +grand_parent: ARENA Objects +--- + + + + +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| diff --git a/content/schemas/message/gltf-model-lod.md b/content/schemas/message/gltf-model-lod.md index 21e305ac..56fc54e0 100644 --- a/content/schemas/message/gltf-model-lod.md +++ b/content/schemas/message/gltf-model-lod.md @@ -1,6 +1,6 @@ --- title: GLTF Model Level of Detail -nav_order: 23 +nav_order: 24 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -20,7 +20,7 @@ GLTF Model Level of Detail Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | -|detailedUrl|string|``````|Alternative 'detailed' gltf model to load by URL|No| -|detailedDistance|number|```10```|At what distance to switch between the models|No| -|updateRate|number|```333```|How often user camera is checked for LOD (default 333ms)|No| -|retainCache|boolean|```False```|Whether to skip freeing the detailed model from browser cache (default false)|No| +|detailedUrl|string|```''```|Alternative 'detailed' gltf model to load by URL|Yes| +|detailedDistance|number|```10```|At what distance to switch between the models|Yes| +|updateRate|number|```333```|How often user camera is checked for LOD (default 333ms)|Yes| +|retainCache|boolean|```False```|Whether to skip freeing the detailed model from browser cache (default false)|Yes| diff --git a/content/schemas/message/gltf-model.md b/content/schemas/message/gltf-model.md index f71e2bd5..7cd9827c 100644 --- a/content/schemas/message/gltf-model.md +++ b/content/schemas/message/gltf-model.md @@ -1,6 +1,6 @@ --- title: GLTF Model -nav_order: 24 +nav_order: 25 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -38,9 +38,9 @@ GLTF Model Attributes |object_type|string; Must be: ```gltf-model```|```gltf-model```|3D object type.|Yes| |url|string||Model URL. Store files paths under 'store/users/' (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)|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|Yes| -|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.|Yes| -|scale|[scale](scale)|```{'x': 1, 'y': 1, 'z': 1}```|3D object scale|Yes| +|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|Yes| |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| diff --git a/content/schemas/message/goto-landmark.md b/content/schemas/message/goto-landmark.md index 387c913e..b0c1a756 100644 --- a/content/schemas/message/goto-landmark.md +++ b/content/schemas/message/goto-landmark.md @@ -1,6 +1,6 @@ --- title: Goto Landmark -nav_order: 25 +nav_order: 26 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/goto-url.md b/content/schemas/message/goto-url.md index df57796a..7c62bf36 100644 --- a/content/schemas/message/goto-url.md +++ b/content/schemas/message/goto-url.md @@ -1,6 +1,6 @@ --- title: Goto URL -nav_order: 26 +nav_order: 27 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/icosahedron.md b/content/schemas/message/icosahedron.md index 71812d17..77f8ab04 100644 --- a/content/schemas/message/icosahedron.md +++ b/content/schemas/message/icosahedron.md @@ -1,6 +1,6 @@ --- title: Icosahedron -nav_order: 27 +nav_order: 28 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -37,8 +37,8 @@ Icosahedron 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| diff --git a/content/schemas/message/image.md b/content/schemas/message/image.md index 1ab56cc9..47d22fa5 100644 --- a/content/schemas/message/image.md +++ b/content/schemas/message/image.md @@ -1,6 +1,6 @@ --- title: Image -nav_order: 28 +nav_order: 29 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -35,14 +35,14 @@ Image Attributes | :--- | :--- | :--- | :--- | :--- | |object_type|string; Must be: ```image```|```image```|3D object type.|Yes| |url|string||Model URL. Store files paths under 'store/users/' (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)|Yes| -|height|number|```1```|height|No| +|height|number|```1```|height|Yes| |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)|```{'x': 0, 'y': 0, 'z': 0}```|3D object position|Yes| -|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.|Yes| -|scale|[scale](scale)|```{'x': 1, 'y': 1, 'z': 1}```|3D object scale|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| |click-listener|[click-listener](click-listener)||Object will listen for clicks|No| diff --git a/content/schemas/message/impulse.md b/content/schemas/message/impulse.md index 33181303..09808f04 100644 --- a/content/schemas/message/impulse.md +++ b/content/schemas/message/impulse.md @@ -1,6 +1,6 @@ --- title: Impulse -nav_order: 29 +nav_order: 30 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/jitsi-video.md b/content/schemas/message/jitsi-video.md index 782152b6..71b3101a 100644 --- a/content/schemas/message/jitsi-video.md +++ b/content/schemas/message/jitsi-video.md @@ -1,6 +1,6 @@ --- title: Jitsi Video -nav_order: 30 +nav_order: 31 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/landmark.md b/content/schemas/message/landmark.md index 742560a8..808108d0 100644 --- a/content/schemas/message/landmark.md +++ b/content/schemas/message/landmark.md @@ -1,6 +1,6 @@ --- title: Landmark -nav_order: 31 +nav_order: 32 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -20,10 +20,10 @@ Landmark Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | -|randomRadiusMin|number|```0```|Minimum radius from the landmark to teleport to. (randomRadiusMax must > 0)|No| -|randomRadiusMax|number|```0```|Maximum radius from the landmark to teleport to.|No| +|randomRadiusMin|number|```0```|Minimum radius from the landmark to teleport to. (randomRadiusMax must > 0)|Yes| +|randomRadiusMax|number|```0```|Maximum radius from the landmark to teleport to.|Yes| |offsetPosition|[vector3](vector3)|```{'x': 0, 'y': 1.6, 'z': 0}```|Use as a static teleport x,y,z offset|No| |constrainToNavMesh|string; One of: ```['false', 'any', 'coplanar']```|```'false'```|Teleports should snap to navmesh. Valid values: 'false', 'any', 'coplanar'|No| |startingPosition|boolean|```False```|Set to true to use this landmark as a scene start (spawn) position. If several landmarks with startingPosition=true exist in a scene, one will be randomly selected.|No| -|lookAtLandmark|boolean|```True```|Set to true to make users face the landmark when teleported to it.|No| +|lookAtLandmark|boolean|```True```|Set to true to make users face the landmark when teleported to it.|Yes| |label|string|```''```|Landmark description to display in the landmark list|Yes| diff --git a/content/schemas/message/light.md b/content/schemas/message/light.md index 62f450f0..1997dfc8 100644 --- a/content/schemas/message/light.md +++ b/content/schemas/message/light.md @@ -1,6 +1,6 @@ --- title: Light -nav_order: 32 +nav_order: 33 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -38,13 +38,13 @@ Light Attributes |object_type|string; Must be: ```light```|```light```|3D object type.|Yes| |angle|number|```60```|Maximum extent of spot light from its direction (in degrees). NOTE: Spot light type only.|No| |castShadow|boolean|```False```|castShadow (point, spot, directional)|No| -|color|string|```#ffffff```|Light color.|No| -|decay|number|```1.0```|Amount the light dims along the distance of the light. NOTE: Point and Spot light type only.|No| -|distance|number|```0.0```|Distance where intensity becomes 0. If distance is 0, then the point light does not decay with distance. NOTE: Point and Spot light type only.|No| +|color|string|```'#ffffff'```|Light color.|Yes| +|decay|number|```1```|Amount the light dims along the distance of the light. NOTE: Point and Spot light type only.|No| +|distance|number|```0```|Distance where intensity becomes 0. If distance is 0, then the point light does not decay with distance. NOTE: Point and Spot light type only.|No| |groundColor|string|```'#ffffff'```|Light color from below. NOTE: Hemisphere light type only|No| -|intensity|number|```1```|Light strength.|No| +|intensity|number|```1```|Light strength.|Yes| |light|[light](light)||DEPRECATED: data.light.[property] is deprecated, use object_type: light and data.[property] instead.|No| -|penumbra|number|```0.0```|Percent of the spotlight cone that is attenuated due to penumbra. NOTE: Spot light type only.|No| +|penumbra|number|```0```|Percent of the spotlight cone that is attenuated due to penumbra. NOTE: Spot light type only.|No| |shadowBias|number|```0```|shadowBias (castShadow=true)|No| |shadowCameraBottom|number|```-5```|shadowCameraBottom (castShadow=true)|No| |shadowCameraFar|number|```500```|shadowCameraFar (castShadow=true)|No| @@ -58,11 +58,11 @@ Light Attributes |shadowMapWidth|number|```512```|shadowMapWidth (castShadow=true)|No| |shadowRadius|number|```1```|shadowRadius (castShadow=true)|No| |target|string|```'None'```|Id of element the spot should point to. set to null to transform spotlight by orientation, pointing to it’s -Z axis. NOTE: Spot light type only.|No| -|type|string; One of: ```['ambient', 'directional', 'hemisphere', 'point', 'spot']```|```directional```|One of ambient, directional, hemisphere, point, spot.|No| +|type|string; One of: ```['ambient', 'directional', 'hemisphere', 'point', 'spot']```|```'directional'```|One of ambient, directional, hemisphere, point, spot.|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| -|scale|[scale](scale)|```{'x': 1, 'y': 1, 'z': 1}```|3D object scale|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| |click-listener|[click-listener](click-listener)||Object will listen for clicks|No| diff --git a/content/schemas/message/line.md b/content/schemas/message/line.md index 0ab9748c..51dc9951 100644 --- a/content/schemas/message/line.md +++ b/content/schemas/message/line.md @@ -1,6 +1,6 @@ --- title: Line -nav_order: 33 +nav_order: 34 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -34,7 +34,7 @@ Line Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | |object_type|string; Must be: ```line```|```line```|3D object type.|Yes| -|color|string|```#7f7f7f```|Line color.|No| +|color|string|```'#74BEC1'```|Line color.|Yes| |end|[vector3](vector3)|```{'x': -0.5, 'y': -0.5, 'z': 0}```|End coordinate.|Yes| |opacity|number|```1```|Line opacity.|No| |start|[vector3](vector3)|```{'x': 0, 'y': 0.5, 'z': 0}```|Start point coordinate.|Yes| diff --git a/content/schemas/message/material-extras.md b/content/schemas/message/material-extras.md index c3bc7dc7..8e56ddc2 100644 --- a/content/schemas/message/material-extras.md +++ b/content/schemas/message/material-extras.md @@ -1,6 +1,6 @@ --- title: Material extras -nav_order: 34 +nav_order: 35 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -23,7 +23,7 @@ Material extras Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | |overrideSrc|string|```''```|Overrides the material source in all meshes of an object (e.g. a basic shape or a GLTF); Use, for example, to change the texture of a GLTF.|No| -|encoding|string; One of: ```['LinearEncoding', 'sRGBEncoding', 'GammaEncoding', 'RGBEEncoding', 'LogLuvEncoding', 'RGBM7Encoding', 'RGBM16Encoding', 'RGBDEncoding', 'BasicDepthPacking', 'RGBADepthPacking']```|```sRGBEncoding```|encoding|No| +|encoding|string; One of: ```['LinearEncoding', 'sRGBEncoding', 'GammaEncoding', 'RGBEEncoding', 'LogLuvEncoding', 'RGBM7Encoding', 'RGBM16Encoding', 'RGBDEncoding', 'BasicDepthPacking', 'RGBADepthPacking']```|```'sRGBEncoding'```|encoding|Yes| |colorWrite|boolean|```True```|Whether to render the material's color.|No| |renderOrder|number|```1```|Allows the default rendering order of scene graph objects to be overridden.|No| |transparentOccluder|boolean|```False```|If `true`, will set `colorWrite=false` and `renderOrder=0` to make the material a transparent occluder.|No| diff --git a/content/schemas/message/material.md b/content/schemas/message/material.md index b55bb31c..3609f2c1 100644 --- a/content/schemas/message/material.md +++ b/content/schemas/message/material.md @@ -1,6 +1,6 @@ --- title: Material -nav_order: 35 +nav_order: 36 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/modelUpdate.md b/content/schemas/message/modelUpdate.md index 8462a644..925759fd 100644 --- a/content/schemas/message/modelUpdate.md +++ b/content/schemas/message/modelUpdate.md @@ -1,6 +1,6 @@ --- title: GLTF Model Update -nav_order: 36 +nav_order: 37 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/multisrc.md b/content/schemas/message/multisrc.md index fff9ff49..3bbb83c5 100644 --- a/content/schemas/message/multisrc.md +++ b/content/schemas/message/multisrc.md @@ -1,6 +1,6 @@ --- title: Multi Source -nav_order: 37 +nav_order: 38 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/ocean.md b/content/schemas/message/ocean.md index ab276565..699d65b2 100644 --- a/content/schemas/message/ocean.md +++ b/content/schemas/message/ocean.md @@ -1,6 +1,6 @@ --- title: Ocean -nav_order: 38 +nav_order: 39 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -41,9 +41,9 @@ Ocean Attributes |amplitudeVariance|number|```0.3```|Wave amplitude variance.|No| |speed|number|```1```|Wave speed.|No| |speedVariance|number|```2```|Wave speed variance.|No| -|color|string|```#7AD2F7```|Wave color.|Yes| +|color|string|```'#7AD2F7'```|Wave color.|Yes| |opacity|number|```0.8```|Wave opacity.|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)|```{'w': -0.70711, 'x': 0.70711, '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)|```{'w': -0.70711, 'x': 0.70711, 'y': 0, 'z': 0}```|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| diff --git a/content/schemas/message/octahedron.md b/content/schemas/message/octahedron.md index e5684526..3ede5baa 100644 --- a/content/schemas/message/octahedron.md +++ b/content/schemas/message/octahedron.md @@ -1,6 +1,6 @@ --- title: Octahedron -nav_order: 39 +nav_order: 40 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -37,8 +37,8 @@ Octahedron 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| diff --git a/content/schemas/message/panel.md b/content/schemas/message/panel.md index 9c94c07f..2f035a9f 100644 --- a/content/schemas/message/panel.md +++ b/content/schemas/message/panel.md @@ -1,6 +1,6 @@ --- title: UI Panel -nav_order: 40 +nav_order: 41 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -20,6 +20,6 @@ UI Panel Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | -|depth|number|```0.05```|depth|No| -|height|number|```1```|height|No| -|width|number|```1```|width|No| +|depth|number|```0.05```|depth|Yes| +|height|number|```1```|height|Yes| +|width|number|```1```|width|Yes| diff --git a/content/schemas/message/particle-system.md b/content/schemas/message/particle-system.md index 1a3a99ff..b60d6d57 100644 --- a/content/schemas/message/particle-system.md +++ b/content/schemas/message/particle-system.md @@ -1,6 +1,6 @@ --- title: Particle System -nav_order: 41 +nav_order: 42 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/pcd-model.md b/content/schemas/message/pcd-model.md index 7f71ec87..bb10377b 100644 --- a/content/schemas/message/pcd-model.md +++ b/content/schemas/message/pcd-model.md @@ -1,6 +1,6 @@ --- title: PCD Model -nav_order: 42 +nav_order: 43 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -38,11 +38,11 @@ PCD Model Attributes |object_type|string; Must be: ```pcd-model```|```pcd-model```|3D object type.|Yes| |url|string||Model URL. Store files paths under 'store/users/' (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)|Yes| |pointSize|number|```0.01```|Size of the points|Yes| -|pointColor|string|```#7f7f7f```|Color of the points|No| +|pointColor|string|```'#7f7f7f'```|Color of the points|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|Yes| -|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.|Yes| -|scale|[scale](scale)|```{'x': 1, 'y': 1, 'z': 1}```|3D object scale|Yes| +|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|Yes| |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| diff --git a/content/schemas/message/plane.md b/content/schemas/message/plane.md index c2d269a3..2ab11708 100644 --- a/content/schemas/message/plane.md +++ b/content/schemas/message/plane.md @@ -1,6 +1,6 @@ --- title: Plane -nav_order: 43 +nav_order: 44 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -39,8 +39,8 @@ Plane 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| diff --git a/content/schemas/message/position.md b/content/schemas/message/position.md index 4971134e..0884c65d 100644 --- a/content/schemas/message/position.md +++ b/content/schemas/message/position.md @@ -1,6 +1,6 @@ --- title: Position -nav_order: 44 +nav_order: 45 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/post-processing.md b/content/schemas/message/post-processing.md index 2587b1bc..1111079c 100644 --- a/content/schemas/message/post-processing.md +++ b/content/schemas/message/post-processing.md @@ -1,6 +1,6 @@ --- title: Post-Processing Effects -nav_order: 45 +nav_order: 46 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/program.md b/content/schemas/message/program.md index b9d4809f..e18d2637 100644 --- a/content/schemas/message/program.md +++ b/content/schemas/message/program.md @@ -1,6 +1,6 @@ --- title: Program Data -nav_order: 46 +nav_order: 47 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/remote-render.md b/content/schemas/message/remote-render.md index 272ff304..2128f8d0 100644 --- a/content/schemas/message/remote-render.md +++ b/content/schemas/message/remote-render.md @@ -1,6 +1,6 @@ --- title: Remote Render -nav_order: 47 +nav_order: 48 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/renderer-settings.md b/content/schemas/message/renderer-settings.md index b5a0ecbf..485220fb 100644 --- a/content/schemas/message/renderer-settings.md +++ b/content/schemas/message/renderer-settings.md @@ -1,6 +1,6 @@ --- title: Renderer Settings -nav_order: 48 +nav_order: 49 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/ring.md b/content/schemas/message/ring.md index 4b7cb830..7ee34b9c 100644 --- a/content/schemas/message/ring.md +++ b/content/schemas/message/ring.md @@ -1,6 +1,6 @@ --- title: Ring -nav_order: 49 +nav_order: 50 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -34,15 +34,15 @@ Ring Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | |object_type|string; Must be: ```ring```|```ring```|3D object type.|Yes| -|radiusInner|number|```0.5```|radius inner|Yes| -|radiusOuter|number|```1```|radius outer|Yes| +|radiusInner|number|```0.8```|radius inner|Yes| +|radiusOuter|number|```1.2```|radius outer|Yes| |segmentsPhi|integer|```10```|segments phi|No| |segmentsTheta|integer|```32```|segments theta|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| diff --git a/content/schemas/message/rotation.md b/content/schemas/message/rotation.md index 1741370d..acf95a6a 100644 --- a/content/schemas/message/rotation.md +++ b/content/schemas/message/rotation.md @@ -1,6 +1,6 @@ --- title: Rotation -nav_order: 50 +nav_order: 51 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/roundedbox.md b/content/schemas/message/roundedbox.md index 9558c78e..04d6473f 100644 --- a/content/schemas/message/roundedbox.md +++ b/content/schemas/message/roundedbox.md @@ -1,6 +1,6 @@ --- title: Rounded Box -nav_order: 51 +nav_order: 52 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -40,8 +40,8 @@ Rounded Box Attributes |radius|number|```0.15```|radius of edge|Yes| |radiusSegments|integer|```10```|segments radius|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| diff --git a/content/schemas/message/scale.md b/content/schemas/message/scale.md index f53a9e6e..1c9226c3 100644 --- a/content/schemas/message/scale.md +++ b/content/schemas/message/scale.md @@ -1,6 +1,6 @@ --- title: Scale -nav_order: 52 +nav_order: 53 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/scene-options.md b/content/schemas/message/scene-options.md index a7e2de93..cf397052 100644 --- a/content/schemas/message/scene-options.md +++ b/content/schemas/message/scene-options.md @@ -1,6 +1,6 @@ --- title: Scene Options -nav_order: 53 +nav_order: 54 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/shadow.md b/content/schemas/message/shadow.md index 218e3116..ac1ccd48 100644 --- a/content/schemas/message/shadow.md +++ b/content/schemas/message/shadow.md @@ -1,6 +1,6 @@ --- title: Shadow -nav_order: 54 +nav_order: 55 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -20,5 +20,5 @@ Shadow Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | -|cast|boolean|```False```|Whether the entity casts shadows onto the surrounding scene|No| -|receive|boolean|```False```|Whether the entity receives shadows from the surrounding scene|No| +|cast|boolean|```False```|Whether the entity casts shadows onto the surrounding scene|Yes| +|receive|boolean|```False```|Whether the entity receives shadows from the surrounding scene|Yes| diff --git a/content/schemas/message/sound.md b/content/schemas/message/sound.md index a20f6865..c48378e0 100644 --- a/content/schemas/message/sound.md +++ b/content/schemas/message/sound.md @@ -1,6 +1,6 @@ --- title: Positional Sound -nav_order: 55 +nav_order: 56 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/spe-particles.md b/content/schemas/message/spe-particles.md index ffb72c7e..65131561 100644 --- a/content/schemas/message/spe-particles.md +++ b/content/schemas/message/spe-particles.md @@ -1,6 +1,6 @@ --- title: SPE Particles -nav_order: 56 +nav_order: 57 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/sphere.md b/content/schemas/message/sphere.md index 9c137efc..d20f658b 100644 --- a/content/schemas/message/sphere.md +++ b/content/schemas/message/sphere.md @@ -1,6 +1,6 @@ --- title: Sphere -nav_order: 57 +nav_order: 58 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -36,14 +36,14 @@ Sphere Attributes |object_type|string; Must be: ```sphere```|```sphere```|3D object type.|Yes| |phiLength|number|```360```|phi length|No| |phiStart|number|```0```|phi start|No| -|radius|number|```1```|radius|No| +|radius|number|```1```|radius|Yes| |segmentsHeight|integer|```18```|segments height|No| |segmentsWidth|integer|```36```|segments width|No| |thetaLength|number|```180```|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| diff --git a/content/schemas/message/tetrahedron.md b/content/schemas/message/tetrahedron.md index d7e2ebe6..22f0b23d 100644 --- a/content/schemas/message/tetrahedron.md +++ b/content/schemas/message/tetrahedron.md @@ -1,6 +1,6 @@ --- title: Tetrahedron -nav_order: 58 +nav_order: 59 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -37,8 +37,8 @@ Tetrahedron 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| diff --git a/content/schemas/message/text.md b/content/schemas/message/text.md index e7d83292..aeebc777 100644 --- a/content/schemas/message/text.md +++ b/content/schemas/message/text.md @@ -1,6 +1,6 @@ --- title: Text -nav_order: 59 +nav_order: 60 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -36,30 +36,30 @@ Text Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | |object_type|string; Must be: ```text```|```text```|3D object type.|Yes| -|align|; One of: ```['left', 'center', 'right']```|```left```|Multi-line text alignment (left, center, right).|No| +|align|string; One of: ```['left', 'center', 'right']```|```'left'```|Multi-line text alignment (left, center, right).|No| |alphaTest|number|```0.5```|Discard text pixels if alpha is less than this value.|No| -|anchor|; One of: ```['left', 'right', 'center', 'align']```|```center```|Horizontal positioning (left, center, right, align).|No| -|baseline|; One of: ```['top', 'center', 'bottom']```|```center```|Vertical positioning (top, center, bottom).|No| -|color|string|```white```|Text color.|No| -|font|string; One of: ```['aileronsemibold', 'dejavu', 'exo2bold', 'exo2semibold', 'kelsonsans', 'monoid', 'mozillavr', 'roboto', 'sourcecodepro']```|```roboto```|Font to render text, either the name of one of A-Frame's stock fonts or a URL to a font file|No| +|anchor|string; One of: ```['left', 'right', 'center', 'align']```|```'center'```|Horizontal positioning (left, center, right, align).|No| +|baseline|string; One of: ```['top', 'center', 'bottom']```|```'center'```|Vertical positioning (top, center, bottom).|No| +|color|string|```'#000000'```|Text color.|Yes| +|font|string; One of: ```['aileronsemibold', 'dejavu', 'exo2bold', 'exo2semibold', 'kelsonsans', 'monoid', 'mozillavr', 'roboto', 'sourcecodepro']```|```'roboto'```|Font to render text, either the name of one of A-Frame's stock fonts or a URL to a font file|Yes| |fontImage|string||Font image texture path to render text. Defaults to the font's name with extension replaced to .png. Don't need to specify if using a stock font. (derived from font name)|No| |height|number||Height of text block. (derived from text size)|No| |letterSpacing|number|```0```|Letter spacing in pixels.|No| |lineHeight|number||Line height in pixels. (derived from font file)|No| |negate|boolean|```True```|negate|No| -|opacity|number|```1.0```|Opacity, on a scale from 0 to 1, where 0 means fully transparent and 1 means fully opaque.|No| -|shader|; One of: ```['portal', 'flat', 'standard', 'sdf', 'msdf', 'ios10hls', 'skyshader', 'gradientshader']```|```sdf```|Shader used to render text.|No| -|side|; One of: ```['front', 'back', 'double']```|```double```|Side to render. (front, back, double)|No| +|opacity|number|```1```|Opacity, on a scale from 0 to 1, where 0 means fully transparent and 1 means fully opaque.|No| +|shader|string; One of: ```['portal', 'flat', 'standard', 'sdf', 'msdf', 'ios10hls', 'skyshader', 'gradientshader']```|```'sdf'```|Shader used to render text.|No| +|side|string; One of: ```['front', 'back', 'double']```|```'double'```|Side to render. (front, back, double)|Yes| |tabSize|number|```4```|Tab size in spaces.|No| |transparent|boolean|```True```|Whether text is transparent.|No| -|value|string|``````|The actual content of the text. Line breaks and tabs are supported with \n and \t.|No| -|whiteSpace|; One of: ```['normal', 'pre', 'nowrap']```|```normal```|How whitespace should be handled (i.e., normal, pre, nowrap).|No| +|value|string||The actual content of the text. Line breaks and tabs are supported with \n and \t.|Yes| +|whiteSpace|string; One of: ```['normal', 'pre', 'nowrap']```|```'normal'```|How whitespace should be handled (i.e., normal, pre, nowrap).|No| |width|number|```5```|Width in meters. (derived from geometry if exists)|No| |wrapCount|number|```40```|Number of characters before wrapping text (more or less).|No| |wrapPixels|number||Number of pixels before wrapping text. (derived from wrapCount)|No| |xOffset|number|```0```|X-offset to apply to add padding.|No| |zOffset|number|```0.001```|Z-offset to apply to avoid Z-fighting if using with a geometry as a background.|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| diff --git a/content/schemas/message/textinput.md b/content/schemas/message/textinput.md index 9f0225e7..a50d75cf 100644 --- a/content/schemas/message/textinput.md +++ b/content/schemas/message/textinput.md @@ -1,6 +1,6 @@ --- title: Text Input -nav_order: 60 +nav_order: 61 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -20,7 +20,7 @@ Text Input Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | -|on|string; One of: ```['mousedown', 'mouseup', 'mouseenter', 'mouseleave', 'triggerdown', 'triggerup', 'gripdown', 'gripup', 'menudown', 'menuup', 'systemdown', 'systemup', 'trackpaddown', 'trackpadup']```|```mousedown```|A case-sensitive string representing the event type to listen for, e.g. 'mousedown', 'mouseup'. See https://developer.mozilla.org/en-US/docs/Web/Events|No| -|title|string|```Text Input```|The prompt title|No| -|label|string|```Input text below (max is 140 characters)```|Text prompt label|No| -|placeholder|string|```Type here```|Text input place holder|No| +|on|string; One of: ```['mousedown', 'mouseup', 'mouseenter', 'mouseleave', 'triggerdown', 'triggerup', 'gripdown', 'gripup', 'menudown', 'menuup', 'systemdown', 'systemup', 'trackpaddown', 'trackpadup']```|```'mousedown'```|A case-sensitive string representing the event type to listen for, e.g. 'mousedown', 'mouseup'. See https://developer.mozilla.org/en-US/docs/Web/Events|Yes| +|title|string|```'Text Input'```|The prompt title|Yes| +|label|string|```'Input text below (max is 140 characters)'```|Text prompt label|Yes| +|placeholder|string|```'Type here'```|Text input place holder|Yes| diff --git a/content/schemas/message/thickline.md b/content/schemas/message/thickline.md index 80ec5625..91168775 100644 --- a/content/schemas/message/thickline.md +++ b/content/schemas/message/thickline.md @@ -1,6 +1,6 @@ --- title: Thickline -nav_order: 61 +nav_order: 62 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -34,10 +34,10 @@ Thickline Attributes |Attribute|Type|Default|Description|Required| | :--- | :--- | :--- | :--- | :--- | |object_type|string; Must be: ```thickline```|```thickline```|3D object type.|Yes| -|color|string|```#7f7f7f```|color|No| -|lineWidth|number|```5```|Line width|No| -|lineWidthStyler|string; One of: ```['default', 'grow', 'shrink', 'center-sharp', 'center-smooth', 'sine-wave']```|```default```|Allows defining the line width as a function of relative position p along the path of the line. By default it is set to a constant 1. You may also choose one of the preset functions|No| -|path|string|```-2 -1 0, 0 20 0, 10 -1 10```|Comma-separated list of x y z coordinates of the line vertices|Yes| +|color|string|```'#000000'```|color|Yes| +|lineWidth|number|```1```|Line width|Yes| +|lineWidthStyler|string; One of: ```['default', 'grow', 'shrink', 'center-sharp', 'center-smooth', 'sine-wave']```|```'default'```|Allows defining the line width as a function of relative position p along the path of the line. By default it is set to a constant 1. You may also choose one of the preset functions|Yes| +|path|string|```'-2 -1 0, 0 20 0, 10 -1 10'```|Comma-separated list of x y z coordinates of the line vertices|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| diff --git a/content/schemas/message/threejs-scene.md b/content/schemas/message/threejs-scene.md index 6b02d9bc..b9c07b3b 100644 --- a/content/schemas/message/threejs-scene.md +++ b/content/schemas/message/threejs-scene.md @@ -1,6 +1,6 @@ --- title: Three.js Scene -nav_order: 62 +nav_order: 63 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -38,9 +38,9 @@ Three.js Scene Attributes |object_type|string; Must be: ```threejs-scene```|```threejs-scene```|3D object type.|Yes| |url|string||Model URL. Store files paths under 'store/users/' (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)|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|Yes| -|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.|Yes| -|scale|[scale](scale)|```{'x': 1, 'y': 1, 'z': 1}```|3D object scale|Yes| +|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|Yes| |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| diff --git a/content/schemas/message/torus.md b/content/schemas/message/torus.md index c6ba51c6..76400e3b 100644 --- a/content/schemas/message/torus.md +++ b/content/schemas/message/torus.md @@ -1,6 +1,6 @@ --- title: Torus -nav_order: 63 +nav_order: 64 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -36,12 +36,12 @@ Torus Attributes |object_type|string; Must be: ```torus```|```torus```|3D object type.|Yes| |arc|number|```360```|Arc|No| |radius|number|```1```|radius|Yes| -|radiusTubular|number|```0.4```|radius tubular|No| +|radiusTubular|number|```0.2```|radius tubular|Yes| |segmentsRadial|integer|```36```|segments radial|No| |segmentsTubular|integer|```32```|segments tubular|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| diff --git a/content/schemas/message/torusKnot.md b/content/schemas/message/torusKnot.md index 75e6ef1e..a9f8437c 100644 --- a/content/schemas/message/torusKnot.md +++ b/content/schemas/message/torusKnot.md @@ -1,6 +1,6 @@ --- title: Torus Knot -nav_order: 64 +nav_order: 65 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -37,12 +37,12 @@ Torus Knot Attributes |p|number|```2```|P|No| |q|number|```3```|Q|No| |radius|number|```1```|radius|Yes| -|radiusTubular|number|```0.4```|radius tubular|No| +|radiusTubular|number|```0.2```|radius tubular|Yes| |segmentsRadial|integer|```8```|segments radial|No| |segmentsTubular|integer|```100```|segments tubular|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| diff --git a/content/schemas/message/triangle.md b/content/schemas/message/triangle.md index 6a1ce816..d7444c91 100644 --- a/content/schemas/message/triangle.md +++ b/content/schemas/message/triangle.md @@ -1,6 +1,6 @@ --- title: Triangle -nav_order: 65 +nav_order: 66 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -38,8 +38,8 @@ Triangle Attributes |vertexB|[vector3](vector3)|```{'x': -0.5, 'y': -0.5, 'z': 0}```|vertex B|Yes| |vertexC|[vector3](vector3)|```{'x': 0.5, 'y': -0.5, 'z': 0}```|vertex C|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| diff --git a/content/schemas/message/video-control.md b/content/schemas/message/video-control.md index 736431b9..7d30eca3 100644 --- a/content/schemas/message/video-control.md +++ b/content/schemas/message/video-control.md @@ -1,6 +1,6 @@ --- title: Video -nav_order: 67 +nav_order: 68 layout: default parent: Objects Schema grand_parent: ARENA Objects diff --git a/content/schemas/message/videosphere.md b/content/schemas/message/videosphere.md index 339cdd59..89787ee2 100644 --- a/content/schemas/message/videosphere.md +++ b/content/schemas/message/videosphere.md @@ -1,6 +1,6 @@ --- title: Videosphere -nav_order: 68 +nav_order: 69 layout: default parent: Objects Schema grand_parent: ARENA Objects @@ -37,13 +37,13 @@ Videosphere Attributes |autoplay|boolean|```True```|autoplay|No| |crossOrigin|string|```'anonymous'```|crossOrigin|No| |loop|boolean|```True```|loop|No| -|radius|number|```5000```|radius|No| +|radius|number|```5000```|radius|Yes| |segmentsHeight|integer|```64```|segments height|No| |segmentsWidth|integer|```64```|segments width|No| |src|string||URI, relative or full path of an image/video file. e.g. 'store/users/wiselab/images/360falls.mp4'|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| |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|