add extjs 6.0.1 sources

[extjs.git] / extjs / packages / legacy / modern / src / device / Compass.js

/**\r
 * Provides access to the native Compass API when running on a device. There are three implementations of this API:\r
 *\r
 * - [PhoneGap](http://docs.phonegap.com/en/2.6.0/cordova_compass_compass.md.html#Compass)\r
 *\r
 * This class will automatically select the correct implementation depending on the device your application is running on.\r
 *\r
 * ## Examples\r
 *\r
 * Getting the current location:\r
 *\r
 *     Ext.device.Compass.getCurrentHeading({\r
 *         success: function(heading) {\r
 *                      alert('Heading: ' + heading.magneticHeading);\r
 *          },\r
 *         failure: function() {\r
 *             console.log('something went wrong!');\r
 *         }\r
 *     });\r
 *\r
 * Watching the current compass:\r
 *\r
 *     Ext.device.Compass.watchHeading({\r
 *         frequency: 500, // Update every 1/2 second\r
 *         callback: function(heading) {\r
 *                      console.log('Heading: ' + heading.magneticHeading);\r
 *          },\r
 *         failure: function() {\r
 *             console.log('something went wrong!');\r
 *         }\r
 *     });\r
 *\r
 * @mixins Ext.device.compass.Abstract\r
 */\r
Ext.define('Ext.device.Compass', {\r
    singleton: true,\r
\r
    requires: [\r
        'Ext.device.compass.Cordova',\r
        'Ext.device.compass.Simulator'\r
    ],\r
\r
    constructor: function() {\r
        var browserEnv = Ext.browser.is;\r
        if (browserEnv.WebView && browserEnv.Cordova) {\r
            return Ext.create('Ext.device.compass.Cordova');\r
        }\r
\r
        return Ext.create('Ext.device.compass.Simulator');\r
    }\r
});\r