Merge pull request #4 from mlynch/master

feat(taptic): gesture control for selection events.
EddyVerbruggen · Oct 6, 2016 · d1b3377 · d1b3377
2 parents bea7e0e + 48c0db1
commit d1b3377
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 0 deletions.
diff --git a/src/ios/TapticEngine.h b/src/ios/TapticEngine.h
@@ -12,4 +12,8 @@
 - (void) strongBoom:(CDVInvokedUrlCommand*)command;
 - (void) burst:(CDVInvokedUrlCommand*)command;
 
+// This property stores a selection feedback generator during
+// gestures, as per https://developer.apple.com/reference/uikit/uifeedbackgenerator#2555399
+@property UISelectionFeedbackGenerator *selectionGenerator;
+
 @end
diff --git a/src/ios/TapticEngine.m b/src/ios/TapticEngine.m
@@ -40,6 +40,10 @@ - (void) notification:(CDVInvokedUrlCommand *)command
   [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK] callbackId:command.callbackId];
 }
 
+/**
+ * Trigger selection feedback in one burst, useful for non-gesture based
+ * selection feedback.
+ */
 - (void) selection:(CDVInvokedUrlCommand *)command
 {
   UISelectionFeedbackGenerator *generator = [UISelectionFeedbackGenerator new];
@@ -52,6 +56,54 @@ - (void) selection:(CDVInvokedUrlCommand *)command
   [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK] callbackId:command.callbackId];
 }
 
+
+/**
+ * Used to prepare a taptic event for future taptic events in a gesture.
+ */
+- (void) gestureSelectionStart:(CDVInvokedUrlCommand *)command
+{
+    if(!self.selectionGenerator) {
+        self.selectionGenerator = [UISelectionFeedbackGenerator new];
+        if (self.selectionGenerator == nil || isSimulator) {
+            [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Unsupported Operating System"] callbackId:command.callbackId];
+            return;
+        }
+    }
+
+    [self.selectionGenerator prepare];
+
+
+    [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK] callbackId:command.callbackId];
+}
+
+/**
+ * While in a gesture, we can efficiently trigger a selection taptic event.
+* gestureSelectionStart should be called first.
+ */
+- (void) gestureSelectionChanged:(CDVInvokedUrlCommand *)command
+{
+    if(!self.selectionGenerator) {
+        [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Unsupported Operating System"] callbackId:command.callbackId];
+        return;
+    }
+
+    [self.selectionGenerator selectionChanged];
+    [self.selectionGenerator prepare];
+
+    [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK] callbackId:command.callbackId];
+}
+
+/**
+ * Called at the end of a gesture to clean up the taptic reference.
+ */
+- (void) gestureSelectionEnd:(CDVInvokedUrlCommand *)command
+{
+    // Free up the selection generator
+    self.selectionGenerator = nil;
+
+    [self.commandDelegate sendPluginResult:[CDVPluginResult resultWithStatus:CDVCommandStatus_OK] callbackId:command.callbackId];
+}
+
 - (void) impact:(CDVInvokedUrlCommand *)command
 {
   NSDictionary* options = command.arguments[0];

diff --git a/www/TapticEngine.js b/www/TapticEngine.js
@@ -32,5 +32,14 @@ TapticEngine.prototype.impact = function (options, onSuccess, onFail) {
   exec(onSuccess, onFail, "TapticEngine", "impact", [options]);
 };
 
+TapticEngine.prototype.gestureSelectionStart = function (onSuccess, onFail) {
+  exec(onSuccess, onFail, "TapticEngine", "gestureSelectionStart", []);
+};
+TapticEngine.prototype.gestureSelectionChanged = function (onSuccess, onFail) {
+  exec(onSuccess, onFail, "TapticEngine", "gestureSelectionChanged", []);
+};
+TapticEngine.prototype.gestureSelectionEnd = function (onSuccess, onFail) {
+  exec(onSuccess, onFail, "TapticEngine", "gestureSelectionEnd", []);
+};
 
 module.exports = new TapticEngine();