352 lines
9.2 KiB
JavaScript
352 lines
9.2 KiB
JavaScript
// FIXME handle geolocation not supported
|
|
|
|
goog.provide('ol.Geolocation');
|
|
goog.provide('ol.Geolocation.SUPPORTED');
|
|
goog.provide('ol.GeolocationProperty');
|
|
|
|
goog.require('goog.events');
|
|
goog.require('goog.events.EventType');
|
|
goog.require('goog.math');
|
|
goog.require('ol.Coordinate');
|
|
goog.require('ol.Object');
|
|
goog.require('ol.Projection');
|
|
goog.require('ol.proj');
|
|
|
|
|
|
/**
|
|
* @enum {string}
|
|
*/
|
|
ol.GeolocationProperty = {
|
|
ACCURACY: 'accuracy',
|
|
ALTITUDE: 'altitude',
|
|
ALTITUDE_ACCURACY: 'altitudeAccuracy',
|
|
HEADING: 'heading',
|
|
POSITION: 'position',
|
|
PROJECTION: 'projection',
|
|
SPEED: 'speed',
|
|
TRACKING: 'tracking',
|
|
TRACKING_OPTIONS: 'trackingOptions'
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
* Helper class for providing HTML5 Geolocation capabilities.
|
|
* The [Geolocation API](http://dev.w3.org/geo/api/spec-source.html)
|
|
* is used to locate a user's position.
|
|
*
|
|
* Example:
|
|
*
|
|
* var geolocation = new ol.Geolocation();
|
|
* // take the projection to use from the map's view
|
|
* geolocation.bindTo('projection', map.getView());
|
|
* // listen to changes in position
|
|
* geolocation.on('change:position', function(evt) {
|
|
* window.console.log(geolocation.getPosition());
|
|
* });
|
|
*
|
|
* @constructor
|
|
* @extends {ol.Object}
|
|
* @param {ol.GeolocationOptions=} opt_options Options.
|
|
*/
|
|
ol.Geolocation = function(opt_options) {
|
|
|
|
goog.base(this);
|
|
|
|
var options = goog.isDef(opt_options) ? opt_options : {};
|
|
|
|
/**
|
|
* The unprojected (EPSG:4326) device position.
|
|
* @private
|
|
* @type {ol.Coordinate}
|
|
*/
|
|
this.position_ = null;
|
|
|
|
/**
|
|
* @private
|
|
* @type {ol.TransformFunction}
|
|
*/
|
|
this.transform_ = ol.proj.identityTransform;
|
|
|
|
/**
|
|
* @private
|
|
* @type {number|undefined}
|
|
*/
|
|
this.watchId_ = undefined;
|
|
|
|
goog.events.listen(
|
|
this, ol.Object.getChangeEventType(ol.GeolocationProperty.PROJECTION),
|
|
this.handleProjectionChanged_, false, this);
|
|
goog.events.listen(
|
|
this, ol.Object.getChangeEventType(ol.GeolocationProperty.TRACKING),
|
|
this.handleTrackingChanged_, false, this);
|
|
|
|
if (goog.isDef(options.projection)) {
|
|
this.setProjection(ol.proj.get(options.projection));
|
|
}
|
|
if (goog.isDef(options.trackingOptions)) {
|
|
this.setTrackingOptions(options.trackingOptions);
|
|
}
|
|
|
|
this.setTracking(goog.isDef(options.tracking) ? options.tracking : false);
|
|
|
|
};
|
|
goog.inherits(ol.Geolocation, ol.Object);
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.Geolocation.prototype.disposeInternal = function() {
|
|
this.setTracking(false);
|
|
goog.base(this, 'disposeInternal');
|
|
};
|
|
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
ol.Geolocation.prototype.handleProjectionChanged_ = function() {
|
|
var projection = this.getProjection();
|
|
if (goog.isDefAndNotNull(projection)) {
|
|
this.transform_ = ol.proj.getTransformFromProjections(
|
|
ol.proj.get('EPSG:4326'), projection);
|
|
if (!goog.isNull(this.position_)) {
|
|
this.set(
|
|
ol.GeolocationProperty.POSITION, this.transform_(this.position_));
|
|
}
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
ol.Geolocation.prototype.handleTrackingChanged_ = function() {
|
|
if (ol.Geolocation.SUPPORTED) {
|
|
var tracking = this.getTracking();
|
|
if (tracking && !goog.isDef(this.watchId_)) {
|
|
this.watchId_ = goog.global.navigator.geolocation.watchPosition(
|
|
goog.bind(this.positionChange_, this),
|
|
goog.bind(this.positionError_, this),
|
|
this.getTrackingOptions());
|
|
} else if (!tracking && goog.isDef(this.watchId_)) {
|
|
goog.global.navigator.geolocation.clearWatch(this.watchId_);
|
|
this.watchId_ = undefined;
|
|
}
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Is HTML5 geolocation supported in the current browser?
|
|
* @const
|
|
* @type {boolean}
|
|
*/
|
|
ol.Geolocation.SUPPORTED = 'geolocation' in goog.global.navigator;
|
|
|
|
|
|
/**
|
|
* @private
|
|
* @param {GeolocationPosition} position position event.
|
|
*/
|
|
ol.Geolocation.prototype.positionChange_ = function(position) {
|
|
var coords = position.coords;
|
|
this.set(ol.GeolocationProperty.ACCURACY, coords.accuracy);
|
|
this.set(ol.GeolocationProperty.ALTITUDE,
|
|
goog.isNull(coords.altitude) ? undefined : coords.altitude);
|
|
this.set(ol.GeolocationProperty.ALTITUDE_ACCURACY,
|
|
goog.isNull(coords.altitudeAccuracy) ?
|
|
undefined : coords.altitudeAccuracy);
|
|
this.set(ol.GeolocationProperty.HEADING, goog.isNull(coords.heading) ?
|
|
undefined : goog.math.toRadians(coords.heading));
|
|
if (goog.isNull(this.position_)) {
|
|
this.position_ = [coords.longitude, coords.latitude];
|
|
} else {
|
|
this.position_[0] = coords.longitude;
|
|
this.position_[1] = coords.latitude;
|
|
}
|
|
this.set(ol.GeolocationProperty.POSITION, this.transform_(this.position_));
|
|
this.set(ol.GeolocationProperty.SPEED,
|
|
goog.isNull(coords.speed) ? undefined : coords.speed);
|
|
};
|
|
|
|
|
|
/**
|
|
* @private
|
|
* @param {GeolocationPositionError} error error object.
|
|
*/
|
|
ol.Geolocation.prototype.positionError_ = function(error) {
|
|
error.type = goog.events.EventType.ERROR;
|
|
this.dispatchEvent(error);
|
|
};
|
|
|
|
|
|
/**
|
|
* Get the accuracy of the position in meters.
|
|
* @return {number|undefined} accuracy in meters.
|
|
*/
|
|
ol.Geolocation.prototype.getAccuracy = function() {
|
|
return /** @type {number|undefined} */ (
|
|
this.get(ol.GeolocationProperty.ACCURACY));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getAccuracy',
|
|
ol.Geolocation.prototype.getAccuracy);
|
|
|
|
|
|
/**
|
|
* Get the altitude associated with the position.
|
|
* @return {number|undefined} The altitude in meters above the mean sea level.
|
|
*/
|
|
ol.Geolocation.prototype.getAltitude = function() {
|
|
return /** @type {number|undefined} */ (
|
|
this.get(ol.GeolocationProperty.ALTITUDE));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getAltitude',
|
|
ol.Geolocation.prototype.getAltitude);
|
|
|
|
|
|
/**
|
|
* Get the altitude accuracy of the position.
|
|
* @return {number|undefined} Altitude accuracy.
|
|
*/
|
|
ol.Geolocation.prototype.getAltitudeAccuracy = function() {
|
|
return /** @type {number|undefined} */ (
|
|
this.get(ol.GeolocationProperty.ALTITUDE_ACCURACY));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getAltitudeAccuracy',
|
|
ol.Geolocation.prototype.getAltitudeAccuracy);
|
|
|
|
|
|
/**
|
|
* Get the heading as radians clockwise from North.
|
|
* @return {number|undefined} Heading.
|
|
*/
|
|
ol.Geolocation.prototype.getHeading = function() {
|
|
return /** @type {number|undefined} */ (
|
|
this.get(ol.GeolocationProperty.HEADING));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getHeading',
|
|
ol.Geolocation.prototype.getHeading);
|
|
|
|
|
|
/**
|
|
* Get the position of the device.
|
|
* @return {ol.Coordinate|undefined} position.
|
|
*/
|
|
ol.Geolocation.prototype.getPosition = function() {
|
|
return /** @type {ol.Coordinate|undefined} */ (
|
|
this.get(ol.GeolocationProperty.POSITION));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getPosition',
|
|
ol.Geolocation.prototype.getPosition);
|
|
|
|
|
|
/**
|
|
* Get the projection associated with the position.
|
|
* @return {ol.Projection|undefined} projection.
|
|
*/
|
|
ol.Geolocation.prototype.getProjection = function() {
|
|
return /** @type {ol.Projection|undefined} */ (
|
|
this.get(ol.GeolocationProperty.PROJECTION));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getProjection',
|
|
ol.Geolocation.prototype.getProjection);
|
|
|
|
|
|
/**
|
|
* Get the speed in meters per second.
|
|
* @return {number|undefined} Speed.
|
|
*/
|
|
ol.Geolocation.prototype.getSpeed = function() {
|
|
return /** @type {number|undefined} */ (
|
|
this.get(ol.GeolocationProperty.SPEED));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getSpeed',
|
|
ol.Geolocation.prototype.getSpeed);
|
|
|
|
|
|
/**
|
|
* Are we tracking the user's position?
|
|
* @return {boolean} tracking.
|
|
*/
|
|
ol.Geolocation.prototype.getTracking = function() {
|
|
return /** @type {boolean} */ (
|
|
this.get(ol.GeolocationProperty.TRACKING));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getTracking',
|
|
ol.Geolocation.prototype.getTracking);
|
|
|
|
|
|
/**
|
|
* Get the tracking options.
|
|
* @see http://www.w3.org/TR/geolocation-API/#position-options
|
|
* @return {GeolocationPositionOptions|undefined} HTML 5 Gelocation
|
|
* tracking options.
|
|
*/
|
|
ol.Geolocation.prototype.getTrackingOptions = function() {
|
|
return /** @type {GeolocationPositionOptions|undefined} */ (
|
|
this.get(ol.GeolocationProperty.TRACKING_OPTIONS));
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'getTrackingOptions',
|
|
ol.Geolocation.prototype.getTrackingOptions);
|
|
|
|
|
|
/**
|
|
* Set the projection to use for transforming the coordinates.
|
|
* @param {ol.Projection} projection Projection.
|
|
*/
|
|
ol.Geolocation.prototype.setProjection = function(projection) {
|
|
this.set(ol.GeolocationProperty.PROJECTION, projection);
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'setProjection',
|
|
ol.Geolocation.prototype.setProjection);
|
|
|
|
|
|
/**
|
|
* Enable/disable tracking.
|
|
* @param {boolean} tracking Enable or disable tracking.
|
|
*/
|
|
ol.Geolocation.prototype.setTracking = function(tracking) {
|
|
this.set(ol.GeolocationProperty.TRACKING, tracking);
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'setTracking',
|
|
ol.Geolocation.prototype.setTracking);
|
|
|
|
|
|
/**
|
|
* Set the tracking options.
|
|
* @see http://www.w3.org/TR/geolocation-API/#position-options
|
|
* @param {GeolocationPositionOptions} options HTML 5 Geolocation
|
|
* tracking options.
|
|
*/
|
|
ol.Geolocation.prototype.setTrackingOptions = function(options) {
|
|
this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options);
|
|
};
|
|
goog.exportProperty(
|
|
ol.Geolocation.prototype,
|
|
'setTrackingOptions',
|
|
ol.Geolocation.prototype.setTrackingOptions);
|