@spacexr/geodesy 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/LICENSE +201 -0
- package/README.md +199 -0
- package/dist/chunk-RJFTT4KI.js +227 -0
- package/dist/chunk-RJFTT4KI.js.map +1 -0
- package/dist/chunk-WYCQOUE7.js +488 -0
- package/dist/chunk-WYCQOUE7.js.map +1 -0
- package/dist/ellipsoid.d.ts +150 -0
- package/dist/ellipsoid.js +3 -0
- package/dist/ellipsoid.js.map +1 -0
- package/dist/geodetic-system-DRpWY8qG.d.ts +257 -0
- package/dist/index.d.ts +39 -0
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -0
- package/dist/system.d.ts +2 -0
- package/dist/system.js +4 -0
- package/dist/system.js.map +1 -0
- package/package.json +89 -0
- package/src/angles.ts +48 -0
- package/src/ellipsoid.ts +261 -0
- package/src/geodetic-system.ts +548 -0
- package/src/index.ts +4 -0
- package/src/types.ts +46 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on Keep a Changelog and this project follows Semantic Versioning.
|
|
6
|
+
|
|
7
|
+
## [Unreleased]
|
|
8
|
+
|
|
9
|
+
## [0.1.0] - 2026-10-05
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
|
|
13
|
+
- Initial `@spacexr/geodesy` package.
|
|
14
|
+
- Immutable reference ellipsoids, including WGS84, GRS80, GRS67, ANS, WGS72 and Clarke presets.
|
|
15
|
+
- Geodetic, ECEF, ENU and NED coordinate conversions.
|
|
16
|
+
- Canonical `ILocalTangentBasis` with symmetric ENU and NED transformation matrices.
|
|
17
|
+
- JSDoc-compatible TSDoc API documentation and TypeDoc generation.
|
|
18
|
+
- Continuous integration and npm trusted publishing release workflow with provenance.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/pandaGaume/geodesy_ts/main/assets/brand/geodesy-logo.png" alt="SpaceXR Geodesy" width="900">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
# @spacexr/geodesy
|
|
6
|
+
|
|
7
|
+
Renderer-neutral TypeScript primitives for ellipsoids, geodetic coordinates, Earth-centred Earth-fixed coordinates and local tangent frames.
|
|
8
|
+
|
|
9
|
+
The package is extracted from the geodesy work originally developed in SpaceXR Core. It removes dependencies on Babylon.js, SpaceXR geometry classes, observables, tile metrics and application state. The result is a small reusable numerical foundation for 3D Tiles, terrain, mining models, globe navigation and planetary visualization.
|
|
10
|
+
|
|
11
|
+
## Design goals
|
|
12
|
+
|
|
13
|
+
- one immutable `Ellipsoid` as the source of every planetary dimension;
|
|
14
|
+
- one immutable `GeodeticSystem` for geodetic and ECEF conversions;
|
|
15
|
+
- explicit degree and radian APIs, without ambiguous boolean unit arguments;
|
|
16
|
+
- standard ECEF, ENU and NED axis conventions;
|
|
17
|
+
- optional output targets for allocation-free hot paths;
|
|
18
|
+
- no renderer, DOM, 3D Tiles or application dependency;
|
|
19
|
+
- JSDoc-compatible TSDoc on every public API;
|
|
20
|
+
- generated TypeDoc documentation;
|
|
21
|
+
- support for Earth and arbitrary oblate planetary bodies.
|
|
22
|
+
|
|
23
|
+
## Installation
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm install @spacexr/geodesy
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The package is ESM and requires Node.js 20.11 or later when used directly in Node.js. Its runtime code has no external dependency.
|
|
30
|
+
|
|
31
|
+
## Coordinate conventions
|
|
32
|
+
|
|
33
|
+
| System | X | Y | Z | Angular unit |
|
|
34
|
+
| -------- | ----------------------- | ------------------------------------- | ------------------ | --------------------------- |
|
|
35
|
+
| ECEF | latitude 0, longitude 0 | latitude 0, longitude 90 degrees east | north pole | none |
|
|
36
|
+
| ENU | east | north | up | none |
|
|
37
|
+
| NED | north | east | down | none |
|
|
38
|
+
| Geodetic | longitude | latitude | ellipsoidal height | explicit degrees or radians |
|
|
39
|
+
|
|
40
|
+
Cartesian values and ellipsoidal heights are expressed in metres. `GeodeticSystem` follows the EPSG:4978 ECEF orientation. Geographic values correspond to ellipsoidal longitude, geodetic latitude and ellipsoidal height as used by EPSG:4979, with an explicit API method defining whether angles are degrees or radians.
|
|
41
|
+
|
|
42
|
+
Matrices are column-major and multiply column vectors. This matches glTF and 3D Tiles transform storage.
|
|
43
|
+
|
|
44
|
+
## Ellipsoids
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
import { Ellipsoid } from "@spacexr/geodesy";
|
|
48
|
+
|
|
49
|
+
const earth = Ellipsoid.WGS84;
|
|
50
|
+
|
|
51
|
+
console.log(earth.semiMajorAxis); // 6378137 metres
|
|
52
|
+
console.log(earth.semiMinorAxis); // 6356752.314245179 metres
|
|
53
|
+
console.log(earth.inverseFlattening); // 298.257223563
|
|
54
|
+
|
|
55
|
+
const mars = Ellipsoid.fromAxes("Mars", 3396190, 3376200);
|
|
56
|
+
const moon = Ellipsoid.sphere("Moon", 1737400);
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Included reference ellipsoids are WGS84, GRS80, GRS67, ANS, WGS72, Clarke 1858 and Clarke 1880. Applications can create additional oblate ellipsoids from axes, flattening or inverse flattening.
|
|
60
|
+
|
|
61
|
+
## Geodetic to ECEF
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
import { GeodeticSystem } from "@spacexr/geodesy";
|
|
65
|
+
|
|
66
|
+
const system = GeodeticSystem.WGS84;
|
|
67
|
+
|
|
68
|
+
const ecef = system.geodeticDegreesToEcef(
|
|
69
|
+
48.8566, // latitude
|
|
70
|
+
2.3522, // longitude
|
|
71
|
+
35, // ellipsoidal height
|
|
72
|
+
);
|
|
73
|
+
|
|
74
|
+
const geodetic = system.ecefToGeodeticDegrees(ecef);
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Equivalent `geodeticRadiansToEcef` and `ecefToGeodeticRadians` methods are provided for formats such as 3D Tiles regions, whose longitudes and latitudes are serialized in radians.
|
|
78
|
+
|
|
79
|
+
Every conversion accepts an optional mutable target:
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
const target = { x: 0, y: 0, z: 0 };
|
|
83
|
+
|
|
84
|
+
system.geodeticRadiansToEcef(latitude, longitude, height, target);
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
This avoids temporary allocations during traversal, camera updates and terrain generation.
|
|
88
|
+
|
|
89
|
+
## Local ENU and NED frames
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
const localFrame = system.createLocalTangentPlaneDegrees(48.8566, 2.3522, 35);
|
|
93
|
+
|
|
94
|
+
const localEnu = localFrame.ecefToEnu(ecefPoint);
|
|
95
|
+
const worldEcef = localFrame.enuToEcef(localEnu);
|
|
96
|
+
|
|
97
|
+
const localNed = localFrame.ecefToNed(ecefPoint);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
The local frame is immutable. Its `basis` is the canonical east, north, up tangent basis expressed as ECEF unit vectors. ENU and NED are two coordinate conventions derived from that single basis, so they cannot drift apart.
|
|
101
|
+
|
|
102
|
+
It exposes defensive copies of its basis and transform matrices:
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
const basis = localFrame.basis;
|
|
106
|
+
const ecefToEnu = localFrame.ecefToEnuMatrix;
|
|
107
|
+
const enuToEcef = localFrame.enuToEcefMatrix;
|
|
108
|
+
const ecefToNed = localFrame.ecefToNedMatrix;
|
|
109
|
+
const nedToEcef = localFrame.nedToEcefMatrix;
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
The conventions are:
|
|
113
|
+
|
|
114
|
+
```text
|
|
115
|
+
ENU = [east, north, up]
|
|
116
|
+
NED = [north, east, -up]
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
NED is the local navigation convention commonly used in aviation and inertial navigation. An aircraft body frame such as FRD, forward, right, down, is a separate orientation layer derived from NED through heading, pitch and roll. It is deliberately not embedded in the geodetic tangent basis.
|
|
120
|
+
|
|
121
|
+
This model replaces the mutable ENU state and event dependency that existed in the original SpaceXR implementation. Applications can create a new local frame when their floating origin changes without mutating the planetary reference system.
|
|
122
|
+
|
|
123
|
+
## Migration from SpaceXR Core
|
|
124
|
+
|
|
125
|
+
The package preserves the useful concepts while making units and state explicit:
|
|
126
|
+
|
|
127
|
+
| SpaceXR Core API | `@spacexr/geodesy` API |
|
|
128
|
+
| ----------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
129
|
+
| `Ellipsoid.FromAAndInverseF(...)` | `Ellipsoid.fromSemiMajorAxisAndInverseFlattening(...)` |
|
|
130
|
+
| `Ellipsoid.FromAAndF(...)` | `Ellipsoid.fromSemiMajorAxisAndFlattening(...)` |
|
|
131
|
+
| `GeodeticSystem.Default` | `GeodeticSystem.WGS84` |
|
|
132
|
+
| `geodeticFloatToCartesianToRef(..., deg)` | `geodeticDegreesToEcef(...)` or `geodeticRadiansToEcef(...)` |
|
|
133
|
+
| `cartesianToGeodetic(...)` | `ecefToGeodeticDegrees(...)` or `ecefToGeodeticRadians(...)` |
|
|
134
|
+
| mutable `ENUReference`, transform and observable | immutable `LocalTangentPlane` returned by `createLocalTangentPlane...` |
|
|
135
|
+
| public underscore-prefixed ellipsoid calculation data | documented immutable properties and curvature methods |
|
|
136
|
+
|
|
137
|
+
The old `MapScale` utility is not part of this numerical kernel because it depends on tile metrics, display resolution and level-of-detail policy. Those concerns belong to the tiling or presentation layer. The legacy flat-Earth and spherical route calculators are also outside version 0.1. Their distance approximations can be introduced later as an independent geodesic module with explicit angular units and dedicated accuracy tests.
|
|
138
|
+
|
|
139
|
+
## 3D Tiles integration
|
|
140
|
+
|
|
141
|
+
`@spacexr/3d-tiles-runtime` consumes this package through its ECEF spatial adapter:
|
|
142
|
+
|
|
143
|
+
```ts
|
|
144
|
+
import { Ellipsoid, GeodeticSystem } from "@spacexr/geodesy";
|
|
145
|
+
import { EcefSpatialMetric } from "@spacexr/3d-tiles-runtime";
|
|
146
|
+
|
|
147
|
+
const mars = Ellipsoid.fromAxes("Mars", 3396190, 3376200);
|
|
148
|
+
const metric = new EcefSpatialMetric({
|
|
149
|
+
geodeticSystem: new GeodeticSystem(mars),
|
|
150
|
+
});
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
The geodesy package owns ellipsoid and coordinate mathematics. The 3D Tiles runtime remains responsible for tile transforms, bounding volumes, visibility, horizon culling and screen-space error.
|
|
154
|
+
|
|
155
|
+
## API documentation
|
|
156
|
+
|
|
157
|
+
Every exported class, interface, constant and method carries JSDoc-compatible TSDoc, including parameter units, return units, coordinate axes and numerical edge cases.
|
|
158
|
+
|
|
159
|
+
Generate the browsable API site with:
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
npm run docs
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
The generated site is written to `docs/api/`.
|
|
166
|
+
|
|
167
|
+
## Development
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
npm install
|
|
171
|
+
npm run check
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
`npm run check` verifies formatting, lint rules, TypeScript types, numerical tests, the production package and the generated API documentation.
|
|
175
|
+
|
|
176
|
+
The package can also be inspected before publishing:
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
npm pack --dry-run
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## Release
|
|
183
|
+
|
|
184
|
+
Publication is performed by the GitHub Actions `release` workflow with npm trusted publishing and provenance. See [RELEASING.md](https://github.com/pandaGaume/geodesy_ts/blob/main/RELEASING.md).
|
|
185
|
+
|
|
186
|
+
## Brand assets
|
|
187
|
+
|
|
188
|
+
The pixel-art globe represents an oblate reference ellipsoid, its geodetic grid and a local tangent frame.
|
|
189
|
+
|
|
190
|
+
<p align="center">
|
|
191
|
+
<img src="https://raw.githubusercontent.com/pandaGaume/geodesy_ts/main/assets/brand/geodesy-icon.png" alt="SpaceXR Geodesy icon" width="220">
|
|
192
|
+
</p>
|
|
193
|
+
|
|
194
|
+
- [Horizontal logo](https://github.com/pandaGaume/geodesy_ts/blob/main/assets/brand/geodesy-logo.png)
|
|
195
|
+
- [Square icon](https://github.com/pandaGaume/geodesy_ts/blob/main/assets/brand/geodesy-icon.png)
|
|
196
|
+
|
|
197
|
+
## License
|
|
198
|
+
|
|
199
|
+
Apache-2.0. See [LICENSE](LICENSE).
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
// src/ellipsoid.ts
|
|
2
|
+
var Ellipsoid = class _Ellipsoid {
|
|
3
|
+
constructor(identifier, major, minor) {
|
|
4
|
+
this.identifier = identifier;
|
|
5
|
+
this.major = major;
|
|
6
|
+
this.minor = minor;
|
|
7
|
+
if (identifier.trim().length === 0) throw new RangeError("Ellipsoid name must not be empty.");
|
|
8
|
+
if (!Number.isFinite(major) || major <= 0) throw new RangeError("Semi-major axis must be a positive finite number.");
|
|
9
|
+
if (!Number.isFinite(minor) || minor <= 0) throw new RangeError("Semi-minor axis must be a positive finite number.");
|
|
10
|
+
if (minor > major)
|
|
11
|
+
throw new RangeError("An oblate ellipsoid requires the semi-minor axis to be no greater than the semi-major axis.");
|
|
12
|
+
}
|
|
13
|
+
identifier;
|
|
14
|
+
major;
|
|
15
|
+
minor;
|
|
16
|
+
/** WGS 84 reference ellipsoid used by EPSG:4978 and EPSG:4979. */
|
|
17
|
+
static WGS84 = _Ellipsoid.fromSemiMajorAxisAndInverseFlattening("WGS84", 6378137, 298.257223563);
|
|
18
|
+
/** Geodetic Reference System 1980 ellipsoid. */
|
|
19
|
+
static GRS80 = _Ellipsoid.fromSemiMajorAxisAndInverseFlattening("GRS80", 6378137, 298.257222101);
|
|
20
|
+
/** Geodetic Reference System 1967 ellipsoid. */
|
|
21
|
+
static GRS67 = _Ellipsoid.fromSemiMajorAxisAndInverseFlattening("GRS67", 6378160, 298.25);
|
|
22
|
+
/** Australian National Spheroid. */
|
|
23
|
+
static ANS = _Ellipsoid.fromSemiMajorAxisAndInverseFlattening("ANS", 6378160, 298.25);
|
|
24
|
+
/** World Geodetic System 1972 ellipsoid. */
|
|
25
|
+
static WGS72 = _Ellipsoid.fromSemiMajorAxisAndInverseFlattening("WGS72", 6378135, 298.26);
|
|
26
|
+
/** Clarke 1858 ellipsoid. */
|
|
27
|
+
static Clarke1858 = _Ellipsoid.fromSemiMajorAxisAndInverseFlattening("Clarke1858", 6378293645e-3, 294.26);
|
|
28
|
+
/** Clarke 1880 ellipsoid. */
|
|
29
|
+
static Clarke1880 = _Ellipsoid.fromSemiMajorAxisAndInverseFlattening("Clarke1880", 6378249145e-3, 293.465);
|
|
30
|
+
/**
|
|
31
|
+
* Creates an ellipsoid from its semi-major axis and inverse flattening.
|
|
32
|
+
*
|
|
33
|
+
* `Infinity` represents a sphere.
|
|
34
|
+
*
|
|
35
|
+
* @param name - Stable human-readable ellipsoid name.
|
|
36
|
+
* @param semiMajorAxis - Equatorial semi-major axis in metres.
|
|
37
|
+
* @param inverseFlattening - Reciprocal flattening, or `Infinity` for a sphere.
|
|
38
|
+
* @returns A validated immutable ellipsoid.
|
|
39
|
+
*/
|
|
40
|
+
static fromSemiMajorAxisAndInverseFlattening(name, semiMajorAxis, inverseFlattening) {
|
|
41
|
+
if (inverseFlattening !== Number.POSITIVE_INFINITY && (!Number.isFinite(inverseFlattening) || inverseFlattening <= 1)) {
|
|
42
|
+
throw new RangeError("Inverse flattening must be greater than one, or Infinity for a sphere.");
|
|
43
|
+
}
|
|
44
|
+
const flattening = inverseFlattening === Number.POSITIVE_INFINITY ? 0 : 1 / inverseFlattening;
|
|
45
|
+
return new _Ellipsoid(name, semiMajorAxis, semiMajorAxis * (1 - flattening));
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Creates an ellipsoid from its semi-major axis and flattening.
|
|
49
|
+
*
|
|
50
|
+
* @param name - Stable human-readable ellipsoid name.
|
|
51
|
+
* @param semiMajorAxis - Equatorial semi-major axis in metres.
|
|
52
|
+
* @param flattening - Flattening in the interval `[0, 1)`.
|
|
53
|
+
* @returns A validated immutable ellipsoid.
|
|
54
|
+
*/
|
|
55
|
+
static fromSemiMajorAxisAndFlattening(name, semiMajorAxis, flattening) {
|
|
56
|
+
if (!Number.isFinite(flattening) || flattening < 0 || flattening >= 1) {
|
|
57
|
+
throw new RangeError("Flattening must be a finite number in the interval [0, 1).");
|
|
58
|
+
}
|
|
59
|
+
return new _Ellipsoid(name, semiMajorAxis, semiMajorAxis * (1 - flattening));
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Creates an ellipsoid from its semi-major and semi-minor axes.
|
|
63
|
+
*
|
|
64
|
+
* @param name - Stable human-readable ellipsoid name.
|
|
65
|
+
* @param semiMajorAxis - Equatorial semi-major axis in metres.
|
|
66
|
+
* @param semiMinorAxis - Polar semi-minor axis in metres.
|
|
67
|
+
* @returns A validated immutable ellipsoid.
|
|
68
|
+
*/
|
|
69
|
+
static fromAxes(name, semiMajorAxis, semiMinorAxis) {
|
|
70
|
+
return new _Ellipsoid(name, semiMajorAxis, semiMinorAxis);
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Creates a spherical reference surface.
|
|
74
|
+
*
|
|
75
|
+
* @param name - Stable human-readable sphere name.
|
|
76
|
+
* @param radius - Radius in metres.
|
|
77
|
+
* @returns An ellipsoid with zero flattening.
|
|
78
|
+
*/
|
|
79
|
+
static sphere(name, radius) {
|
|
80
|
+
return new _Ellipsoid(name, radius, radius);
|
|
81
|
+
}
|
|
82
|
+
/** Stable human-readable identifier. */
|
|
83
|
+
get name() {
|
|
84
|
+
return this.identifier;
|
|
85
|
+
}
|
|
86
|
+
/** Equatorial semi-major axis in metres. */
|
|
87
|
+
get semiMajorAxis() {
|
|
88
|
+
return this.major;
|
|
89
|
+
}
|
|
90
|
+
/** Polar semi-minor axis in metres. */
|
|
91
|
+
get semiMinorAxis() {
|
|
92
|
+
return this.minor;
|
|
93
|
+
}
|
|
94
|
+
/** Largest ellipsoid radius in metres. */
|
|
95
|
+
get maximumRadius() {
|
|
96
|
+
return this.major;
|
|
97
|
+
}
|
|
98
|
+
/** Smallest ellipsoid radius in metres. */
|
|
99
|
+
get minimumRadius() {
|
|
100
|
+
return this.minor;
|
|
101
|
+
}
|
|
102
|
+
/** Ellipsoid flattening `(a - b) / a`. */
|
|
103
|
+
get flattening() {
|
|
104
|
+
return (this.major - this.minor) / this.major;
|
|
105
|
+
}
|
|
106
|
+
/** Reciprocal flattening, or `Infinity` for a sphere. */
|
|
107
|
+
get inverseFlattening() {
|
|
108
|
+
const flattening = this.flattening;
|
|
109
|
+
return flattening === 0 ? Number.POSITIVE_INFINITY : 1 / flattening;
|
|
110
|
+
}
|
|
111
|
+
/** First eccentricity squared `e^2`. */
|
|
112
|
+
get squaredEccentricity() {
|
|
113
|
+
return 1 - this.minor * this.minor / (this.major * this.major);
|
|
114
|
+
}
|
|
115
|
+
/** Compatibility alias for {@link squaredEccentricity}. */
|
|
116
|
+
get sqrEccentricity() {
|
|
117
|
+
return this.squaredEccentricity;
|
|
118
|
+
}
|
|
119
|
+
/** First eccentricity `e`. */
|
|
120
|
+
get eccentricity() {
|
|
121
|
+
return Math.sqrt(this.squaredEccentricity);
|
|
122
|
+
}
|
|
123
|
+
/** Second eccentricity squared `e'^2`. */
|
|
124
|
+
get secondSquaredEccentricity() {
|
|
125
|
+
return (this.major * this.major - this.minor * this.minor) / (this.minor * this.minor);
|
|
126
|
+
}
|
|
127
|
+
/** Linear eccentricity in metres. */
|
|
128
|
+
get linearEccentricity() {
|
|
129
|
+
return Math.sqrt(this.major * this.major - this.minor * this.minor);
|
|
130
|
+
}
|
|
131
|
+
/** Precomputed coefficient `1 - e^2`. */
|
|
132
|
+
get oneMinusSquaredEccentricity() {
|
|
133
|
+
return 1 - this.squaredEccentricity;
|
|
134
|
+
}
|
|
135
|
+
/** Compatibility alias for {@link oneMinusSquaredEccentricity}. */
|
|
136
|
+
get oneMinusSqrEccentricity() {
|
|
137
|
+
return this.oneMinusSquaredEccentricity;
|
|
138
|
+
}
|
|
139
|
+
/** Semi-latus rectum in metres. */
|
|
140
|
+
get semiLatusRectum() {
|
|
141
|
+
return this.major * this.oneMinusSquaredEccentricity;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Returns the prime-vertical radius of curvature at a geodetic latitude.
|
|
145
|
+
*
|
|
146
|
+
* @param latitudeRadians - Geodetic latitude in radians.
|
|
147
|
+
* @returns Prime-vertical radius in metres.
|
|
148
|
+
*/
|
|
149
|
+
primeVerticalRadius(latitudeRadians) {
|
|
150
|
+
const sine = Math.sin(latitudeRadians);
|
|
151
|
+
return this.major / Math.sqrt(1 - this.squaredEccentricity * sine * sine);
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* Returns the meridional radius of curvature at a geodetic latitude.
|
|
155
|
+
*
|
|
156
|
+
* @param latitudeRadians - Geodetic latitude in radians.
|
|
157
|
+
* @returns Meridional radius in metres.
|
|
158
|
+
*/
|
|
159
|
+
meridionalRadius(latitudeRadians) {
|
|
160
|
+
const sine = Math.sin(latitudeRadians);
|
|
161
|
+
const denominator = 1 - this.squaredEccentricity * sine * sine;
|
|
162
|
+
return this.major * this.oneMinusSquaredEccentricity / Math.pow(denominator, 1.5);
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Returns the geocentric surface radius at a latitude.
|
|
166
|
+
*
|
|
167
|
+
* @param latitudeRadians - Geocentric latitude in radians.
|
|
168
|
+
* @returns Distance from the ellipsoid centre to its surface in metres.
|
|
169
|
+
*/
|
|
170
|
+
radiusAtLatitude(latitudeRadians) {
|
|
171
|
+
const cosine = Math.cos(latitudeRadians);
|
|
172
|
+
const sine = Math.sin(latitudeRadians);
|
|
173
|
+
const majorSquared = this.major * this.major;
|
|
174
|
+
const minorSquared = this.minor * this.minor;
|
|
175
|
+
return Math.sqrt(
|
|
176
|
+
((majorSquared * cosine) ** 2 + (minorSquared * sine) ** 2) / ((this.major * cosine) ** 2 + (this.minor * sine) ** 2)
|
|
177
|
+
);
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Intersects a normalized geocentric direction with the ellipsoid surface.
|
|
181
|
+
*
|
|
182
|
+
* @param x - ECEF X component of a normalized direction.
|
|
183
|
+
* @param y - ECEF Y component of a normalized direction.
|
|
184
|
+
* @param z - ECEF Z component of a normalized direction.
|
|
185
|
+
* @returns Distance from the centre to the surface in metres.
|
|
186
|
+
*/
|
|
187
|
+
radiusAtPosition(x, y, z) {
|
|
188
|
+
const norm = Math.hypot(x, y, z);
|
|
189
|
+
if (Math.abs(norm - 1) > 1e-12) throw new RangeError("Direction passed to radiusAtPosition must be normalized.");
|
|
190
|
+
const denominator = (x * x + y * y) / (this.major * this.major) + z * z / (this.minor * this.minor);
|
|
191
|
+
return 1 / Math.sqrt(denominator);
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* Tests geometric equality independently from the ellipsoid name.
|
|
195
|
+
*
|
|
196
|
+
* @param other - Ellipsoid to compare.
|
|
197
|
+
* @returns `true` when both axes are exactly equal.
|
|
198
|
+
*/
|
|
199
|
+
equals(other) {
|
|
200
|
+
return other.major === this.major && other.minor === this.minor;
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Creates a uniformly scaled ellipsoid.
|
|
204
|
+
*
|
|
205
|
+
* @param scale - Positive uniform scale applied to both axes.
|
|
206
|
+
* @param name - Name assigned to the scaled instance.
|
|
207
|
+
* @returns A new ellipsoid with unchanged flattening.
|
|
208
|
+
*/
|
|
209
|
+
scaled(scale, name = `${this.name} x ${scale}`) {
|
|
210
|
+
if (!Number.isFinite(scale) || scale <= 0) throw new RangeError("Ellipsoid scale must be a positive finite number.");
|
|
211
|
+
return new _Ellipsoid(name, this.major * scale, this.minor * scale);
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* Compatibility alias for {@link scaled}.
|
|
215
|
+
*
|
|
216
|
+
* @param name - Name assigned to the cloned instance.
|
|
217
|
+
* @param scale - Positive uniform scale applied to both axes.
|
|
218
|
+
* @returns A new ellipsoid.
|
|
219
|
+
*/
|
|
220
|
+
clone(name, scale = 1) {
|
|
221
|
+
return this.scaled(scale, name);
|
|
222
|
+
}
|
|
223
|
+
};
|
|
224
|
+
|
|
225
|
+
export { Ellipsoid };
|
|
226
|
+
//# sourceMappingURL=chunk-RJFTT4KI.js.map
|
|
227
|
+
//# sourceMappingURL=chunk-RJFTT4KI.js.map
|