iOS-ARKit-echo3D-Demo-TownBuilder

This is a tabletop augmented reality iOS demo app, built with the echo3D Swift SDK, that allows users to build virtual neighborhoods on horizontal surfaces. This project requires you to enter your echo3D API key or entry IDs.

Setup

• Register for FREE at echo3D.
• Clone this repository and open in XCode.

Video

• See on Youtube here.

Steps

• Open ARTownBuilderDemo.xcodeproj using Xcode (Note: If you have Xcode downloaded you simply double click the file to open).
• Go to the "Signing & Capabilities" tab in Xcode and fill out your signing information. See more details here.
• Go to the Echo3D.swift file and insert your API key as a string where it says "insert API key here" on line 22.
• Add models to the echo3D console or choose from our library.
• Go to the ViewController.swift file, add the entry ID's for 3D content you have added to your echo3D console where it says "insert entry ID here" on lines 27 - 34.
  
  
• Uncheck the “Enable Secret Key” box in your echo3D console (Note: For a production build, it’s best to add the echo3D security key to the echo3D.cs script so it remains secure). You can add the security key to the Echo3D.swift file on line 24.
• Connect your iPhone to your computer.
• Select your iPhone on the dropdown list of devices to run the demo app on.
• Press the Play button to build and run (Note: your device must be unlocked and in Developer Mode to run).

Run

• Move your phone around a horizontal surface to scan a plane.
• If the "Add" button is selected, choose an object to add and touch somewhere on your horizontal plane to add it.
• If any other edit buttons are selected such as drag, rotate, or delete, tap or drag on the object you would like to edit.
• Objects can be scaled at any time by doing the two finger pinch gesture on them.

Learn More

Refer to our documentation to learn more about how to use echo3D and the Swift SDK.

Troubleshooting

Visit our troubleshooting guide here.

Support

Feel free to reach out at support@echo3D.co or join our support channel on Slack.

Screenshots

Additional Notes

Users can drag nodes to be buried underneath the horizontal plane. Because dragging the horizontal plane itself is not allowed in the demo, this then gets the node stuck underneath the plane.
* Depending on use case, this can be solved by allowing the editing of the horizontal plane (see the isPlane() function).
* Note: Toggling the horizontal plane toggles visibility, but the plane node is still in the scene.

Images of the default entries for the demo

Demo created by Daye Jack.