@tomtom-org/maps-sdk-plugin-landmarks-3d 0.0.9 → 0.0.11

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 +9 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Landmarks 3D Plugin
2
2
 
3
- Plugin for the [TomTom Maps SDK for Javascript](https://docs.tomtom.com/maps-sdk-js/introduction/overview) that renders TomTom Orbis 3D Landmarks — high-detail building meshes streamed as tiles — on a `TomTomMap` using Three.js.
3
+ Plugin for the [TomTom Maps SDK for JavaScript](https://docs.tomtom.com/maps-sdk-js/introduction/overview) that renders TomTom Orbis 3D Landmarks — high-detail building meshes streamed as tiles — on a `TomTomMap` using Three.js.
4
4
 
5
5
  > **Private Preview**: the [Orbis 3D Landmarks API](https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/3d/landmarks) is in Private Preview. Your API key needs Orbis 3D Landmarks entitlements.
6
6
 
@@ -25,7 +25,7 @@ Note: this plugin declares `@tomtom-org/maps-sdk`, `maplibre-gl` and `three` as
25
25
  npm install @tomtom-org/maps-sdk maplibre-gl three @tomtom-org/maps-sdk-plugin-landmarks-3d
26
26
  ```
27
27
 
28
- 1. Follow the SDK [Project setup](https://docs.tomtom.com/maps-sdk-js/guides/introduction/project-setup) or the Map [quickstart](https://docs.tomtom.com/maps-sdk-js/guides/map/quickstart) to create and initialize a `TomTomMap`. Use a pitched camera for the best result; the plugin enables the standard style's 3D building layer automatically.
28
+ 1. Follow the SDK [Project setup](https://docs.tomtom.com/maps-sdk-js/introduction/project-setup) or the Map [quickstart](https://docs.tomtom.com/maps-sdk-js/guides/map/quickstart) to create and initialize a `TomTomMap`. Use a pitched camera for the best result; the plugin enables the standard style's 3D building layer automatically.
29
29
 
30
30
  2. Import and use the plugin (plugin-specific steps only):
31
31
 
@@ -35,10 +35,15 @@ import { Landmarks3D } from '@tomtom-org/maps-sdk-plugin-landmarks-3d';
35
35
  // assume `map` is your initialized TomTomMap instance
36
36
  const landmarks = new Landmarks3D(map);
37
37
 
38
- // optional: change how landmarks blend with the base map
39
- await landmarks.setDisplayMode('inherited');
38
+ // optional: give the landmarks the dark style's building look instead of the base map's
39
+ await landmarks.setDisplayMode('dark');
40
+
41
+ // optional: hide them, and bring them back with setVisible(true)
42
+ await landmarks.setVisible(false);
40
43
  ```
41
44
 
45
+ `new Landmarks3D(map, { displayMode, visible, minZoom, maxZoom })` sets the same options up front; the zoom range defaults to that of the base map's 3D building layer.
46
+
42
47
  ## License
43
48
 
44
49
  See `LICENSE.txt`.
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@tomtom-org/maps-sdk-plugin-landmarks-3d",
3
3
  "author": "TomTom International B.V.",
4
4
  "license": "See in LICENSE.txt",
5
- "version": "0.0.9",
5
+ "version": "0.0.11",
6
6
  "type": "module",
7
7
  "description": "Plugin to render TomTom Orbis 3D Landmarks (GLB tiles) on a TomTomMap with Three.js",
8
8
  "types": "dist/index.d.ts",
@@ -20,7 +20,7 @@
20
20
  "typescript": "^6.0.3",
21
21
  "vite": "^8.3.2",
22
22
  "vitest": "^4.1.11",
23
- "@tomtom-org/maps-sdk": "1.0.0-rc.0"
23
+ "@tomtom-org/maps-sdk": "1.0.0-rc.1"
24
24
  },
25
25
  "files": [
26
26
  "dist",