Skip to content

Getting Started

Welcome! This SDK allows you to integrate your Unity projects with Cognitive3D, which provides analytics and insights about your user behavior in VR and AR.

Terminology

There are five core components of our analytics SDK:

  1. Projects - can be thought of as silos of data. A single VR app would be a Project.
  2. Scenes - almost identical to Unity Scenes. Scenes are where user sessions exist. Scenes contain static geometry.
  3. Dynamic Objects - 3D objects that you would like to track. Dynamic Objects contain their own gaze and movement data. A product on a shelf of a retail scene would be a Dynamic Object, but a permanent, non-moving cash register would not.
  4. Gaze - User gaze is recorded every 10 milliseconds by default. Gaze includes user position and the exacty 3d position a user looked at. If a user Gazes at a Dynamic Object, that Gaze is assigned to that Object.
  5. Events - User actions that are recorded to our cloud. Events can be anything from "Purchased Product" to "Training Completed". Each Event can have sub-properties, such as "Product Name" or "Training Type".

Prerequisites

Setup

Click Assets->Import Package->Custom Package... and select latest CognitiveVR SDK from GitHub. The latest release for the Unity SDK can be found here https://github.com/CognitiveVR/cvr-sdk-unity/releases.

The Scene Setup Wizard can be opened via the cognitive3D menu on the Unity toolbar.

Settings Window

This window will guide you through some basic terminology and setup. You will need your Developer Key and API Key from the Cognitive3D Dashboard.

Following these steps, you will add Dynamic Object components to interactive GameObjects in your scene and upload your scene to SceneExplorer.

The Scene Setup window will also add a CognitiveVR Manager to the scene. This manager will automatically send a Session Custom Event and record basic data about the device. This manager also persists upon changing scenes.

Sending Data

Once you have successfully completed the Setup Wizard, can simply hit "Play" in the Unity Editor. If no HMD is present, the Unity Main Camera will be used to track Gaze from. You will see Event and Gaze data immediately on the dashboard.

!!! Note: If no internet connection is detected, the SDK will temporarily store data locally. When internet connectivity is restored the SDK will automatically queue up this cached data and send it in the background. This works between sessions, so you can freely start more sessions even when offline. Click cognitive3D->Advanced Options to change the Upload Local Cache Rate and the Cache Size.

Next Steps

Once you have verified that your data is coming in properly, you can add additional data collection to your app with Events or Sensors.