Skip to content

Instantly share code, notes, and snippets.

@yailPeralta
Last active August 11, 2016 19:24
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save yailPeralta/d86126fe96a0a43f441e11a1cb3bb80e to your computer and use it in GitHub Desktop.
Save yailPeralta/d86126fe96a0a43f441e11a1cb3bb80e to your computer and use it in GitHub Desktop.
The ngCordova wrapper for WikitudePlugin for Cordova
/**
* Created by yailanderson on 10/06/16.
*/
'use strict';
// install : cordova plugin add https://github.com/Wikitude/wikitude-cordova-plugin.git
(function (angular) {
angular.module('ngCordova.plugins.wikitudePlugin', [])
.factory('$wikitudePlugin', ['$q', '$window', '$exceptionHandler', function ($q, $window, $exceptionHandler) {
return {
/**
* internal listeners for success and error, they are invoked in cordova.exec() function
*/
setInternalListeners: function () {
$window.plugins.wikitudePlugin.prototype.onWikitudeOK = function (success) {
//success callback
};
$window.plugins.wikitudePlugin.prototype.onWikitudeError = function (error) {
// error callback
throw (error);
};
},
/**
* array of requiredFeatures for instance [ "2d_tracking", "geo" ]
* if no argument is passed the default value is 2d tracking
* @param requiredFeatures
* @returns {*}
*/
isDeviceSupported: function(requiredFeatures) {
// set the internal listeners for success and error
this.setInternalListeners();
var self = this;
var q = $q.defer();
// store features in the $wikitudePlugin for accessing it in all methods
self.features = requiredFeatures || [ '2d_tracking' ];
$window.plugins.wikitudePlugin.isDeviceSupported(function () {
//device supported
q.resolve(self);
}, function () {
//device not supported
q.reject('device not supported!');
}, self.features);
return q.promise;
},
/**
*
* @param worldPath
* @param startupConfiguration
*/
loadARchitectWorld: function (worldPath, startupConfiguration) {
var q = $q.defer();
// startup configuration converted to json
var config = JSON.stringify( startupConfiguration || { 'camera_position': 'back' } );
if (typeof worldPath === 'string') {
$window.plugins.wikitudePlugin.loadARchitectWorld(function (loadedURL) {
// loadedSuccessful
q.resolve(loadedURL);
}, function (errorMessage) {
// error local path is wrong or the remote url returned an error code
q.reject(errorMessage);
},worldPath, this.features, config);
}
return q.promise;
},
/**
* inject a location into the Wikitude SDK
* @param latitude
* @param longitude
* @param altitude
* @param accuracy
*/
setLocation: function (latitude, longitude, altitude, accuracy) {
try {
//inject a location into the Wikitude SDK
$window.plugins.wikitudePlugin.setLocation(latitude, longitude, altitude, accuracy);
} catch (e) {
// handle execption
$exceptionHandler(e.message);
}
},
/**
* The first argument Indicates if the ARchitect
* web view should be included in the generated screenshot or not.
* If a file path or file name is given in the second argument,
* the generated screenshot will be saved in the application bundle.
* Passing null will save the photo in the device photo library
* @param includeWebView
* @param imagePath
* @returns {*}
*/
captureScreen: function (includeWebView, imagePath) {
var q = $q.defer();
$window.plugins.wikitudePlugin.captureScreen(includeWebView, imagePath, function (bundlePath) {
//success
q.resolve(bundlePath);
}, function (error) {
//error
q.reject(error);
});
return q.promise;
},
callJavaScript: function (js) {
try {
$window.plugins.wikitudePlugin.callJavaScript(js);
} catch (e) {
$exceptionHandler(e);
}
},
setOnUrlInvokeCallback: function (onUrlInvokeCallback) {
$window.plugins.wikitudePlugin.setOnUrlInvokeCallback(onUrlInvokeCallback);
},
close: function () {
$window.plugins.wikitudePlugin.close();
},
show: function () {
$window.plugins.wikitudePlugin.show();
},
hide: function () {
$window.plugins.wikitudePlugin.hide();
}
};// end of wikitudePlugin factory
}]);
})(window.angular);
@fetimo
Copy link

fetimo commented Aug 9, 2016

Thanks for this, it looks really useful but I'm having issues implementing this with the config.js file, is there any chance you could post an example? It seems that $window.plugins is undefined (using Cordova 4.2.0) and writing directly to WikitudePlugin (in setInternalListeners) isn't supported as it's read-only. FWIW this is how I tweaked it to work for me https://gist.github.com/fetimo/588f48e5c263b65ed9066f0727e34063

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment