Move plugins (#838)

* Move plugins

* Add subclasses

* Move gltf plugins

* Update package.json imports

* README update

* docs update

* Fixes

* Update examples

* Fix examples

example/ellipsoid.js

@@ -1,4 +1,5 @@
-import { SphereHelper, EllipsoidRegionLineHelper, EllipsoidRegionHelper } from '3d-tiles-renderer';
+import { SphereHelper } from '../src/plugins/three/objects/SphereHelper.js';
+import { EllipsoidRegionHelper, EllipsoidRegionLineHelper } from '../src/plugins/three/objects/EllipsoidRegionHelper.js';
 import {
 	Scene,
 	Group,

example/googleMapsAerial.js

@@ -1,4 +1,5 @@
-import { GeoUtils, WGS84_ELLIPSOID, TilesRenderer, GoogleCloudAuthPlugin } from '3d-tiles-renderer';
+import { GeoUtils, WGS84_ELLIPSOID, TilesRenderer } from '3d-tiles-renderer';
+import { GoogleCloudAuthPlugin } from '3d-tiles-renderer/plugins';
 import {
 	Scene,
 	WebGLRenderer,

example/googleMapsExample.js

@@ -4,8 +4,8 @@ import {
 	GeoUtils,
 	GlobeControls,
 	TilesRenderer,
-	GoogleCloudAuthPlugin,
 } from '3d-tiles-renderer';
+import { GoogleCloudAuthPlugin } from '3d-tiles-renderer/plugins';
 import {
 	Scene,
 	WebGLRenderer,

example/index.js

@@ -1,7 +1,5 @@
 import {
 	TilesRenderer,
-	DebugTilesPlugin,
-	ImplicitTilingPlugin,
 	GLTFCesiumRTCExtension,
 	NONE,
 	SCREEN_ERROR,
@@ -15,6 +13,10 @@ import {
 	CUSTOM_COLOR,
 	LOAD_ORDER,
 } from '3d-tiles-renderer';
+import {
+	DebugTilesPlugin,
+	ImplicitTilingPlugin,
+} from '3d-tiles-renderer/plugins';
 import {
 	Scene,
 	DirectionalLight,

example/ionExample.js

@@ -1,4 +1,5 @@
-import { CesiumIonAuthPlugin, EnvironmentControls, TilesRenderer } from '3d-tiles-renderer';
+import { EnvironmentControls, TilesRenderer } from '3d-tiles-renderer';
+import { CesiumIonAuthPlugin } from '3d-tiles-renderer/plugins';
 import {
 	Scene,
 	WebGLRenderer,

example/ionLunar.js

@@ -2,8 +2,8 @@ import {
 	GlobeControls,
 	TilesRenderer,
 	LUNAR_ELLIPSOID,
-	CesiumIonAuthPlugin,
 } from '3d-tiles-renderer';
+import { CesiumIonAuthPlugin } from '3d-tiles-renderer/plugins';
 import {
 	Scene,
 	WebGLRenderer,

example/mars.js

@@ -1,7 +1,5 @@
-import {
-	TilesRenderer,
-	DebugTilesPlugin,
-} from '3d-tiles-renderer';
+import { TilesRenderer } from '3d-tiles-renderer';
+import { DebugTilesPlugin } from '3d-tiles-renderer/plugins';
 import {
 	Scene,
 	DirectionalLight,

example/metadata.js

@@ -13,11 +13,13 @@ import {
 } from 'three';
 import {
 	EnvironmentControls,
+	TilesRenderer,
+} from '3d-tiles-renderer';
+import {
 	GLTFMeshFeaturesExtension,
 	GLTFStructuralMetadataExtension,
-	TilesRenderer,
 	CesiumIonAuthPlugin,
-} from '..';
+} from '3d-tiles-renderer/plugins';
 import { MeshFeaturesMaterialMixin } from './src/MeshFeaturesMaterial';
 import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader.js';
 import GUI from 'three/examples/jsm/libs/lil-gui.module.min.js';

example/r3f/globe.jsx

@@ -13,7 +13,7 @@ import {
 import { CameraTransition } from './components/CameraTransition.jsx';
 
 // Plugins
-import { GoogleCloudAuthPlugin } from '3d-tiles-renderer';
+import { GoogleCloudAuthPlugin } from '3d-tiles-renderer/plugins';
 import { GLTFExtensionsPlugin } from '../src/plugins/GLTFExtensionsPlugin.js';
 import { TilesFadePlugin } from '../src/plugins/fade/TilesFadePlugin.js';
 import { TileCompressionPlugin } from '../src/plugins/TileCompressionPlugin.js';

example/r3f/ion.jsx

@@ -3,7 +3,7 @@ import { createRoot } from 'react-dom/client';
 
 // TilesRenderer, controls and attribution imports
 import { TilesPlugin, TilesRenderer, TilesAttributionOverlay, EnvironmentControls } from '3d-tiles-renderer/r3f';
-import { CesiumIonAuthPlugin } from '3d-tiles-renderer';
+import { CesiumIonAuthPlugin } from '3d-tiles-renderer/plugins';
 
 // Plugins
 import { GLTFExtensionsPlugin } from '../src/plugins/GLTFExtensionsPlugin.js';

example/src/plugins/GLTFExtensionsPlugin.js

@@ -1,5 +1,5 @@
 import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader.js';
-import { GLTFStructuralMetadataExtension, GLTFMeshFeaturesExtension, GLTFCesiumRTCExtension } from '3d-tiles-renderer';
+import { GLTFStructuralMetadataExtension, GLTFMeshFeaturesExtension, GLTFCesiumRTCExtension } from '3d-tiles-renderer/plugins';
 
 export class GLTFExtensionsPlugin {
 

example/src/plugins/TileCompressionPlugin.js

@@ -1,5 +1,4 @@
-import { Vector3, LinearFilter } from 'three';
-import { BufferAttribute, MathUtils } from 'three';
+import { Vector3, LinearFilter, BufferAttribute, MathUtils } from 'three';
 
 const _vec = new Vector3();
 function compressAttribute( attribute, arrayType ) {

package.json

@@ -23,7 +23,8 @@
   ],
   "exports": {
     ".": "./src/index.js",
-    "./r3f": "./src/r3f/index.jsx"
+    "./r3f": "./src/r3f/index.jsx",
+    "./plugins": "./src/plugins/index.js"
   },
   "scripts": {
     "start": "vite --config ./vite.config.js",

src/base/plugins/ImplicitTilingPlugin.js

@@ -1,83 +1,11 @@
-import { SUBTREELoader } from './SUBTREELoader.js';
+import { ImplicitTilingPlugin as ImplicitTilingPluginImpl } from '../../plugins/index.js';
 
-export class ImplicitTilingPlugin {
+export class ImplicitTilingPlugin extends ImplicitTilingPluginImpl {
 
 	constructor() {
 
-		this.name = 'IMPLICIT_TILING_PLUGIN';
-
-	}
-
-	init( tiles ) {
-
-		this.tiles = tiles;
-
-	}
-
-	preprocessNode( tile, tileSetDir, parentTile ) {
-
-		if ( tile.implicitTiling ) {
-
-			tile.__hasUnrenderableContent = true;
-			tile.__hasRenderableContent = false;
-
-			// Declare some properties
-			tile.__subtreeIdx = 0;	// Idx of the tile in its subtree
-			tile.__implicitRoot = tile;	// Keep this tile as an Implicit Root Tile
-
-			// Coords of the tile
-			tile.__x = 0;
-			tile.__y = 0;
-			tile.__z = 0;
-			tile.__level = 0;
-
-		} else if ( /.subtree$/i.test( tile.content?.uri ) ) {
-
-			// Handling content uri pointing to a subtree file
-			tile.__hasUnrenderableContent = true;
-			tile.__hasRenderableContent = false;
-
-		}
-
-	}
-
-	parseTile( buffer, parseTile, extension ) {
-
-		if ( /^subtree$/i.test( extension ) ) {
-
-			const loader = new SUBTREELoader( parseTile );
-			loader.parse( buffer );
-			return Promise.resolve();
-
-		}
-
-	}
-
-	preprocessURL( url, tile ) {
-
-		if ( tile && tile.implicitTiling ) {
-
-			const implicitUri = tile.implicitTiling.subtrees.uri
-				.replace( '{level}', tile.__level )
-				.replace( '{x}', tile.__x )
-				.replace( '{y}', tile.__y )
-				.replace( '{z}', tile.__z );
-
-			return new URL( implicitUri, tile.__basePath + '/' ).toString();
-
-		}
-
-		return url;
-
-	}
-
-	disposeTile( tile ) {
-
-		if ( /.subtree$/i.test( tile.content?.uri ) ) {
-
-			tile.children.length = 0;
-
-		}
+		super();
+		console.warn( 'ImplicitTilingPlugin: Plugins should now be imported from "3d-tiles-renderer/plugins" path.' );
 
 	}
 

src/index.js

@@ -9,8 +9,7 @@ export { GLTFCesiumRTCExtension } from './three/loaders/gltf/GLTFCesiumRTCExtens
 export { GLTFStructuralMetadataExtension } from './three/loaders/gltf/GLTFStructuralMetadataExtension.js';
 export { GLTFMeshFeaturesExtension } from './three/loaders/gltf/GLTFMeshFeaturesExtension.js';
 export { GLTFExtensionLoader } from './three/loaders/GLTFExtensionLoader.js';
-export { EllipsoidRegionHelper, EllipsoidRegionLineHelper } from './three/objects/EllipsoidRegionHelper.js';
-export { SphereHelper } from './three/objects/SphereHelper.js';
+
 export * from './three/math/Ellipsoid.js';
 export * from './three/math/EllipsoidRegion.js';
 export * as GeoUtils from './three/math/GeoUtils.js';