@jdultra/threedtiles 14.0.20 → 14.0.21

package/dist/tileset/OGC3DTile.d.ts

@@ -46,13 +46,44 @@ export class OGC3DTile extends THREE.Object3D<THREE.Object3DEventMap> {
      * @param {number} [properties.splatsSaturation = 1.0] - optional saturation multiplier. Typical useful range: 0.0 → 2.0 (1.0 = unchanged).
      * @param {number} [properties.splatsContrast = 1.0] - optional contrast multiplier. Typical useful range: 0.0 → 2.0 (1.0 = unchanged).
      * @param {Array|Object} [properties.splatsTempTint = [0.0, 0.0]] - optional temperature and tint pair for simple white-balance adjustment. Values: temperature ∈ [-100,100], tint ∈ [-100,100]. Default [0,0].
-     * @param {Object} [options.physics.sim = undefined] - physics sim helper {@link physics.js}
-     * @param {String} [options.physics.type = fixed] - type: 'dynamic' | 'kinematic' | 'fixed' (default 'fixed')
-     * @param {String} [options.physics.shape = none] - collider shape: none, mesh, bounds
-     * @param {number} [options.physics.mass = 1] - mass
-     * @param {number} [options.physics.maxLOD = infinity] - max LOD for constructing colliders. Higher is more accurate and more costly. Only the currently loaded LODs are used.
-     * @param {Array|Vector3} [options.physics.velocity = [0,0,0]] - velocity vector
-     * @param {Array|Vector3} [options.physics.angularVelocity = [0,0,0]] - angular velocity
+     * @param {Object} [properties.physics.sim = undefined] - physics sim helper {@link physics.js}
+     * @param {String} [properties.physics.type = fixed] - type: 'dynamic' | 'kinematic' | 'fixed' (default 'fixed')
+     * @param {String} [properties.physics.shape = none] - LEGACY single collider shape: 'none' | 'mesh' | 'bounds' | 'hull'. Used only when no advanced collider rules are provided.
+     * @param {number} [properties.physics.mass = 1] - mass
+     * @param {number} [properties.physics.maxLOD = infinity] - LEGACY global max LOD for constructing colliders. Higher is more accurate and more costly. Only the currently loaded LODs are used.
+     * @param {Array|Vector3} [properties.physics.velocity = [0,0,0]] - velocity vector
+     * @param {Array|Vector3} [properties.physics.angularVelocity = [0,0,0]] - angular velocity
+     *
+     * @param {Object} [properties.physics.colliders] - ADVANCED rules to mix different collider types by geometricError or by level (LOD).
+     * @param {number} [properties.physics.colliders.maxLOD] - Global LOD cap for colliders. If omitted, falls back to properties.physics.maxLOD, else Infinity.
+     * @param {string[]} [properties.physics.colliders.priority=["mesh","hull","bounds"]] - Priority when multiple rules match the same tile. First entry wins.
+     * @param {Object[]} [properties.physics.colliders.byGeometricError] - Preferred criterion when provided. Inclusive ranges on geometricError.
+     * @param {("mesh"|"hull"|"bounds")} properties.physics.colliders.byGeometricError[].shape - Collider type to use in this range.
+     * @param {number} properties.physics.colliders.byGeometricError[].min - Inclusive minimum geometricError for the rule (defaults to -Infinity if omitted).
+     * @param {number} properties.physics.colliders.byGeometricError[].max - Exclusive maximum geometricError for the rule (defaults to +Infinity if omitted).
+     * @param {Object[]} [properties.physics.colliders.byLevel] - Fallback criterion when byGeometricError is absent/empty. Inclusive ranges on integer level (LOD).
+     * @param {("mesh"|"hull"|"bounds")} properties.physics.colliders.byLevel[].shape - Collider type to use in this LOD interval.
+     * @param {number} properties.physics.colliders.byLevel[].min - Inclusive minimum LOD (integer).
+     * @param {number} properties.physics.colliders.byLevel[].max - Inclusive maximum LOD (integer).
+     * @param {("mesh"|"hull"|"bounds")} [properties.physics.colliders.defaultShape] - Optional fallback shape when no rule matches. If omitted, legacy properties.physics.shape is used. If neither present, no collider is created.
+     *
+     * Selection rules:
+     *  - If colliders.byGeometricError has entries, it is used exclusively. Otherwise, byLevel is used when present.
+     *  - If multiple rules match, the first in colliders.priority is chosen (default priority is ["mesh","hull","bounds"]).
+     *  - If no rule matches, defaultShape is used; if absent, falls back to legacy properties.physics.shape; otherwise no collider is created.
+     *  - The colliders.maxLOD (or legacy maxLOD) acts as a global cap. Tiles with level > maxLOD never get colliders.
+     *  - When a tile becomes invisible, existing colliders at level === maxLOD are retained if the tile has children (as a fallback for deeper LODs), identical to legacy behavior.
+     * e.g. (physics.colliders):
+     * {
+     *   "maxLOD": 4,
+     *   "priority": ["mesh", "hull", "bounds"],
+     *   "byLevel": [
+     *     { "shape": "mesh",   "min": 4, "max": 4 },
+     *     { "shape": "hull",   "min": 3,  "max": 3 },
+     *     { "shape": "bounds", "min": 0,  "max": 2  }
+     *   ],
+     *   "defaultShape": "bounds"
+     * }
      */
     constructor(properties?: {
         url?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jdultra/threedtiles",
-  "version": "14.0.20",
+  "version": "14.0.21",
   "author": "Emeric Beaufays",
   "description": "An OGC 3DTiles viewer for Three.js",
   "main": "dist/threedtiles.cjs.js",