Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 3.35 KB

README.md

File metadata and controls

40 lines (28 loc) · 3.35 KB
Raw

Spectacular AI Unity integration example

Spectacular AI SDK fuses data from cameras and IMU sensors (accelerometer and gyroscope) and outputs an accurate 6-degree-of-freedom pose of a device. The SDK also includes a Mapping API that can be used to access the full SLAM map for both real-time and offline 3D reconstruction use cases.

This repository contains example Unity integration for the Spectacular AI DepthAI C++ Plugin, enabling real-time tracking and reconstruction with OAK-D devices straight in Unity.

Getting started

You can either,

  1. Clone this repository and open unity-examples using Unity Hub.
git clone https://github.com/SpectacularAI/unity-wrapper.git
  1. Or, download spectacularAI.unitypackage from the releases page, and import it directly to your Unity project inside Unity Editor using Assets->Import Package->Custom Package...

Project structure

  • plugin: contains source code for the spectacularAI_unity plugin. A prebuilt version is shipped with the unity-examples for Windows and Linux Ubuntu x84-64 so building the plugin is not necessary to get started.
  • unity-examples: contains source code for the Unity wrapper and a couple of examples that demonstrate the usage:
    • HelloDepthAI Minimal OAK-D example. Shows how to use the SDK to track the pose of OAK-D device in real-time.
    • MappingVisu SLAM example. Build and visualize 3D point cloud of the environment in real-time using OAK-D device.
    • Record Recording tool. Enables recording datasets with OAK-D device for Replay API. Note: requires FFmpeg https://spectacularai.github.io/docs/sdk/index.html#ffmpeg.
    • AprilTag April Tag integration example. Place April Tags using Unity Editor. The April Tags are then input to the SDK enabling absolute positioning.
    • HelloReplay Minimal Replay API example. Shows how to use the Replay API in Unity to replay your recordings.

Quick links

SDK documentation

C++ release packages

Copyright

The examples in this repository are licensed under Apache 2.0 (see LICENSE).

A list of 3rd party copyright notices that should be included in redistributions is provided within unity-examples/Assets/SpectacularAI/Plugins/<operating system>/LICENSE.

The SDK itself (not included in this repository) is proprietary to Spectacular AI. For commerical licensing options and more SDK variants (ARM binaries & C++ API), contact us at https://www.spectacularai.com/#contact.