ARENA AR Builder

An AR/VR capable editing tool to create/manipulate/delete ARENA objects. See top-level Python documentation for requirements. This tool uses the ARENA Persistence Database, so all changes are persisted.

Quick Start

1. Clone our Python repo https://github.com/arenaxr/arena-py.
2. Usage: arb takes at minimum one argument, the first one, a scene name (hello in this example).

   python3 tools/arb/arb.py -s hello
   

3. Interact with the tool at https://arenaxr.org/[your username]/hello

Demo Video

Usage

usage: arb.py [-h] [-mh HOST] [-n NAMESPACE] [-s SCENE] [-d DEVICE] [-p POSITION POSITION POSITION] [-r ROTATION ROTATION ROTATION]
              [-c SCALE SCALE SCALE] [-D]

arena-py Application CLI

optional arguments:
  -h, --help            show this help message and exit
  -mh HOST, --host HOST
                        ARENA webserver main host to connect to
  -n NAMESPACE, --namespace NAMESPACE
                        Namespace of scene
  -s SCENE, --scene SCENE
                        Scene to publish and listen to
  -d DEVICE, --device DEVICE
                        Device to publish and listen to
  -p POSITION POSITION POSITION, --position POSITION POSITION POSITION
                        App position as cartesian.x cartesian.y cartesian.z
  -r ROTATION ROTATION ROTATION, --rotation ROTATION ROTATION ROTATION
                        App rotation as euler.x euler.y euler.z
  -c SCALE SCALE SCALE, --scale SCALE SCALE SCALE
                        App scale as cartesian.x cartesian.y cartesian.z
  -D, --debug           Debug mode.

EDIT Button

The edit button will update all objects in the scene with click-listeners, allowing you to target ARB commands to any object. Toggling the edit button on, updates the scene scene-options object and will remind you to reload the page for edit mode to fully activate. You may see an orange warning in the upper left that Events Publish Behavior is too high, which is expected and a reminder to toggle the edit button off, when finished editing the scene with ARB.

Basic Object Manipulation

When you set the mode to None, Rotate, Nudge, Stretch, Scale, you can manipulate objects in various ways.

AR One-Finger, VR Left-Click

• Tap 1 finger with reticle (AR) or cursor (VR) on the cones to activate one-direction granular manipulation.

AR Two-Finger

• Tap and hold 2 thumbs with reticle (AR) on the cones to activate free manipulation along that axis.
• Move the device in AR to position, scale and rotate.

AR Three-Finger

• Tap and hold 2 thumbs and tap 1 more finger to toggle modes: None, Rotate, Nudge, Stretch, Scale.

Control Panel

• VR Mode: Click and hold your mouse to move your camera relative to the panel.
• AR Mode: Move your AR device to move your camera relative to the panel.
• All Modes: Use the lock button to reposition the panel relative to your camera’s rotation.

Clipboard

The clipboard is a temporary see-through object floating in front of the user used to show the relative position of placing a future object. It’s also used in AR to have something to fire an event at where no object currently exists.

Construction Cone

There is a small temporary object resting on position 0,0,0 in the shape of a construction cone to mark the origin of the scene. It will be removed when arb stops running.

Run Options

Importing Models

You can import a json-formatted manifest of GLTF models using the command argument -m to use on the model control panel option. You can write your own, or use the example, arb-manifest.json.

python3 tools/arb/arb.py -s hello --manifest arb-manifest.json

Scale varies widely between individual models, so experiment with the best scale to start with.

arb-manifest.json

{
  "models": [
    {
      "name": "avocado",
      "url_gltf": "store/models/Avocado.glb",
      "scale": 1
    },
    {
      "name": "shuttle",
      "url_gltf": "store/models/Shuttle.glb",
      "scale": 5
    },
    {
      "name": "duck",
      "url_gltf": "store/models/Duck.glb",
      "scale": 0.2
    },
    {
      "name": "earth",
      "url_gltf": "store/models/Earth.glb",
      "scale": 2
    },
    {
      "name": "lantern",
      "url_gltf": "store/models/Lantern.glb",
      "scale": 0.015
    },
    {
      "name": "camera",
      "url_gltf": "store/models/AntiqueCamera.glb",
      "scale": 0.05
    }
  ]
}