Gesture interface merge

apps/sample-configs/osvr_server_config.gesture.sample.json

@@ -0,0 +1,9 @@
+{
+    "plugins": [
+        "com_osvr_example_Gesture"
+    ],
+    "aliases": {
+        "/me/hands/left/gesture": "/com_osvr_example_Gesture/Gesture/gesture/0",
+        "/me/hands/right/gesture": "/com_osvr_example_Gesture/Gesture/gesture/1"
+    }
+}

examples/clients/CMakeLists.txt

@@ -16,6 +16,7 @@ set(CLIENTS
     Location2D
     Direction
     Locomotion
+    Gesture
     MinimalInit
     TrackerState
     ViewerEyeSurfaces)

examples/clients/Gesture.cpp

@@ -0,0 +1,71 @@
+/** @file
+    @brief Implementation
+
+    @date 2015
+
+    @author
+    Sensics, Inc.
+    <http://sensics.com/osvr>
+
+*/
+
+// Copyright 2015 Sensics, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Internal Includes
+#include <osvr/ClientKit/Context.h>
+#include <osvr/ClientKit/Interface.h>
+#include <osvr/Util/ClientReportTypesC.h>
+#include <osvr/Util/StringIds.h>
+
+// Library/third-party includes
+// - none
+
+// Standard includes
+#include <iostream>
+#include <string>
+
+void gestureCallback(void *userdata, const OSVR_TimeValue * /*timestamp*/,
+                     const OSVR_GestureReport *report) {
+    auto &ctx = *static_cast<osvr::clientkit::ClientContext *>(userdata);
+
+    /// You would typically not do this every frame - you'd retrieve the ID
+    /// based on the string, and then just compare the ID. This is just to make
+    /// a more compelling example.
+    std::string name = ctx.getGestureNamefromID(osvr::util::StringID(report->gestureID));
+    std::cout << "Gesture: Sensor " << report->sensor << ": ID "
+              << report->gestureID << " (" << name << ") "
+              << (report->state == OSVR_GESTURE_COMPLETE ? "COMPLETE"
+                                                         : "IN PROGRESS")
+              << std::endl;
+}
+
+int main() {
+
+    osvr::clientkit::ClientContext ctx(
+        "com.osvr.exampleclients.GestureCallback");
+
+    osvr::clientkit::Interface gesture =
+        ctx.getInterface("/com_osvr_example_Gesture/Gesture/gesture");
+
+    gesture.registerCallback(&gestureCallback, &ctx);
+
+    // Pretend that this is your application's mainloop.
+    while (1) {
+        ctx.update();
+    }
+
+    std::cout << "Library shut down, exiting." << std::endl;
+    return 0;
+}

examples/plugin/CMakeLists.txt

@@ -4,6 +4,7 @@ set(OSVR_EXAMPLE_DEVICE_PLUGINS_SIMPLE
     com_osvr_example_Configured
     com_osvr_example_DummyDetectAndCreateAsync
     com_osvr_example_EyeTracker
+    com_osvr_example_Gesture
     com_osvr_example_Locomotion
     com_osvr_example_MultipleAsync
     org_osvr_example_Tracker)
@@ -39,6 +40,7 @@ endforeach()
 foreach(pluginname
     com_osvr_example_Configured
     com_osvr_example_EyeTracker
+    com_osvr_example_Gesture
     com_osvr_example_Locomotion
     org_osvr_example_Tracker
     com_osvr_example_MultipleAsync)

examples/plugin/com_osvr_example_Gesture.cpp

@@ -0,0 +1,125 @@
+/** @date 2015
+
+    @author
+    Sensics, Inc.
+    <http://sensics.com/osvr>
+*/
+
+// Copyright 2015 Sensics Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Internal Includes
+#include <osvr/PluginKit/PluginKit.h>
+#include <osvr/PluginKit/GestureInterfaceC.h>
+
+// Generated JSON header file
+#include "com_osvr_example_Gesture_json.h"
+
+// Library/third-party includes
+
+// Standard includes
+#include <iostream>
+#include <memory>
+#include <ctime>
+#include <chrono>
+#include <thread>
+
+// Anonymous namespace to avoid symbol collision
+namespace {
+
+OSVR_MessageType gestureMessage;
+
+class GestureDevice {
+  public:
+    GestureDevice(OSVR_PluginRegContext ctx) {
+        /// Create the initialization options
+        OSVR_DeviceInitOptions opts = osvrDeviceCreateInitOptions(ctx);
+        osvrDeviceGestureConfigure(opts, &m_gesture);
+
+        /// Create the sync device token with the options
+        m_dev.initSync(ctx, "Gesture", opts);
+
+        // get an ID for gesture names to be used in plugin
+        osvrDeviceGestureGetID(m_gesture, OSVR_GESTURE_DOUBLE_TAP,
+                               &m_double_tap_gesture);
+        osvrDeviceGestureGetID(m_gesture, "LASSO", &m_lasso_gesture);
+
+        /// Send JSON descriptor
+        m_dev.sendJsonDescriptor(com_osvr_example_Gesture_json);
+
+        /// Register update callback
+        m_dev.registerUpdateCallback(this);
+    }
+
+    OSVR_ReturnCode update() {
+
+        std::this_thread::sleep_for(std::chrono::milliseconds(
+            1000)); // Simulate waiting a quarter second for data.
+
+        OSVR_TimeValue times;
+
+        osvrTimeValueGetNow(&times);
+
+        osvrDeviceGestureReportData(m_gesture, m_double_tap_gesture,
+                                    OSVR_GESTURE_COMPLETE, 0, &times);
+        osvrDeviceGestureReportData(m_gesture, m_lasso_gesture,
+                                    OSVR_GESTURE_COMPLETE, 1, &times);
+
+        return OSVR_RETURN_SUCCESS;
+    }
+
+  private:
+    osvr::pluginkit::DeviceToken m_dev;
+    OSVR_GestureDeviceInterface m_gesture;
+    OSVR_GestureID m_lasso_gesture;
+    OSVR_GestureID m_double_tap_gesture;
+};
+
+class HardwareDetection {
+  public:
+    HardwareDetection() : m_found(false) {}
+    OSVR_ReturnCode operator()(OSVR_PluginRegContext ctx) {
+
+        if (m_found) {
+            return OSVR_RETURN_SUCCESS;
+        }
+
+        std::cout << "PLUGIN: Got a hardware detection request" << std::endl;
+
+        /// we always detect device in sample plugin
+        m_found = true;
+
+        std::cout << "PLUGIN: We have detected Gesture device! " << std::endl;
+        /// Create our device object
+        osvr::pluginkit::registerObjectForDeletion(ctx, new GestureDevice(ctx));
+
+        return OSVR_RETURN_SUCCESS;
+    }
+
+  private:
+    bool m_found;
+};
+} // namespace
+
+OSVR_PLUGIN(com_osvr_example_Gesture) {
+
+    osvrDeviceRegisterMessageType(ctx, "GestureMessage", &gestureMessage);
+
+    osvr::pluginkit::PluginContext context(ctx);
+
+    /// Register a detection callback function object.
+    context.registerHardwareDetectCallback(new HardwareDetection());
+
+    return OSVR_RETURN_SUCCESS;
+}

examples/plugin/com_osvr_example_Gesture.json

@@ -0,0 +1,20 @@
+{
+    "deviceVendor": "Sensics",
+    "deviceName": "Gesture",
+    "author": "Georgiy Frolov georgiy@sensics.com",
+    "version": 1,
+    "lastModified": "",
+    "interfaces": {
+        "gesture": {
+            "count": 2
+        }
+    },
+    "semantic": {
+        "left": "gesture/0",
+        "right": "gesture/1"
+    },
+    "automaticAliases": {
+        "/me/hands/left": "semantic/left",
+        "/me/hands/right": "semantic/right"
+    }
+}

inc/osvr/ClientKit/Context.h

@@ -112,6 +112,31 @@ namespace clientkit {
         return osvrClientCheckStatus(m_context) == OSVR_RETURN_SUCCESS;
     }
 
+    inline std::string ClientContext::getGestureNamefromID(util::StringID id) {
+
+        size_t length = 0;
+        OSVR_ReturnCode ret =
+            osvrClientGetGestureNameLength(m_context, id.value(), &length);
+        if (OSVR_RETURN_SUCCESS != ret) {
+            throw std::runtime_error(
+                "Invalid context or null reference to length variable.");
+        }
+
+        if (0 == length) {
+            return std::string();
+        }
+
+        util::StringBufferBuilder buf;
+
+        ret = osvrClientGetGestureNameFromID(
+            m_context, id.value(), buf.getBufferOfSize(length), length);
+        if (OSVR_RETURN_SUCCESS != ret) {
+            throw std::runtime_error("Invalid context, null reference to "
+                                     "buffer, or buffer is too small.");
+        }
+        return buf.str();
+    }
+
 } // end namespace clientkit
 
 } // end namespace osvr

inc/osvr/ClientKit/Context_decl.h

@@ -25,17 +25,9 @@
 #ifndef INCLUDED_ClientContext_decl_h_GUID_1EFFF79A_3D9F_4794_9F98_37010949F386
 #define INCLUDED_ClientContext_decl_h_GUID_1EFFF79A_3D9F_4794_9F98_37010949F386
 
-// Internal Includes
-// - none
-
-// Library/third-party includes
-// - none
-
-// Standard includes
-// - none
-
 // Internal Includes
 #include <osvr/ClientKit/ContextC.h>
+#include <osvr/Util/StringIds.h>
 
 // Library/third-party includes
 #include <boost/noncopyable.hpp>
@@ -95,6 +87,11 @@ namespace clientkit {
         /// from false to true without calling update() - consider a loop.
         bool checkStatus() const;
 
+        /// @brief converts gesture ID to string name. Not for frequent use -
+        /// typical usage is to get a gesture ID from a string, and use that for
+        /// comparison.
+        std::string getGestureNamefromID(util::StringID id);
+
         /// @brief Gets the bare OSVR_ClientContext.
         OSVR_ClientContext get();
 

inc/osvr/ClientKit/InterfaceC.h

@@ -40,7 +40,7 @@
 /* none */
 
 /* Standard includes */
-/* none */
+#include <stdint.h>
 
 OSVR_EXTERN_C_BEGIN
 /** @addtogroup ClientKit
@@ -69,6 +69,29 @@ osvrClientGetInterface(OSVR_ClientContext ctx, const char path[],
 OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode
 osvrClientFreeInterface(OSVR_ClientContext ctx, OSVR_ClientInterface iface);
 
+/** @brief Get the length of a string parameter associated with the given path.
+@param ctx Client context
+@param path A resource path (null-terminated string)
+@param[out] len The length of the string value, including null terminator. 0
+if the parameter does not exist or is not a string.
+
+*/
+OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetGestureNameLength(
+    OSVR_ClientContext ctx, uint32_t id, size_t *len);
+
+/** @brief Convert the gesture ID to string name representation
+
+    @param ctx Client context
+    @param id  An id that corresponds to an entry in gesture string to ID map
+    @param [in, out] buf A buffer that you allocate of appropriate size.
+    Must be at least the length returned by osvrClientGetStringParameterLength.
+    Will contain the null-terminated string name of the gesture ID.
+    @param len The length of the buffer you're providing. If the buffer is too
+    short, an error is returned and the buffer is unchanged.
+*/
+OSVR_CLIENTKIT_EXPORT OSVR_ReturnCode osvrClientGetGestureNameFromID(
+    OSVR_ClientContext ctx, uint32_t id, char *buf, size_t len);
+
 /** @} */
 OSVR_EXTERN_C_END
 

inc/osvr/ClientKit/InterfaceCallbackC.h

@@ -69,6 +69,7 @@ OSVR_INTERFACE_CALLBACK_METHOD(EyeTracker3D)
 OSVR_INTERFACE_CALLBACK_METHOD(EyeTrackerBlink)
 OSVR_INTERFACE_CALLBACK_METHOD(NaviVelocity)
 OSVR_INTERFACE_CALLBACK_METHOD(NaviPosition)
+OSVR_INTERFACE_CALLBACK_METHOD(Gesture)
 
 #undef OSVR_INTERFACE_CALLBACK_METHOD
 

inc/osvr/ClientKit/InterfaceStateC.h

@@ -71,6 +71,7 @@ OSVR_CALLBACK_METHODS(EyeTracker3D)
 OSVR_CALLBACK_METHODS(EyeTrackerBlink)
 OSVR_CALLBACK_METHODS(NaviVelocity)
 OSVR_CALLBACK_METHODS(NaviPosition)
+OSVR_CALLBACK_METHODS(Gesture)
 
 #undef OSVR_CALLBACK_METHODS