@tomtom-org/maps-sdk-plugin-landmarks-3d 0.0.12 → 0.1.0

package/LICENSE.txt

@@ -14,7 +14,7 @@ You may not use the SDK or accept this Agreement if you are barred from receivin
 
 3.1. You agree to use the SDK only for purposes permitted by (a) this Agreement and (b) any applicable law, regulation or generally accepted practice or guideline in the relevant jurisdictions (including any laws regarding the export of data or software to and from the United States or other relevant countries).
 
-3.2. Other than as permitted by applicable legislation, you are prohibited from copying (except for backup purposes), modifying, adapting, (re)distributing, renting, lending, publicly presenting, decompiling, reverse engineering, disassembling or creating derivative works of the SDK or any part of it. Notwithstanding the foregoing, you may inspect the SDK as distributed to you, including any source code embedded in its source maps, solely for the purpose of debugging your Permitted Application, provided that it is not shared or redistributed. The readability of the SDK’s source code in its distribution does not constitute “Open-Source” licensing and grants you no rights under any Open Source Initiative (OSI) approved license, nor shall it be construed as a grant of rights to modify, fork or redistribute the SDK beyond those expressly granted in Clause 1 and this Clause 3.2.
+3.2. Except as permitted by applicable law or this Clause 3.2, you may not copy (except for backup purposes), modify, adapt, distribute, rent, lend, publicly present, decompile, reverse engineer, disassemble or create derivative works of the SDK. Solely for your Permitted Applications and subject to Clauses 3.3 to 3.5, you may: (a) inspect the SDK, including source code in its source maps, for debugging; (b) copy the SDK as reasonably necessary to develop, build, test and deploy them, including in internal repositories, mirrors and offline build environments used only by you, your Affiliates and your contractors; (c) modify the SDK to fix errors or security vulnerabilities, to maintain compatibility, or to prepare a Contribution under Clause 11.5, but you may not alter, circumvent or disable any functionality for authentication, metering, billing, the notices in Clause 5.2 or the data collection in Clause 4; and (d) distribute the SDK only as a bundled part of a Permitted Application, and not on a standalone basis or as a library. Modified versions remain part of the SDK, and TomTom need not support them. On termination, you must delete all copies held under (b), except copies already distributed under (d). The readability of the SDK's source code does not make it open source and grants no rights beyond those in Clause 1 and this Clause 3.2.
 
 3.3. You may not use the SDK in connection with any illegal, fraudulent, dishonest or unethical activity or behaviour, and in particular not to create or develop, or help others create or develop, a product, service or library that competes, directly or indirectly, with the SDK or the TomTom APIs.
 
@@ -22,7 +22,7 @@ You may not use the SDK or accept this Agreement if you are barred from receivin
 
 3.5. The SDK may include data or software that TomTom licenses from third parties, including open-source software. Such components are made available to you under the terms and conditions of their applicable licenses, and you shall comply with all requirements and restrictions that those third parties may require TomTom to impose on you (as may be updated and amended by TomTom from time to time). It is your responsibility to check, review and comply with those terms as they apply to the SDK licensed to you under this Agreement. The applicable third party and open-source notices are set out in the accompanying THIRD_PARTY.txt file. In the event of a conflict between this Agreement and an open-source license governing a specific dependency, that open-source license shall prevail solely with respect to that dependency.
 
-4. PRIVACY: In order to improve the TomTom Developer Portal and the SDK, TomTom may collect certain usage related information from the software, including but not limited to general SDK and product identifiers, version numbers, and information on which tools and/or services in the SDK are used and how you use them. In addition, TomTom may collect your unique identifier and associated IP address for legitimate business reasons (such as, without limitation, the processing of invoices). This data is retained for a maximum period of 120 days and is maintained in accordance with our Privacy Policy.
+4. PRIVACY: In order to improve the TomTom Developer Portal and the SDK, TomTom may collect certain usage related information from the software, including but not limited to general SDK and product identifiers, version numbers, and information on which tools and/or services in the SDK are used and how you use them. In addition, TomTom may collect your unique identifier and associated IP address for legitimate business reasons (such as, without limitation, the processing of invoices). This data is retained for a maximum period of 120 days and is maintained in accordance with our Privacy Policy (https://www.tomtom.com/privacy/).
 
 5. INTELLECTUAL PROPERTY RIGHTS AND COPYRIGHT NOTICES:
 

package/README.md

@@ -1,8 +1,8 @@
 # Landmarks 3D Plugin
 
-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.
+This plugin for the [TomTom Maps SDK for JavaScript](https://docs.tomtom.com/maps-sdk-js/introduction/overview) renders TomTom Orbis 3D Landmarks on a `TomTomMap` with Three.js. The landmarks are high-detail building meshes, streamed as tiles.
 
-> **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.
+> **Private Preview.** The [Orbis 3D Landmarks API](https://developer.tomtom.com/map-display-api/documentation/tomtom-orbis-maps/3d/landmarks) is in Private Preview, so your API key needs Orbis 3D Landmarks entitlements.
 
 ## Docs & examples
 
@@ -12,37 +12,39 @@ Plugin for the [TomTom Maps SDK for JavaScript](https://docs.tomtom.com/maps-sdk
 ## Features
 
 - Streams 3D landmark tiles for the current viewport.
-- Shows the basemap 3D building layer (hidden by default in the standard styles) for full 3D city context.
 - Hides basemap extruded buildings flagged with `has_landmark` so they don't clip through the landmark meshes.
-- Display modes: `inherited` (default, mirrors the basemap building colour/opacity), `dark`, and `light`.
+- Shades the landmarks like the base map's 3D buildings, and follows whatever restyles them, such as the map colours. Set a knob, such as `color` or `opacity`, for a look of your own.
 - Restores itself automatically across map style changes.
 
 ## Quickstart
 
-Note: this plugin declares `@tomtom-org/maps-sdk`, `maplibre-gl` and `three` as peer dependencies — ensure all three are installed in your project.
+This plugin declares `@tomtom-org/maps-sdk`, `maplibre-gl` and `three` as peer dependencies, so install all three in your project too.
 
 ```bash
 npm install @tomtom-org/maps-sdk maplibre-gl three @tomtom-org/maps-sdk-plugin-landmarks-3d
 ```
 
-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.
+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`. For the best result, use a pitched camera.
 
 2. Import and use the plugin (plugin-specific steps only):
 
 ```ts
+import { BaseMapModule } from '@tomtom-org/maps-sdk/map';
 import { Landmarks3D } from '@tomtom-org/maps-sdk-plugin-landmarks-3d';
 
 // assume `map` is your initialized TomTomMap instance
+// the 3D city around the landmarks, hidden in most standard styles
+await BaseMapModule.get(map, { groups: { buildings3D: { visible: true } } });
 const landmarks = new Landmarks3D(map);
 
-// optional: give the landmarks the dark style's building look instead of the base map's
-await landmarks.setDisplayMode('dark');
+// optional: a colour of your own, while the other knobs keep following the base map
+landmarks.updateConfig({ color: '#c8b28a' });
 
 // optional: hide them, and bring them back with setVisible(true)
-await landmarks.setVisible(false);
+landmarks.setVisible(false);
 ```
 
-`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.
+`new Landmarks3D(map, { color, opacity, verticalGradient, visible, minZoom, maxZoom })` sets the same knobs up front. Each one you leave out follows the base map's 3D buildings, zoom range included.
 
 ## License
 

package/THIRD_PARTY.txt

@@ -14,7 +14,7 @@ by the licenses reproduced here.
 --------------------------------------------------------------------------------
 
 Name: maplibre-gl
-Version: 6.12.0
+Version: 6.13.0
 License: BSD-3-Clause
 Bundled: false (peer dependency)
 Description: BSD licensed community fork of mapbox-gl, a WebGL interactive maps library

package/dist/THIRD_PARTY.txt

@@ -4,7 +4,7 @@ your application bundles them. The licenses below apply to those copies, and eac
 these components may in turn install its own dependencies under their own licenses.
 
 Name: maplibre-gl
-Version: 6.12.0
+Version: 6.13.0
 License: BSD-3-Clause
 Bundled: false (peer dependency)
 Description: BSD licensed community fork of mapbox-gl, a WebGL interactive maps library