Add documentation on ARENA UI elements

content/3d-content/ui.md

@@ -0,0 +1,38 @@
+---
+title: UI Elements
+layout: default
+parent: 3D Content
+---
+# ARENA UI Elements
+
+You can use several UI elements in the ARENA, including text and image panels, button panels, and
+popup prompts.
+
+## ARENAUI Card - a text and image panel
+
+A card is a rectangular panel that can contain text and/or an image. It can be used to display
+information or act as a sign. Its layout will dynamic adjust according to the optional parameters
+that are provided: for instance, if no image is provided, then only text will be displayed. If only
+a title is provided, it will serve more as a label or sign. An optional close button may also added.
+
+![img](/assets/img/3dcontent/ui-card.png)
+
+See the full [ARENAUI Card schema](/content/schemas/message/arenaui-card) for more details.
+
+## ARENAUI Button Panel
+A button panel is a horizontal or vertical panel that contains buttons. Each button can have a
+text or image label. When a button is clicked, a message is sent over pubsub with
+the `buttonName` and `buttonIndex`. 
+
+![img](/assets/img/3dcontent/ui-button-panel.png) 
+
+See the full [ARENAUI Button Panel schema](/content/schemas/message/arenaui-button-panel) for more details.
+
+## ARENAUI Prompt
+Similar to a button panel, this prompt is intended to be used a quick confirmation popup.
+Its buttons may be customized and an additional text description can be included, similar 
+to what one may see in traditional 2D web interfaces.
+
+![img](/assets/img/3dcontent/ui-prompt.png)
+
+See the full [ARENAUI Prompt schema](/content/schemas/message/arenaui-prompt) for more details.

content/python/events.md

@@ -22,12 +22,14 @@ Below is how you access attributes of the `Event` object.
 # [msg] is the raw JSON message as a dict
 def click_handler(scene, evt, msg):
     ## Get Event type
-    evt.type # == "mousedown", "mouseup", "mouseenter", "mouseleave", etc.
+    evt.type # == "buttonClick", "mousedown", "mouseup", "mouseenter", "mouseleave", etc.
 
     ## Get Event data
     evt.data.clickPos
     evt.data.position
     evt.data.source
+    evt.data.buttonName
+    evt.data.buttonIndex
     # etc.
 
 box = Box(..., evt_handler=click_handler) # note the use of "evt_handler=click_handler"

content/python/objects.md

@@ -208,6 +208,25 @@ Particle(...)
 Camera(object_id, ...)
 ```
 
+## Card
+Create an ARENAUI Card
+```python
+Card(...)
+```
+
+## ButtonPanel
+Create an ARENAUI Button Panel
+```python
+ButtonPanel(buttons=[Button(...), ...], ...)
+```
+
+## Prompt
+Create an ARENAUI Prompt
+```python 
+Prompt(...)
+```
+
+
 ## Generic Object
 For objects that might not exist yet (but may exist in AFRAME). Inherit from this class to create custom objects.
 ```python