Skip to main content

Building a native plugin for the Asus Xtion2 for Unity

During one of the projects in my company I needed to build a native plugin to let Unity communicate with the Asus Xtion2, specifically to get its depth data. We used to be able to do this pretty easily with the Kinect but since Microsoft discontinued it, we need to start looking for alternatives.

Test Environment

  • Windows 10 64 bit.
  • Unity 2017.2.0f3 x64. Important! Choose x64 or x86 to match your Unity installation.
  • OpenNI For Xtion2 SDK. The official SDK is somewhat different from the OpenNI SDK provided by Asus but it should behave the same. The one provided by Asus can be downloaded here. Make sure you choose the latest one.
  • CMake 3.0 or higher

Who is it for

Someone who has been using Unity for some time and is comfortable with the concept of classes and objects. It will be very helpful if you know C++ and pointers too.

Steps

Since the code is provided, I will only go over the major steps. Let me know in the comments if I miss anything.
  1. Build and install OpenNI. Since there are already many tutorials on building and installing libraries I will not go into the details here.
  2. Assuming OpenNI is installed in {OPENNI_INSTALL_PATH}, make sure that you have {OPENNI_INSTALL_PATH}/lib/OpenNI2.lib and you can also run the samples located in {OPENNI_INSTALL_PATH}/Samples/Bin
  3. You can find the code for the native plugin here. 
  4. The Unity project can be found here.
  5. Both lack documentation so in the meantime please check out the code and let me know in the comments if anything is unclear.
  6. You can find the CMakeList file for the native code under src/ folder.
  7. Adjust the install paths and parameters to suit your environment and build with CMake.
  8. If everything goes well with CMake you should see a solution (.sln) file in the build folder
  9. Open this solution file with Visual Studio and build the project.
  10. Don't forget to set the build settings to either Debug or Release and make sure to build x86 or x64 according to your architecture.
  11. If the build is successful, you should see an XtionCapture.dll in the build folder.
  12. Copy this dll to the Unity project in Assets/Plugins.
  13. You will also need to copy some file from the OpenNI SDK. Go to {OPENNI_INSTALL_PATH}/Redist and copy all the files there into the Assets/Plugins folder.
  14. If you managed to come this far then just press Play and enjoy!

Overview of plugin interface

The details can be found in the code but I'd like to share the idea behind the plugin.
  1. Instantiate a new capture class (xtion_capture) and let this class hold references to the Xtion Device. So pointers to device handlers, depth frames etc. are registered as this class' members.
  2. When xtion_capture is instantiated it returns a pointer to its object instance to Unity. This pointer is how Unity calls the capture class and retrieves data from its (member) pointers.
The above design is illustrated below.


Future work

I will definitely want to add documentations, and clean up the repository. If I have the time I'd try getting the color image too. Best of luck and I would be happy to help of anyone needs to have the same system setup.

Comments

Post a Comment

Popular posts from this blog

Using FCM with the new HTTP v1 API and NodeJS

When trying to send FCM notifications I found out that Google has changed their API specifications. The legacy API still works but if you want to use the latest v1 API you need to make several changes. The list of changes is listed on their site so I won't be repeating them again but I'll just mention some of the things that caused some trial and error on my project. The official guide from Google is here : Official Migration Guide to v1 . The request must have a Body with the JSON containing the message data. Most importantly it needs to have "message" field which must contain the target of the notification. Usually this is a Topic, or Device IDs. Since my previous project was using GAS, my request had a field called "payload" instead of "body". Using the request from my previous project, my request in Node JS was as follows: request ({ url: 'https://fcm.googleapis.com/v1/projects/safe-door-278108/messages:send' , method: ...
Post a Comment
Read more

Building a native plugin for Intel Realsense D415 for Unity

Based on a previous post , I decided to write a plugin for the Intel Realsense SDK methods so we can use these methods from within Unity. FYI Intel also has their own Unity wrapper in their Github repository , but for our projects, I needed to perform image processing with OpenCV and passing the results to Unity instead of just the raw image/depth data. There is a plugin called OpenCVForUnity to use OpenCV functions from Unity but previous experiments indicate the image processing inside Unity can take a long time. I hope this post can help someone else who wants to use Intel's cameras or any other devices natively in Unity. Test Environment Windows 10 64bit Unity 2017.2.0f3 x64 bit Realsense SDK from Intel CMake 3.0 or higher Steps Checkout the native plugin code here . Don't worry about the other projects in the same repository. The relevant code is in the link above. Checkout the Unity sample project here . However, instead of master you need to go to the br...
5 comments
Read more

Microsoft Azure Face API and Unity

During one of my projects, I came across Microsoft's face recognition API (Azure Face API) and it looked good enough to recognize people's faces and detect if a person is a newcomer or a repeating customer to our store. As our installations mainly use the game engine Unity, I wanted to be able to use the Face API from Unity. Face API does not have an SDK for Unity but their requests are just HTTP requests so the Networking classes in Unity can be wrapped into methods to make it easy to call these APIs. First of all, to those who just want to see the code, here it is . My tests focus on the identification of a face in an input image. The full tutorial I followed can be found here . The Main scene goes through the steps in the tutorial such as creating a PersonGroup and adding Persons to the group if it is not created yet. Just make sure you: Change the API key. I used a free trial key which is no longer valid. Use whatever images you want. I don't mind you us...
Post a Comment
Read more