@jdultra/threedtiles 12.0.1 → 13.0.0

package/dist/tileset/OGC3DTile.d.ts

@@ -7,33 +7,33 @@ export class OGC3DTile extends THREE.Object3D<THREE.Object3DEventMap> {
     /**
      * @param {Object} [properties] - the properties for this tileset
      * @param {String} [properties.url] - the url to the parent tileset.json
-     * @param {Object} [properties.queryParams] - optional, path params to add to individual tile urls
-     * @param {Number} [properties.geometricErrorMultiplier] - the geometric error of the parent. 1.0 by default corresponds to a maxScreenSpaceError of 16
-     * @param {Boolean} [properties.loadOutsideView] - if truthy, tiles otside the camera frustum will be loaded with the least possible amount of detail
-     * @param {TileLoader} [properties.tileLoader] - A tile loader that can be shared among tilesets in order to share a common cache.
-     * @param {Function} [properties.meshCallback] - A callback function that will be called on every mesh
-     * @param {Function} [properties.pointsCallback] - A callback function that will be called on every points
-     * @param {Function} [properties.onLoadCallback] - A callback function that will be called when the root tile has been loaded
-     * @param {OcclusionCullingService} [properties.occlusionCullingService] - A service that handles occlusion culling
-     * @param {Boolean} [properties.centerModel] - If true, the tileset will be centered on 0,0,0 and in the case of georeferenced tilesets that use the "region" bounding volume, it will also be rotated so that the up axis matched the world y axis.
-     * @param {Boolean} [properties.static] - If true, the tileset is considered static which improves performance but the matrices aren't automatically updated
-     * @param {String} [properties.rootPath] - optional the root path for fetching children
-     * @param {String} [properties.json] - optional json object representing the tileset sub-tree
-     * @param {Number} [properties.parentGeometricError] - optional geometric error of the parent
-     * @param {Object} [properties.parentBoundingVolume] - optional bounding volume of the parent
-     * @param {String} [properties.parentRefine] - optional refine strategy of the parent of the parent
-     * @param {THREE.Camera} [properties.cameraOnLoad] - optional the camera used when loading this particular sub-tile
-     * @param {OGC3DTile} [properties.parentTile] - optional the OGC3DTile object that loaded this tile as a child
-     * @param {String} [properties.proxy] - optional the url to a proxy service. Instead of fetching tiles via a GET request, a POST will be sent to the proxy url with the real tile address in the body of the request.
-     * @param {Boolean} [properties.displayErrors] - optional value indicating that errors should be shown on screen.
-     * @param {THREE.Renderer} [properties.renderer] - optional the renderer used to display the tileset. Used to infer render resolution at runtime and to instantiate a ktx2loader on the fly if not provided.
-     * @param {Number} [properties.domWidth] - optional the canvas width (used to calculate geometric error). If a renderer is provided, it'll be used instead, else a default value is used.
-     * @param {Number} [properties.domHeight] - optional the canvas height (used to calculate geometric error). If a renderer is provided, it'll be used instead, else a default value is used.
-     * @param {DracoLoader} [properties.dracoLoader] - optional a draco loader (three/addons).
-     * @param {KTX2Loader} [properties.ktx2Loader] - optional a ktx2 loader (three/addons).
-     * @param {Number} [properties.distanceBias] - optional a bias that allows loading more or less detail closer to the camera relative to far away. The value should be a positive number. A value below 1 loads less detail near the camera and a value above 1 loads more detail near the camera. This needs to be compensated by the geometricErrorMultiplier in order to load a reasonable number of tiles.
-     * @param {String} [properties.loadingStrategy] - optional a strategy for loading tiles "INCREMENTAL" loads intermediate LODs while "IMMEDIATE" skips intermediate LODs.
-     * @param {String} [properties.drawBoundingVolume] - optional draws the bounding volume (may cause flickering)
+     * @param {Object} [properties.queryParams = undefined] - optional, path params to add to individual tile urls
+     * @param {Number} [properties.geometricErrorMultiplier = 1] - the geometric error of the parent. 1.0 by default corresponds to a maxScreenSpaceError of 16
+     * @param {Boolean} [properties.loadOutsideView = false] - if truthy, tiles otside the camera frustum will be loaded with the least possible amount of detail
+     * @param {TileLoader} [properties.tileLoader = undefined] - A tile loader that can be shared among tilesets in order to share a common cache.
+     * @param {Function} [properties.meshCallback = undefined] - A callback function that will be called on every mesh
+     * @param {Function} [properties.pointsCallback = undefined] - A callback function that will be called on every points
+     * @param {Function} [properties.onLoadCallback = undefined] - A callback function that will be called when the root tile has been loaded
+     * @param {OcclusionCullingService} [properties.occlusionCullingService = undefined] - A service that handles occlusion culling
+     * @param {Boolean} [properties.centerModel = false] - If true, the tileset will be centered on 0,0,0 and in the case of georeferenced tilesets that use the "region" bounding volume, it will also be rotated so that the up axis matched the world y axis.
+     * @param {Boolean} [properties.static = false] - If true, the tileset is considered static which improves performance but the matrices aren't automatically updated
+     * @param {String} [properties.rootPath = undefined] - optional the root path for fetching children
+     * @param {String} [properties.json = undefined] - optional json object representing the tileset sub-tree
+     * @param {Number} [properties.parentGeometricError = undefined] - optional geometric error of the parent
+     * @param {Object} [properties.parentBoundingVolume = undefined] - optional bounding volume of the parent
+     * @param {String} [properties.parentRefine = undefined] - optional refine strategy of the parent of the parent
+     * @param {THREE.Camera} [properties.cameraOnLoad = undefined] - optional the camera used when loading this particular sub-tile
+     * @param {OGC3DTile} [properties.parentTile = undefined] - optional the OGC3DTile object that loaded this tile as a child
+     * @param {String} [properties.proxy = undefined] - optional the url to a proxy service. Instead of fetching tiles via a GET request, a POST will be sent to the proxy url with the real tile address in the body of the request.
+     * @param {Boolean} [properties.displayErrors = false] - optional value indicating that errors should be shown on screen.
+     * @param {THREE.Renderer} [properties.renderer = undefined] - optional the renderer used to display the tileset. Used to infer render resolution at runtime and to instantiate a ktx2loader on the fly if not provided.
+     * @param {Number} [properties.domWidth = undefined] - optional the canvas width (used to calculate geometric error). If a renderer is provided, it'll be used instead, else a default value is used.
+     * @param {Number} [properties.domHeight = undefined] - optional the canvas height (used to calculate geometric error). If a renderer is provided, it'll be used instead, else a default value is used.
+     * @param {DracoLoader} [properties.dracoLoader = undefined] - optional a draco loader (three/addons).
+     * @param {KTX2Loader} [properties.ktx2Loader = undefined] - optional a ktx2 loader (three/addons).
+     * @param {Number} [properties.distanceBias = 1] - optional a bias that allows loading more or less detail closer to the camera relative to far away. The value should be a positive number. A value below 1 loads less detail near the camera and a value above 1 loads more detail near the camera. This needs to be compensated by the geometricErrorMultiplier in order to load a reasonable number of tiles.
+     * @param {String} [properties.loadingStrategy = "INCREMENTAL"] - optional a strategy for loading tiles "INCREMENTAL" loads intermediate LODs while "IMMEDIATE" skips intermediate LODs.
+     * @param {String} [properties.drawBoundingVolume = false] - optional draws the bounding volume (may cause flickering)
      */
     constructor(properties?: {
         url?: string | undefined;
@@ -65,6 +65,7 @@ export class OGC3DTile extends THREE.Object3D<THREE.Object3DEventMap> {
         loadingStrategy?: string | undefined;
         drawBoundingVolume?: string | undefined;
     } | undefined);
+    splatsMesh: any;
     contentURL: any[];
     rendererSize: THREE.Vector2;
     loadingStrategy: string;
@@ -96,6 +97,8 @@ export class OGC3DTile extends THREE.Object3D<THREE.Object3DEventMap> {
         percentageLoaded: number;
     };
     geometricErrorMultiplier: number;
+    splatsCropRadius: number;
+    splatsSizeMultiplier: number;
     renderer: THREE.Renderer | undefined;
     meshCallback: Function | undefined;
     loadOutsideView: boolean | undefined;
@@ -114,6 +117,16 @@ export class OGC3DTile extends THREE.Object3D<THREE.Object3DEventMap> {
     centerModel: boolean | undefined;
     abortController: AbortController;
     onLoadCallback: Function | undefined;
+    /**
+     * Specify a size multiplier for splats
+     * @param {number} sizeMultiplier
+     */
+    setSplatsSizeMultiplier(sizeMultiplier: number): void;
+    /**
+     * specify a crop radius for splats
+     * @param {number} cropRadius
+     */
+    setSplatsCropRadius(cropRadius: number): void;
     /**
      * Manually updates all the matrices of the tileset.
      * To be called after transforming a {@link OGC3DTile tileset} instantiated with the "static" option
@@ -140,6 +153,7 @@ export class OGC3DTile extends THREE.Object3D<THREE.Object3DEventMap> {
     deleted: boolean | undefined;
     _disposeMeshContent(): void;
     _disposeChildren(): void;
+    raycast(raycaster: any, intersects: any): boolean | void;
     _updateImmediate(camera: any, frustum: any): void;
     shouldBeVisible: boolean | undefined;
     _statsImmediate(maxLOD: any, numTiles: any, percentageLoaded: any, numTilesRendered: any): void;
@@ -174,6 +188,7 @@ export class OGC3DTile extends THREE.Object3D<THREE.Object3DEventMap> {
      * @param {Number} geometricErrorMultiplier set the LOD multiplier for the entire tileset
      */
     setGeometricErrorMultiplier(geometricErrorMultiplier: number): void;
+    splatsReady: boolean | undefined;
     /**
      * Set the Distance Bias for the tileset.
      * the {@param distanceBias} can be a number between 0 and infinity.

package/dist/tileset/TileLoader.d.ts

@@ -16,23 +16,24 @@ export class TileLoader {
      *
      *
      * @param {Object} [options] - Optional configuration object.
+     * @param {renderer} [options.renderer] - the WebGL renderer
      * @param {number} [options.maxCachedItems=100] - the cache size.
      * @param {function} [options.meshCallback = undefined] - A callback to call on newly decoded meshes.
      * @param {function} [options.pointsCallback = undefined] - A callback to call on newly decoded points.
      * @param {sring} [options.proxy = undefined] - An optional proxy that tile requests will be directed too as POST requests with the actual tile url in the body of the request.
      * @param {KTX2Loader} [options.ktx2Loader = undefined] - A KTX2Loader (three/addons)
      * @param {DRACOLoader} [options.dracoLoader = undefined] - A DRACOLoader (three/addons)
-     * @param {renderer} [options.renderer = undefined] - optional the renderer, this is required only for on the fly ktx2 support. not needed if you pass a ktx2Loader manually
      */
     constructor(options?: {
+        renderer?: any;
         maxCachedItems?: number | undefined;
         meshCallback?: Function | undefined;
         pointsCallback?: Function | undefined;
         proxy?: any;
         ktx2Loader?: any;
         dracoLoader?: any;
-        renderer?: any;
     } | undefined);
+    renderer: any;
     zUpToYUpMatrix: THREE.Matrix4;
     maxCachedItems: number;
     proxy: any;
@@ -43,6 +44,7 @@ export class TileLoader {
     hasKTX2Loader: boolean | undefined;
     hasMeshOptDecoder: boolean;
     b3dmDecoder: B3DMDecoder;
+    splatsDecoder: SplatsDecoder;
     cache: any;
     register: {};
     ready: any[];
@@ -74,7 +76,7 @@ export class TileLoader {
      * @param {Boolean} meshZupToYup
      * @param {Number} geometricError
      */
-    get(abortController: AbortController, tileIdentifier: string | number, path: string, callback: Function, distanceFunction: Function, getSiblings: Function, level: number, sceneZupToYup: boolean, meshZupToYup: boolean, geometricError: number): void;
+    get(abortController: AbortController, tileIdentifier: string | number, path: string, callback: Function, distanceFunction: Function, getSiblings: Function, level: number, sceneZupToYup: boolean, meshZupToYup: boolean, geometricError: number, splatsMesh: any): void;
     /**
      * Invalidates all the unused cached tiles.
      */
@@ -89,3 +91,4 @@ export class TileLoader {
 }
 import * as THREE from 'three';
 import { B3DMDecoder } from "../decoder/B3DMDecoder";
+import { SplatsDecoder } from "../decoder/SplatsDecoder";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jdultra/threedtiles",
-  "version": "12.0.1",
+  "version": "13.0.0",
   "author": "Emeric Beaufays",
   "description": "An OGC 3DTiles viewer for Three.js",
   "main": "dist/threedtiles.cjs.js",
@@ -22,12 +22,17 @@
     "build": "vite build --config vite.prod.config.js && npm run build:types",
     "build:types": "tsc --declaration --emitDeclarationOnly --allowJs --outDir dist",
     "generate-docs": "jsdoc --configure jsdoc.json --verbose",
-    "dev": "vite"
+    "dev": "vite",
+    "build:dev": "vite build --config vite.config.js",
+    "test:watch": "vitest",
+    "test": "vitest run"
   },
   "peerDependencies": {
     "three": "0.170.0"
   },
   "dependencies": {
+    "@haragei/dag": "^1.1.0",
+    "data-structure-typed": "^1.53.5",
     "js-utils-z": "^1.2.1",
     "meshoptimizer": "^0.20.0",
     "path-browserify": "^1.0.1",
@@ -36,9 +41,11 @@
   },
   "devDependencies": {
     "@rollup/plugin-terser": "^0.4.4",
+    "@types/three": "^0.169.0",
+    "jsdom": "^25.0.1",
     "typescript": "^5.6.3",
     "vite": "^5.4.10",
     "vite-plugin-static-copy": "^2.0.0",
-    "@types/three": "^0.169.0"
+    "vitest": "^2.1.5"
   }
 }