OvrIntegration: Add TrackingOrigin enum

Signed-off-by: Squareys <Squareys@googlemail.com>
mosra · Apr 2, 2016 · 4ff4317 · 4ff4317
1 parent 6f04923
commit 4ff4317
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 0 deletions.
diff --git a/src/Magnum/OvrIntegration/HmdEnum.cpp b/src/Magnum/OvrIntegration/HmdEnum.cpp
@@ -60,6 +60,17 @@ Debug& operator<<(Debug& debug, const HmdTrackingCapability value) {
     return debug << "OvrIntegration::HmdTrackingCapability::(invalid)";
 }
 
+Debug& operator<<(Debug& debug, const TrackingOrigin value) {
+    switch(value) {
+        #define _c(value) case TrackingOrigin::value: return debug << "OvrIntegration::TrackingOrigin::" #value;
+        _c(EyeLevel)
+        _c(FloorLevel)
+        #undef _c
+    }
+
+    return debug << "OvrIntegration::TrackingOrigin::(invalid)";
+}
+
 Debug& operator<<(Debug& debug, const TrackerFlag value) {
     switch(value) {
         #define _c(value) case TrackerFlag::value: return debug << "OvrIntegration::TrackerFlag::" #value;

diff --git a/src/Magnum/OvrIntegration/HmdEnum.h b/src/Magnum/OvrIntegration/HmdEnum.h
@@ -85,6 +85,41 @@ typedef Containers::EnumSet<HmdTrackingCapability> HmdTrackingCapabilities;
 
 CORRADE_ENUMSET_OPERATORS(HmdTrackingCapabilities)
 
+/**
+ * @brief Tracking origin
+ */
+enum class TrackingOrigin: Int {
+    /**
+     * @brief Tracking system origin reported at eye (HMD) height
+     *
+     * Prefer using this origin when your application requires matching user's
+     * current physical head pose to a virtual head pose without any regards to
+     * the height of the floor. Cockpit-based, or 3rd-person experiences are
+     * ideal candidates.
+     * When used, all poses in ovrTrackingState are reported as an offset
+     * transform from the profile calibrated or recentered HMD pose.
+     * It is recommended that apps using this origin type call @ref Hmd::recenterTrackingOrigin()
+     * prior to starting the VR experience, but notify the user before doing so
+     * to make sure the user is in a comfortable pose, facing a comfortable
+     * direction.
+     */
+    EyeLevel = ovrTrackingOrigin_EyeLevel,
+
+    /**
+     * @brief Tracking system origin reported at floor height
+     *
+     * Prefer using this origin when your application requires the physical
+     * floor height to match the virtual floor height, such as standing
+     * experiences.
+     * When used, all poses in ovrTrackingState are reported as an offset
+     * transform from the profile calibrated floor pose. Calling @ref Hmd::recenterTrackingOrigin()
+     * will recenter the X & Z axes as well as yaw, but the Y-axis (i.e. height)
+     * will continue to be reported using the floor height as the origin for
+     * all poses.
+     */
+    FloorLevel = ovrTrackingOrigin_FloorLevel,
+};
+
 /**
 @brief Tracker flag
 

diff --git a/src/Magnum/OvrIntegration/Test/EnumTest.cpp b/src/Magnum/OvrIntegration/Test/EnumTest.cpp
@@ -42,6 +42,7 @@ struct EnumTest: TestSuite::Tester {
 
     void hmdType();
     void hmdTrackingCapability();
+    void trackingOrigin();
     void trackerFlag();
     void button();
     void touch();
@@ -57,6 +58,7 @@ struct EnumTest: TestSuite::Tester {
 EnumTest::EnumTest() {
     addTests({&EnumTest::hmdType,
               &EnumTest::hmdTrackingCapability,
+              &EnumTest::trackingOrigin,
               &EnumTest::trackerFlag,
               &EnumTest::button,
               &EnumTest::touch,
@@ -89,6 +91,16 @@ void EnumTest::hmdTrackingCapability() {
     CORRADE_COMPARE(out.str(), "OvrIntegration::HmdTrackingCapability::(invalid)\n");
 }
 
+void EnumTest::trackingOrigin() {
+    std::ostringstream out;
+    Debug(&out) << TrackingOrigin::EyeLevel;
+    CORRADE_COMPARE(out.str(), "OvrIntegration::TrackingOrigin::EyeLevel\n");
+
+    out.str("");
+    Debug(&out) << TrackingOrigin(-1);
+    CORRADE_COMPARE(out.str(), "OvrIntegration::TrackingOrigin::(invalid)\n");
+}
+
 void EnumTest::trackerFlag() {
     std::ostringstream out;
     Debug(&out) << TrackerFlag::Connected;