# all files / ol/ deviceorientation.js

49.06% Statements 26/53
10.71% Branches 3/28
30% Functions 3/10
49.06% Lines 26/53

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    2321×
    1×

    1×
    1×
    1×
    1×
    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×
    1×

    1×
    1×

     goog.provide('ol.DeviceOrientation');
    goog.provide('ol.DeviceOrientationProperty');

    goog.require('goog.events');
    goog.require('ol');
    goog.require('ol.Object');
    goog.require('ol.has');
    goog.require('ol.math');

    /**
     * @enum {string}
     */
    ol.DeviceOrientationProperty = {
      ALPHA: 'alpha',
      BETA: 'beta',
      GAMMA: 'gamma',
      HEADING: 'heading',
      TRACKING: 'tracking'
    };

    /**
     * @classdesc
     * The ol.DeviceOrientation class provides access to information from
     * DeviceOrientation events.  See the [HTML 5 DeviceOrientation Specification](
     * http://www.w3.org/TR/orientation-event/) for more details.
     *
     * Many new computers, and especially mobile phones
     * and tablets, provide hardware support for device orientation. Web
     * developers targeting mobile devices will be especially interested in this
     * class.
     *
     * Device orientation data are relative to a common starting point. For mobile
     * devices, the starting point is to lay your phone face up on a table with the
     * top of the phone pointing north. This represents the zero state. All
     * angles are then relative to this state. For computers, it is the same except
     * the screen is open at 90 degrees.
     *
     * Device orientation is reported as three angles - `alpha`, `beta`, and
     * `gamma` - relative to the starting position along the three planar axes X, Y
     * and Z. The X axis runs from the left edge to the right edge through the
     * middle of the device. Similarly, the Y axis runs from the bottom to the top
     * of the device through the middle. The Z axis runs from the back to the front
     * through the middle. In the starting position, the X axis points to the
     * right, the Y axis points away from you and the Z axis points straight up
     * from the device lying flat.
     *
     * The three angles representing the device orientation are relative to the
     * three axes. `alpha` indicates how much the device has been rotated around the
     * Z axis, which is commonly interpreted as the compass heading (see note
     * below). `beta` indicates how much the device has been rotated around the X
     * axis, or how much it is tilted from front to back.  `gamma` indicates how
     * much the device has been rotated around the Y axis, or how much it is tilted
     * from left to right.
     *
     * For most browsers, the `alpha` value returns the compass heading so if the
     * device points north, it will be 0.  With Safari on iOS, the 0 value of
     * `alpha` is calculated from when device orientation was first requested.
     * ol.DeviceOrientation provides the `heading` property which normalizes this
     * behavior across all browsers for you.
     *
     * It is important to note that the HTML 5 DeviceOrientation specification
     * indicates that `alpha`, `beta` and `gamma` are in degrees while the
     * equivalent properties in ol.DeviceOrientation are in radians for consistency
     * with all other uses of angles throughout OpenLayers.
     *
     * @see http://www.w3.org/TR/orientation-event/
     *
     * To get notified of device orientation changes, register a listener for the
     * generic `change` event on your `ol.DeviceOrientation` instance.
     *
     * @constructor
     * @extends {ol.Object}
     * @param {olx.DeviceOrientationOptions=} opt_options Options.
     * @api
     */
    ol.DeviceOrientation = function(opt_options) {

      goog.base(this);

      var options = opt_options ? opt_options : {};

      /**
       * @private
       * @type {goog.events.Key}
       */
      this.listenerKey_ = null;

      goog.events.listen(this,
          ol.Object.getChangeEventType(ol.DeviceOrientationProperty.TRACKING),
          this.handleTrackingChanged_, false, this);

      this.setTracking(options.tracking !== undefined ? options.tracking : false);

    };
    goog.inherits(ol.DeviceOrientation, ol.Object);

    /**
     * @inheritDoc
     */
    ol.DeviceOrientation.prototype.disposeInternal = function() {
      this.setTracking(false);
      goog.base(this, 'disposeInternal');
    };

    /**
     * @private
     * @param {goog.events.BrowserEvent} browserEvent Event.
     */
    ol.DeviceOrientation.prototype.orientationChange_ = function(browserEvent) {
      var event = /** @type {DeviceOrientationEvent} */
          (browserEvent.getBrowserEvent());
      if (event.alpha !== null) {
        var alpha = ol.math.toRadians(event.alpha);
        this.set(ol.DeviceOrientationProperty.ALPHA, alpha);
        // event.absolute is undefined in iOS.
        if (goog.isBoolean(event.absolute) && event.absolute) {
          this.set(ol.DeviceOrientationProperty.HEADING, alpha);
        } else if (goog.isNumber(event.webkitCompassHeading) &&
                   event.webkitCompassAccuracy != -1) {
          var heading = ol.math.toRadians(event.webkitCompassHeading);
          this.set(ol.DeviceOrientationProperty.HEADING, heading);
        }
      }
      if (event.beta !== null) {
        this.set(ol.DeviceOrientationProperty.BETA,
            ol.math.toRadians(event.beta));
      }
      if (event.gamma !== null) {
        this.set(ol.DeviceOrientationProperty.GAMMA,
            ol.math.toRadians(event.gamma));
      }
      this.changed();
    };

    /**
     * Rotation around the device z-axis (in radians).
     * @return {number|undefined} The euler angle in radians of the device from the
     *     standard Z axis.
     * @observable
     * @api
     */
    ol.DeviceOrientation.prototype.getAlpha = function() {
      return /** @type {number|undefined} */ (
          this.get(ol.DeviceOrientationProperty.ALPHA));
    };

    /**
     * Rotation around the device x-axis (in radians).
     * @return {number|undefined} The euler angle in radians of the device from the
     *     planar X axis.
     * @observable
     * @api
     */
    ol.DeviceOrientation.prototype.getBeta = function() {
      return /** @type {number|undefined} */ (
          this.get(ol.DeviceOrientationProperty.BETA));
    };

    /**
     * Rotation around the device y-axis (in radians).
     * @return {number|undefined} The euler angle in radians of the device from the
     *     planar Y axis.
     * @observable
     * @api
     */
    ol.DeviceOrientation.prototype.getGamma = function() {
      return /** @type {number|undefined} */ (
          this.get(ol.DeviceOrientationProperty.GAMMA));
    };

    /**
     * The heading of the device relative to north (in radians).
     * @return {number|undefined} The heading of the device relative to north, in
     *     radians, normalizing for different browser behavior.
     * @observable
     * @api
     */
    ol.DeviceOrientation.prototype.getHeading = function() {
      return /** @type {number|undefined} */ (
          this.get(ol.DeviceOrientationProperty.HEADING));
    };

    /**
     * Determine if orientation is being tracked.
     * @return {boolean} Changes in device orientation are being tracked.
     * @observable
     * @api
     */
    ol.DeviceOrientation.prototype.getTracking = function() {
      return /** @type {boolean} */ (
          this.get(ol.DeviceOrientationProperty.TRACKING));
    };

    /**
     * @private
     */
    ol.DeviceOrientation.prototype.handleTrackingChanged_ = function() {
      Iif (ol.has.DEVICE_ORIENTATION) {
        var tracking = this.getTracking();
        if (tracking && !this.listenerKey_) {
          this.listenerKey_ = goog.events.listen(goog.global, 'deviceorientation',
              this.orientationChange_, false, this);
        } else if (!tracking && this.listenerKey_) {
          goog.events.unlistenByKey(this.listenerKey_);
          this.listenerKey_ = null;
        }
      }
    };

    /**
     * Enable or disable tracking of device orientation events.
     * @param {boolean} tracking The status of tracking changes to alpha, beta and
     *     gamma. If true, changes are tracked and reported immediately.
     * @observable
     * @api
     */
    ol.DeviceOrientation.prototype.setTracking = function(tracking) {
      this.set(ol.DeviceOrientationProperty.TRACKING, tracking);
    };