@tomtom-org/maps-sdk-plugin-flyover 0.0.4 → 0.0.5

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.
Files changed (2) hide show
  1. package/README.md +14 -7
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,11 +1,20 @@
1
- # @tomtom-org/maps-sdk-plugin-flyover
1
+ # Flyover Plugin
2
2
 
3
- A camera that flies a route on a [TomTom Maps SDK for JavaScript](https://docs.tomtom.com/maps-sdk-js/)
3
+ A camera that flies a route on a [TomTom Maps SDK for JavaScript](https://docs.tomtom.com/maps-sdk-js/introduction/overview)
4
4
  map: it follows the line, aims at the junctions ahead, frames them, keeps clear of the terrain it
5
5
  crosses, and parks the followed position — marked with an arrow — where you want it on screen.
6
6
 
7
+ ## Docs & examples
8
+
9
+ - Developer guide: https://docs.tomtom.com/maps-sdk-js/guides/plugins/flyover
10
+ - Example: https://docs.tomtom.com/maps-sdk-js/examples/route-flyover-playground
11
+
12
+ ## Quickstart
13
+
14
+ Note: this plugin declares `@tomtom-org/maps-sdk` and `maplibre-gl` as peer dependencies and bundles neither — ensure both are installed in your project.
15
+
7
16
  ```bash
8
- npm install @tomtom-org/maps-sdk @tomtom-org/maps-sdk-plugin-flyover
17
+ npm install @tomtom-org/maps-sdk maplibre-gl @tomtom-org/maps-sdk-plugin-flyover
9
18
  ```
10
19
 
11
20
  ```javascript
@@ -23,6 +32,8 @@ const flyover = new RouteFlyover(map, {
23
32
  flyover.start();
24
33
  ```
25
34
 
35
+ ## Features
36
+
26
37
  The route is the only geometry it needs — no camera keyframes to author, and no animation to
27
38
  re-time when the route changes. The flight loops: it wraps at the destination and never lands.
28
39
 
@@ -37,10 +48,6 @@ re-time when the route changes. The flight loops: it wraps at the destination an
37
48
  - **Smooth by default** — every value the camera changes moves on a critically damped spring, the
38
49
  same at any frame rate.
39
50
 
40
- Full documentation: **[Fly-over plugin guide](https://docs.tomtom.com/maps-sdk-js/guides/plugins/flyover)**.
41
-
42
- `@tomtom-org/maps-sdk` and `maplibre-gl` are peer dependencies; this package bundles neither.
43
-
44
51
  ## License
45
52
 
46
53
  See [LICENSE.txt](./LICENSE.txt).
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@tomtom-org/maps-sdk-plugin-flyover",
3
3
  "author": "TomTom International B.V.",
4
4
  "license": "See in LICENSE.txt",
5
- "version": "0.0.4",
5
+ "version": "0.0.5",
6
6
  "type": "module",
7
7
  "description": "A camera that flies a route on a TomTomMap: it follows the line, aims at the junctions ahead, frames them, clears the terrain it crosses, and parks the followed position where you want it on screen",
8
8
  "types": "dist/index.d.ts",
@@ -23,7 +23,7 @@
23
23
  "typescript": "^6.0.3",
24
24
  "vite": "^8.3.2",
25
25
  "vitest": "^4.1.11",
26
- "@tomtom-org/maps-sdk": "1.0.0-rc.0"
26
+ "@tomtom-org/maps-sdk": "1.0.0-rc.1"
27
27
  },
28
28
  "files": [
29
29
  "dist",