1 | /* |
2 | Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/ |
3 | |
4 | This program is free software; |
5 | you can redistribute it and/or modify it under the terms of the |
6 | GNU General Public License as published by the Free Software Foundation; |
7 | either version 3 of the License, or any later version. |
8 | |
9 | This program is distributed in the hope that it will be useful, |
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 | GNU General Public License for more details. |
13 | |
14 | You should have received a copy of the GNU General Public License |
15 | along with this program; if not, write to the Free Software |
16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
17 | */ |
18 | /* |
19 | Changes: |
20 | - v4.0.0: |
21 | - created from v3.6.0 |
22 | Doc reviewed 202208 |
23 | */ |
24 | |
25 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
26 | /** |
27 | A simple container to store a latitude and longitude |
28 | */ |
29 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
30 | |
31 | class LatLng { |
32 | |
33 | /** |
34 | The lat |
35 | @type {Number} |
36 | */ |
37 | |
38 | #lat; |
39 | |
40 | /** |
41 | The lng |
42 | @type {Number} |
43 | */ |
44 | |
45 | #lng; |
46 | |
47 | /** |
48 | The constructor |
49 | @param {Number} lat The lat |
50 | @param {Number} lng The lng |
51 | */ |
52 | |
53 | constructor ( lat, lng ) { |
54 | Object.freeze ( this ); |
55 | this.#lat = lat; |
56 | this.#lng = lng; |
57 | } |
58 | |
59 | /** |
60 | Create a new LatLng object from another object that have a lat and lng property ( the given object |
61 | can be any other class... ) |
62 | @param {Object} something An object with a lat and a lng property |
63 | */ |
64 | |
65 | static clone ( something ) { |
66 | return new LatLng ( something.lat, something.lng ); |
67 | } |
68 | |
69 | /** |
70 | The lat and lng |
71 | @type {Array.<Number>} |
72 | */ |
73 | |
74 | get latLng ( ) { return [ this.#lat, this.#lng ]; } |
75 | |
76 | /** |
77 | The lat |
78 | @type {Number} |
79 | */ |
80 | |
81 | get lat ( ) { return this.#lat; } |
82 | |
83 | /** |
84 | The lng |
85 | @type {Number} |
86 | */ |
87 | |
88 | get lng ( ) { return this.#lng; } |
89 | } |
90 | |
91 | export default LatLng; |
92 | |
93 | /* --- End of file --------------------------------------------------------------------------------------------------------- */ |
94 |