Source: src/h5.api.geo.js

  1. /*
  2.  * Copyright (C) 2012-2016 NS Solutions Corporation
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *    http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  *
  16.  * hifive
  17.  */
  18. /* ------ h5.api.geo ------ */
  19. (function() {
  20. 	// =========================================================================
  21. 	//
  22. 	// Constants
  23. 	//
  24. 	// =========================================================================
  26. 	// =============================
  27. 	// Production
  28. 	// =============================
  30. 	/** エラコード: 指定された緯度または経度の値が不正 */
  31. 	var ERR_CODE_INVALID_COORDS = 2000;
  32. 	/** エラーコード: getDistance()で、指定された計算モードの定数が不正 */
  33. 	var ERR_CODE_INVALID_GEOSYSTEM_CONSTANT = 2001;
  34. 	/** エラーコード: 位置情報の取得に失敗 */
  35. 	var ERR_CODE_POSITIONING_FAILURE = 2002;
  37. 	// =============================
  38. 	// Development Only
  39. 	// =============================
  41. 	/* del begin */
  42. 	var errMsgMap = {};
  43. 	errMsgMap[ERR_CODE_INVALID_COORDS] = '正しい緯度または経度を指定して下さい。';
  44. 	errMsgMap[ERR_CODE_INVALID_GEOSYSTEM_CONSTANT] = '正しい計算モード定数を指定して下さい';
  45. 	errMsgMap[ERR_CODE_POSITIONING_FAILURE] = '位置情報の取得に失敗しました。';
  46. 	addFwErrorCodeMap(errMsgMap);
  47. 	/* del end */
  49. 	// =========================================================================
  50. 	//
  51. 	// Cache
  52. 	//
  53. 	// =========================================================================
  54. 	// navigator.geolocationをキャッシュする変数
  55. 	var geo = null;
  56. 	function getGeo() {
  57. 		if (!geo) {
  58. 			geo = navigator.geolocation;
  59. 		}
  60. 		return geo;
  61. 	}
  63. 	var h5ua = h5.env.ua;
  65. 	// =========================================================================
  66. 	//
  67. 	// Privates
  68. 	//
  69. 	// =========================================================================
  71. 	// =============================
  72. 	// Variables
  73. 	// =============================
  75. 	// =============================
  76. 	// Functions
  77. 	// =============================
  79. 	// =========================================================================
  80. 	//
  81. 	// Body
  82. 	//
  83. 	// =========================================================================
  85. 	/**
  86. 	 * h5.api.geo.getDistance() の計算モードを指定するための定数クラス
  87. 	 * <p>
  88. 	 * このオブジェクトは自分でnewすることはありません。以下のオブジェクトにアクセスするとインスタンスが返されます。
  89. 	 * </p>
  90. 	 * <ul>
  91. 	 * <li>h5.api.geo.GS_GRS80</li>
  92. 	 * <li>h5.api.geo.GS_BESSEL</li>
  93. 	 * </ul>
  94. 	 *
  95. 	 * @class
  96. 	 * @name GeodeticSystemEnum
  97. 	 */
  98. 	function GeodeticSystemEnum(oblateness, semiMajorAxis) {
  99. 		// 扁平率
  100. 		this.oblateness = oblateness;
  101. 		// 長(赤道)半径
  102. 		this.semiMajorAxis = semiMajorAxis;
  103. 	}
  104. 	/**
  105. 	 * 扁平率を取得します。
  106. 	 *
  107. 	 * @memberOf GeodeticSystemEnum
  108. 	 * @name getOblateness
  109. 	 * @returns {Number} 扁平率
  110. 	 */
  111. 	GeodeticSystemEnum.prototype.getOblateness = function() {
  112. 		return this.oblateness;
  113. 	};
  114. 	/**
  115. 	 * 長(赤道)半径を取得します。
  116. 	 *
  117. 	 * @memberOf GeodeticSystemEnum
  118. 	 * @name getSemiMajorAxis
  119. 	 * @returns {Number} 長(赤道)半径
  120. 	 */
  121. 	GeodeticSystemEnum.prototype.getSemiMajorAxis = function() {
  122. 		return this.semiMajorAxis;
  123. 	};
  125. 	/** 計算モード: 世界測地系(GRS80) */
  126. 	var GRS80 = new GeodeticSystemEnum(298.257222, 6378137);
  127. 	/** 計算モード: 日本測地系(BESSEL) */
  128. 	var BESSEL = new GeodeticSystemEnum(299.152813, 6377397.155);
  129. 	/** ラジアン毎秒 - 1度毎秒 */
  130. 	var DEGREES_PER_SECOND = Math.PI / 180;
  132. 	/**
  133. 	 * Geolocation API
  134. 	 *
  135. 	 * @memberOf h5.api
  136. 	 * @name geo
  137. 	 * @namespace
  138. 	 */
  139. 	function Geolocation() {
  140. 	// 空コンストラクタ
  141. 	}
  143. 	$.extend(Geolocation.prototype, {
  144. 		/**
  145. 		 * Geolocation APIが使用可能であるかの判定結果<br>
  146. 		 *
  147. 		 * @type Boolean
  148. 		 * @memberOf h5.api.geo
  149. 		 * @name isSupported
  150. 		 */
  151. 		// IE9の場合、navigator.geolocationにアクセスするとメモリーリークするのでエージェントで利用可能か判定する
  152. 		isSupported: (h5ua.isIE && h5ua.browserVersion >= 9) ? true : !!getGeo(),
  153. 		/**
  154. 		 * 現在地の緯度・経度を取得します。
  155. 		 *
  156. 		 * @memberOf h5.api.geo
  157. 		 * @name getCurrentPosition
  158. 		 * @function
  159. 		 * @param {Object} [option] 設定情報
  160. 		 * @param {Boolean} [option.enableHighAccuracy] 正確な位置を取得するか (ただし消費電力の増加や応答が遅延する)
  161. 		 * @param {Number} [option.timeout] 位置情報を取得するまで待機する時間 (ミリ秒)
  162. 		 * @param {Number} [option.maximumAge] キャッシュされた位置情報の有効期間を指定する (ミリ秒)
  163. 		 * @returns {Promise} Promiseオブジェクト
  164. 		 */
  165. 		getCurrentPosition: function(option) {
  166. 			var dfd = h5.async.deferred();
  167. 			getGeo().getCurrentPosition(function(geoPosition) {
  168. 				dfd.resolve(geoPosition);
  169. 			}, function(e) {
  170. 				dfd.reject(createRejectReason(ERR_CODE_POSITIONING_FAILURE, null, e));
  171. 			}, option);
  172. 			return dfd.promise();
  173. 		},
  174. 		/**
  175. 		 * 現在地の緯度・経度を定期的に送信します。
  176. 		 * <p>
  177. 		 * このメソッドは定期的に位置情報を取得するため、Deferred.progress()で値を取得します。<br>
  178. 		 * (Deferred.done()では値を取得できません。)
  179. 		 * <p>
  180. 		 * <b>実装例</b><br>
  181. 		 *
  182. 		 * <pre>
  183. 		 * h5.api.geo.watchPosition().progress(function(pos) {
  184. 		 * // 変数 pos に位置情報が格納されている。
  185. 		 * 		});
  186. 		 * </pre>
  187. 		 *
  188. 		 * @memberOf h5.api.geo
  189. 		 * @name watchPosition
  190. 		 * @function
  191. 		 * @param {Object} [option] 設定情報
  192. 		 * @param {Boolean} [option.enableHighAccuracy] 正確な位置を取得するか (ただし消費電力の増加や応答が遅延する)
  193. 		 * @param {Number} [option.timeout] 位置情報を取得するまで待機する時間 (ミリ秒)
  194. 		 * @param {Number} [option.maximumAge] キャッシュされた位置情報の有効期間を指定する (ミリ秒)
  195. 		 * @returns {WatchPositionPromise} WatchPositionPromiseオブジェクト
  196. 		 */
  197. 		watchPosition: function(option) {
  198. 			var dfd = h5.async.deferred();
  199. 			var id = getGeo().watchPosition(function(pos) {
  200. 				dfd.notify(pos);
  201. 			}, function(e) {
  202. 				getGeo().clearWatch(id);
  203. 				dfd.reject(createRejectReason(ERR_CODE_POSITIONING_FAILURE, null, e));
  204. 			}, option);
  205. 			/**
  206. 			 * h5.api.geo.watchPositionがこのオブジェクトをプロミス化して返します。
  207. 			 * <p>
  208. 			 * このオブジェクトは自分でnewすることはありません。<b>h5.api.geo.watchPosition</b>関数を呼び出すとインスタンスが返されます。
  209. 			 * </p>
  210. 			 *
  211. 			 * @class
  212. 			 * @name WatchPositionPromise
  213. 			 */
  214. 			function WatchPositionPromise() {
  215. 			// 空コンストラクタ
  216. 			}
  217. 			/**
  218. 			 * h5.api.geo.watchPositionで行っているユーザの位置監視を終了します。
  219. 			 * <p>
  220. 			 * ユーザの位置監視を終了し、Deferred.done()が実行されます。
  221. 			 * </p>
  222. 			 *
  223. 			 * @memberOf WatchPositionPromise
  224. 			 * @name unwatch
  225. 			 */
  226. 			WatchPositionPromise.prototype.unwatch = function() {
  227. 				getGeo().clearWatch(id);
  228. 				dfd.resolve();
  229. 			};
  230. 			return dfd.promise(new WatchPositionPromise());
  231. 		},
  232. 		/**
  233. 		 * ヒュベニの法則を使用して、2点間の緯度・経度から直線距離(m)を取得します。
  234. 		 * <p>
  235. 		 * 定数に使用している長半径・扁平率は国土地理院で紹介されている値を使用。
  236. 		 * <p>
  237. 		 * 注意:アルゴリズム上、長距離(100km以上)の地点を図る場合1m以上の誤差が出てしまいます。
  238. 		 * <h4>計算モードの指定方法</h4>
  239. 		 * 計算モードの指定は以下の定数クラスを使用します。<br>
  240. 		 * <table border="1">
  241. 		 * <tr>
  242. 		 * <td>h5.api.geo.GS_GRS80</td>
  243. 		 * <td>世界測地系</td>
  244. 		 * </tr>
  245. 		 * <tr>
  246. 		 * <td>h5.api.geo.GS_BESSEL</td>
  247. 		 * <td>日本測地系</td>
  248. 		 * </tr>
  249. 		 * </table>
  250. 		 *
  251. 		 * @memberOf h5.api.geo
  252. 		 * @name getDistance
  253. 		 * @function
  254. 		 * @param {Number} lat1 地点1の緯度
  255. 		 * @param {Number} lng1 地点1の経度
  256. 		 * @param {Number} lat2 地点2の緯度
  257. 		 * @param {Number} lng2 地点2の経度
  258. 		 * @param {GeodeticSystemEnum} [geoSystem] 計算モード定数
  259. 		 *            (h5.api.geo.GS_GRS80:世界測地系(未指定の場合このモードで計算する) / h5.api.geo.GS_BESSEL: 日本測地系)
  260. 		 * @returns {Number} 2点間の直線距離
  261. 		 */
  262. 		// TODO 長距離の場合も考えて、距離によって誤差が大きくならない『測地線航海算法』で計算するメソッドの追加も要検討
  263. 		getDistance: function(lat1, lng1, lat2, lng2, geoSystem) {
  264. 			if (!isFinite(lat1) || !isFinite(lng1) || !isFinite(lat2) || !isFinite(lng2)) {
  265. 				throwFwError(ERR_CODE_INVALID_COORDS);
  266. 			}
  267. 			var geodeticMode = geoSystem ? geoSystem : GRS80;
  268. 			if (!(geodeticMode instanceof GeodeticSystemEnum)) {
  269. 				throwFwError(ERR_CODE_INVALID_GEOSYSTEM_CONSTANT);
  270. 			}
  271. 			// 長半径(赤道半径)
  272. 			var A = geodeticMode.getSemiMajorAxis();
  273. 			// 扁平率
  274. 			var O = geodeticMode.getOblateness();
  275. 			// 起点の緯度のラジアン
  276. 			var latRad1 = lat1 * DEGREES_PER_SECOND;
  277. 			// 起点の経度のラジアン
  278. 			var lngRad1 = lng1 * DEGREES_PER_SECOND;
  279. 			// 終点の緯度のラジアン
  280. 			var latRad2 = lat2 * DEGREES_PER_SECOND;
  281. 			// 終点の経度のラジアン
  282. 			var lngRad2 = lng2 * DEGREES_PER_SECOND;
  283. 			// 2点の平均緯度
  284. 			var avgLat = (latRad1 + latRad2) / 2;
  285. 			// 第一離心率
  286. 			var e = (Math.sqrt(2 * O - 1)) / O;
  287. 			var e2 = Math.pow(e, 2);
  288. 			var W = Math.sqrt(1 - e2 * Math.pow(Math.sin(avgLat), 2));
  289. 			// 短半径(極半径)
  290. 			var semiminorAxis = A * (1 - e2);
  291. 			// 子午線曲率半径
  292. 			var M = semiminorAxis / Math.pow(W, 3);
  293. 			// 卯酉船曲率半径
  294. 			var N = A / W;
  295. 			// 2点の緯度差
  296. 			var deltaLat = latRad1 - latRad2;
  297. 			// 2点の経度差
  298. 			var deltaLon = lngRad1 - lngRad2;
  299. 			return Math.sqrt(Math.pow(M * deltaLat, 2)
  300. 					+ Math.pow(N * Math.cos(avgLat) * deltaLon, 2));
  301. 		},
  302. 		/**
  303. 		 * getDistanceメソッドで使用する計算モード定数 (世界測地系:GRS80)
  304. 		 *
  305. 		 * @constant
  306. 		 * @memberOf h5.api.geo
  307. 		 * @name GS_GRS80
  308. 		 */
  309. 		GS_GRS80: GRS80,
  310. 		/**
  311. 		 * getDistanceメソッドで使用する計算モード定数 (日本測地系:BESSEL)
  312. 		 *
  313. 		 * @constant
  314. 		 * @memberOf h5.api.geo
  315. 		 * @name GS_BESSEL
  316. 		 */
  317. 		GS_BESSEL: BESSEL
  318. 	});
  320. 	// =============================
  321. 	// Expose to window
  322. 	// =============================
  324. 	h5.u.obj.expose('h5.api', {
  325. 		geo: new Geolocation()
  326. 	});
  327. })();