feat(3dtiles): add deprecation warning to C3DTilesLayer. Use OGC3DTil…

…esLayer instead
iTowns · Oct 11, 2024 · cbfd1bb · cbfd1bb
1 parent 3eb7a23
commit cbfd1bb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/Layer/C3DTilesLayer.js b/src/Layer/C3DTilesLayer.js
@@ -105,6 +105,7 @@ class C3DTilesLayer extends GeometryLayer {
      * @param  {View}  view  The view
      */
     constructor(id, config, view) {
+        console.warn('C3DTilesLayer is deprecated and will be removed in iTowns 3.0 version. Use OGC3DTilesLayer instead.');
         super(id, new THREE.Group(), { source: config.source });
         this.isC3DTilesLayer = true;
         this.sseThreshold = config.sseThreshold || 16;

diff --git a/src/Layer/OGC3DTilesLayer.js b/src/Layer/OGC3DTilesLayer.js
@@ -112,6 +112,13 @@ export function enableKtx2Loader(path, renderer) {
 class OGC3DTilesLayer extends GeometryLayer {
     /**
      * Layer for [3D Tiles](https://www.ogc.org/standard/3dtiles/) datasets.
+     *
+     * Advanced configuration note: 3D Tiles rendering is delegated to 3DTilesRendererJS that exposes several
+     * configuration options accessible through the tilesRenderer property of this class. see the
+     * [3DTilesRendererJS doc](https://github.com/NASA-AMMOS/3DTilesRendererJS/blob/master/README.md). Also note that
+     * the cache is shared amongst 3D tiles layers and can be configured through tilesRenderer.lruCache (see the
+     * [following documentation](https://github.com/NASA-AMMOS/3DTilesRendererJS/blob/master/README.md#lrucache-1).
+     *
      * @extends Layer
      *
      * @param {String} id - unique layer id.