Skip to content

Commit

Permalink
chore: sync latest schema, add visiblke property links
Browse files Browse the repository at this point in the history
  • Loading branch information
mwfarb committed Jul 10, 2024
1 parent 363a534 commit bc64d37
Show file tree
Hide file tree
Showing 38 changed files with 248 additions and 132 deletions.
264 changes: 134 additions & 130 deletions content/examples.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions content/schemas/message/arenaui-button-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ ARENAUI Button Panel Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
3 changes: 2 additions & 1 deletion content/schemas/message/arenaui-card.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ ARENAUI Card Panel Attributes
|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|
|img|string|```''```|This image will be embedded alongside the body text.|No|
|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|
Expand All @@ -51,6 +51,7 @@ ARENAUI Card Panel Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/arenaui-prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ ARENAUI Prompt Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/box.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Box Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/camera.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@ Camera Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|No|
1 change: 1 addition & 0 deletions content/schemas/message/capsule.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Capsule Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Circle Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/cone.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Cone Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/cube.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Cube (deprecated; don't use) Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/cylinder.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Cylinder Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/dodecahedron.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Dodecahedron Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Entity (generic object) Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/gaussian_splatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ All wire objects have a set of basic attributes ```{object_id, action, type, per
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/gltf-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ GLTF Model Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/hand.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ Hand Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|No|
1 change: 1 addition & 0 deletions content/schemas/message/icosahedron.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Icosahedron Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Image Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ has_toc: false
|[Icosahedron](icosahedron)|Icosahedron Geometry.|
|[Light](light)|A light.|
|[Line](line)|Draw a line.|
|[OBJ Model](obj-model)|Load an OBJ model|
|[Ocean](ocean)|Draw a wave-form plane.|
|[Octahedron](octahedron)|Octahedron Geometry.|
|[PCD Model](pcd-model)|Load a PCD model.|
Expand Down
1 change: 1 addition & 0 deletions content/schemas/message/light.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Light Attributes
|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|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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 mouse events like clicks.|No|
Expand Down
2 changes: 1 addition & 1 deletion content/schemas/message/line.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Line Attributes
|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|
|visible|boolean|```True```|Whether the material is visible.|No|
|visible|boolean|```True```|Whether object is visible. Property is inherited.|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|
Expand Down
Loading

0 comments on commit bc64d37

Please sign in to comment.