For more in-depth tutorials for downloading and setting up Roux in your projects, visit
Getting Started with Roux, Part 1: How to Set Up the Example iOS App
Getting Started with Roux, Part 2: How to Build a Roux iOS Project from Scratch
To run this example, you will need to generate a license through the Roux Portal. If you have not already, sign up as a developer to gain access to the developer dashboard. Create a new project and click the 'Download License' button.
Rename the license to ScandyCoreLicense.txt and move into RouxSwiftHelloWorld/.
Open RouxSwiftHelloWorld.xcodeproj in Xcode.
Select the RouxSwiftHelloWorld target and add ScandyCoreLicense.txt to Build Phases -> Copy Bundle Resources.
If you haven't already, download the SDK (button can be found in the top navigation bar of the Roux Portal). Extract the ScandyCore.zip file and move ScandyCore.framework into RouxSwiftHelloWorld/Frameworks/.
Connect a device and build in Xcode.
To include Roux in your iOS project, there are a few extra steps you need to take.
All basic functionality can be achieved by just importing the main header from the framework for access into the ScandyCore object.
// ViewController.swift
// example file
import GLKit
class ViewController: GLKViewController {
override func viewDidLoad() {
super.viewDidLoad()
// Do any additional setup after loading the view.
}
}
It is ideal to simply use or subclass the GLKView ScandyCoreView with your own GLKViewController. The ScandyCoreView creates and manages the scanning view as well as the mesh view. It includes a resizeView function that automatically scales the viewports to fit the frame the view is contained within. ScandyCoreView is also configured to translate iOS touch interactions for interacting with a mesh.
Open main.storyboard, expand the View Controller Scene and View Controller, and select 'View'. In the right hand Inspector Area, open the Identity inspector and select ScandyCoreView from the dropdown list labeled 'Class'.
Before you can use Roux, you must call setLicense to validate your license.
setLicense searches in your bundle resources for a file named ScandyCoreLicense.txt and then reads the contents to check its expiration and if the signature is valid.
// ViewController.swift
// example file
override func viewDidLoad() {
super.viewDidLoad()
// Do any additional setup after loading the view.
ScandyCore.setLicense()
}
The example app already has the ScandyCore.framework in Framework Search Paths and ScandyCore.framework/Headers/include in Header Search Paths. In your own project, please add your path to ScandyCore.framework in Framework Search Paths and ScandyCore.framework/Headers/include in Header Search Paths in Xcode.
You will also need to add ScandyCore.framework in Frameworks, Libraries, and Embedded Content.
In build settings, find 'Swift Compiler -- General' - > 'Objective-C Bridging Header' and add
$SRCROOT/Frameworks/ScandyCore.framework/Headers/ScandyCore-Bridging-Header.h
You need to include information in the Info.plist explaining how your app will be using your users’ data. We suggest you request permissions in a user friendly way that makes the user aware of what's going on.
Before we set up the scanner we must be sure we have access to the TrueDepth camera. Since Roux can be used to create volumetric video, you also need to include the NSMicrophoneUsageDescription key.
Right-click Info.plist in the Project Navigator and select Open As -> Source Code. At the end, after the </array> tag and before the closing </dict> tag, insert the following:
// Info.plist
// example file
<key>NSCameraUsageDescription</key>
<string>My app uses the TrueDepth camera to capture 3D scans</string>
<key>NSMicrophoneUsageDescription</key>
<string>My app uses the microphone to record volumetric video</string>
If you do not plan on using the microphone or volumetric video, change the description to say "My app does not use the microphone".
Once we have camera permissions, we can initialize the scanner.
After the scanner is initialized, we can either start the preview or configure the scanning parameters like scan size, scan offset, etc. The order of these two actions is not important except that they must happen after initializeScanner.
From there we are ready to start the scanning process.
// ViewController.swift
// example file
if(ScandyCore.hasCameraPermission()) {
//Turn on v2 scanning
ScandyCore.toggleV2Scanning(true);
ScandyCore.initializeScanner()
ScandyCore.startPreview()
// Set the voxel size to 1.0mm
let resolution = 0.001 // == 1.0mm
ScandyCore.setVoxelSize(resolution)
}
}
}
The ScandyCoreDelegate allows us to listen to events on the Scandy Core View. In order to use the delegate you must adopt the protocol:
class ViewController: GLKViewController, ScandyCoreDelegate {
and set the delegate to self:
override func viewDidLoad() {
super.viewDidLoad()
ScandyCore.setDelegate(self)
}
Then, implement all the required methods:
func onVisualizerReady(_ status: ScandyCoreStatus){
print("Visualizer ready)
}
func onScannerReady(_ status: ScandyCoreStatus)
func onPreviewStart(_ status: ScandyCoreStatus)
func onScannerStart(_ status: ScandyCoreStatus)
func onScannerStop(_ status: ScandyCoreStatus)
func onGenerateMesh(_ status: ScandyCoreStatus)
func onSaveMesh(_ status: ScandyCoreStatus)
func onLoadMesh(_ status: ScandyCoreStatus)
func onClientConnected(_ host: String!)
func onClientDisconnected(_ host: String!)
func onHostDiscovered(_ host: String!)
func onTrackingDidUpdate(_ confidence: Float, withTracking is_tracking: Bool)
func onVolumeMemoryDidUpdate(_ percent_full: Float)