ENH: Exposing the generic tracker openvr device type to downstream projects

adamrankin · adamrankin · commit 6083532cf831 · 2019-04-16T10:52:36.000-04:00
Refactor VTK interface to enable index based device querying (necessary to access multiple generic trackers)
Add implementation of device count function in vtkOpenVRRenderWindow.cxx
Adding count function for tracked devices by device type vtkOpenVRRenderWindow.h
diff --git a/Common/Core/vtkEventData.h b/Common/Core/vtkEventData.h
@@ -27,6 +27,7 @@ enum class vtkEventDataDevice {
   HeadMountedDisplay,
   RightController,
   LeftController,
+  GenericTracker,
   NumberOfDevices
 };
 
diff --git a/Rendering/OpenVR/vtkOpenVRRenderWindow.cxx b/Rendering/OpenVR/vtkOpenVRRenderWindow.cxx
@@ -766,7 +766,7 @@ void vtkOpenVRRenderWindow::RenderOverlay()
   this->DashboardOverlay->Render();
 }
 
-vr::TrackedDeviceIndex_t vtkOpenVRRenderWindow::GetTrackedDeviceIndexForDevice(vtkEventDataDevice dev)
+vr::TrackedDeviceIndex_t vtkOpenVRRenderWindow::GetTrackedDeviceIndexForDevice(vtkEventDataDevice dev, uint32_t index)
 {
   if (dev == vtkEventDataDevice::HeadMountedDisplay)
   {
@@ -780,12 +780,50 @@ vr::TrackedDeviceIndex_t vtkOpenVRRenderWindow::GetTrackedDeviceIndexForDevice(v
   {
     return this->HMD->GetTrackedDeviceIndexForControllerRole(vr::TrackedControllerRole_RightHand);
   }
+  if (dev == vtkEventDataDevice::GenericTracker)
+  {
+    bool notDone = true;
+    uint32_t arraySize(1024);
+    vr::TrackedDeviceIndex_t* devices = new vr::TrackedDeviceIndex_t[arraySize];
+    uint32_t deviceCount(0);
+    while (notDone)
+    {
+      deviceCount = this->HMD->GetSortedTrackedDeviceIndicesOfClass(vr::TrackedDeviceClass_GenericTracker, devices, 1024);
+      if (deviceCount > arraySize)
+      {
+        delete[] devices;
+        arraySize *= 2;
+        devices = new vr::TrackedDeviceIndex_t[arraySize];
+        continue;
+      }
+      else
+      {
+        notDone = false;
+      }
+    }
+
+    uint32_t devIndex = devices[index];
+    delete[] devices;
+
+    if (index > deviceCount)
+    {
+      return vr::k_unTrackedDeviceIndexInvalid;
+    }
+
+    return devIndex;
+  }
   return vr::k_unTrackedDeviceIndexInvalid;
 }
 
-vtkOpenVRModel *vtkOpenVRRenderWindow::GetTrackedDeviceModel(vtkEventDataDevice dev)
+uint32_t vtkOpenVRRenderWindow::GetNumberOfTrackedDevicesForDevice(vtkEventDataDevice dev)
+{
+  vr::TrackedDeviceIndex_t devices[1];
+  return this->HMD->GetSortedTrackedDeviceIndicesOfClass(vr::TrackedDeviceClass_GenericTracker, devices, 1);
+}
+
+vtkOpenVRModel *vtkOpenVRRenderWindow::GetTrackedDeviceModel(vtkEventDataDevice dev, uint32_t index)
 {
-  vr::TrackedDeviceIndex_t idx = this->GetTrackedDeviceIndexForDevice(dev);
+  vr::TrackedDeviceIndex_t idx = this->GetTrackedDeviceIndexForDevice(dev, index);
   if (idx != vr::k_unTrackedDeviceIndexInvalid)
   {
     return this->GetTrackedDeviceModel(idx);
@@ -794,9 +832,11 @@ vtkOpenVRModel *vtkOpenVRRenderWindow::GetTrackedDeviceModel(vtkEventDataDevice
 }
 
 void vtkOpenVRRenderWindow::GetTrackedDevicePose(
-  vtkEventDataDevice dev, vr::TrackedDevicePose_t **pose)
+  vtkEventDataDevice dev,
+  uint32_t index,
+  vr::TrackedDevicePose_t **pose)
 {
-  vr::TrackedDeviceIndex_t idx = this->GetTrackedDeviceIndexForDevice(dev);
+  vr::TrackedDeviceIndex_t idx = this->GetTrackedDeviceIndexForDevice(dev, index);
   *pose = nullptr;
   if (idx < vr::k_unMaxTrackedDeviceCount)
   {
diff --git a/Rendering/OpenVR/vtkOpenVRRenderWindow.h b/Rendering/OpenVR/vtkOpenVRRenderWindow.h
@@ -132,9 +132,11 @@ class VTKRENDERINGOPENVR_EXPORT vtkOpenVRRenderWindow : public vtkOpenGLRenderWi
   /**
   * Get the VRModel corresponding to the tracked device
   */
-  vtkOpenVRModel *GetTrackedDeviceModel(vtkEventDataDevice idx);
+  vtkOpenVRModel *GetTrackedDeviceModel(vtkEventDataDevice idx) {
+    return this->GetTrackedDeviceModel(idx, 0); };
   vtkOpenVRModel *GetTrackedDeviceModel(vr::TrackedDeviceIndex_t idx) {
     return this->TrackedDeviceToRenderModel[idx]; };
+  vtkOpenVRModel* GetTrackedDeviceModel(vtkEventDataDevice idx, uint32_t index);
 
   /**
   * Get the openVR Render Models
@@ -145,12 +147,17 @@ class VTKRENDERINGOPENVR_EXPORT vtkOpenVRRenderWindow : public vtkOpenGLRenderWi
   /**
   * Get the index corresponding to the tracked device
   */
-  vr::TrackedDeviceIndex_t GetTrackedDeviceIndexForDevice(vtkEventDataDevice dev);
+  vr::TrackedDeviceIndex_t GetTrackedDeviceIndexForDevice(vtkEventDataDevice dev) {
+    return this->GetTrackedDeviceIndexForDevice(dev, 0); };
+  vr::TrackedDeviceIndex_t GetTrackedDeviceIndexForDevice(vtkEventDataDevice dev, uint32_t index);
+  uint32_t GetNumberOfTrackedDevicesForDevice(vtkEventDataDevice dev);
 
   /**
   * Get the most recent pose corresponding to the tracked device
   */
-  void GetTrackedDevicePose(vtkEventDataDevice idx, vr::TrackedDevicePose_t **pose);
+  void GetTrackedDevicePose(vtkEventDataDevice idx, vr::TrackedDevicePose_t **pose) {
+    return this->GetTrackedDevicePose(idx, 0, pose); };
+  void GetTrackedDevicePose(vtkEventDataDevice idx, uint32_t index, vr::TrackedDevicePose_t **pose);
   vr::TrackedDevicePose_t &GetTrackedDevicePose(vr::TrackedDeviceIndex_t idx) {
     return this->TrackedDevicePose[idx]; };
 
