Kudan Unity X-Ray Sample

Unity X-Ray Sample using Kudan AR SDK

The Unity X-Ray Sample uses a stencil buffer, along with some alpha transparency, to achieve occlusion. The buffer makes a portal effect, making the contents of the box only visible through its lid. Place the marker flat on top of a box and give it a try. This is only used with marker tracking in our sample.

The “Hidden” shader is the one that should be applied to any object you don’t want to view, except through a specific object. The “Portal” object should be applied to the object you want to view hidden objects through.

Instructions

Download the Kudan Unity Plugin from the XLsoft Kudan Download Page.
Open the Unity Project and go to Assets -> Import Package -> Custom Package
Add KudanARUnity.unitypackage

Setting up the Application Identifier

Make sure your Application Identifier is correct for the API Key you’re using. You can find your project’s Application Identifier by clicking the Set App ID button on the Kudan Trackerscript, or by going to Edit -> Project Settings -> Player and opening Other Settings in the iOS tab.

Your Application ID be either:

The ID you entered when generating your free key on the Kudan website, in the format “com.companyName.productName”.
If you are using the Development License Key, com.xlsoft.kudanar.

You should set the matching API key from Scene -> Kudan Bundle - With UI -> Kudan Camera and opening the Inspector

To see if your API Key is valid for the Application ID you put in, run the app in Play Mode. A message will print out in the console telling you whether or not your API Key is valid.

Camera Usage Description

Add a camera usage description in the appropriate field. Since Kudan uses the camera, the app will crash on iOS 10+ if an app does not contain a usage description. The message can be anything you like, as long as it isn’t empty.

Deploy the Application

Build and run the Unity Project on specified device

Build the Xcode project

Build the app by going to File -> Build Settings, selecting iOS and clicking Build. Unity will build the selected scenes and produce an XCode project in the selected folder.

- Disable Bitcode: If you are using Unity 2017/2018, go to the Build Settings tab of your workspace, scroll down to Build Options, and set Enable Bitcode to No.
Run the XCode project

For any additional questions or concerns, visit the XLsoft Kudan Developer Hub.