@needle-tools/gltf-progressive 1.0.0-alpha.9 → 1.1.0-alpha.1

package/lib/lods_manager.d.ts

@@ -1,10 +1,37 @@
 import { Frustum, Matrix4, Object3D, Vector3, WebGLRenderer } from "three";
 import { NEEDLE_progressive_plugin } from "./plugins/plugin.js";
+export declare type LOD_Results = {
+    mesh_lod: number;
+    texture_lod: number;
+};
 /**
  * The LODsManager class is responsible for managing the LODs and progressive assets in the scene. It will automatically update the LODs based on the camera position, screen coverage and mesh density of the objects.
  * It must be enabled by calling the `enable` method.
  *
  * Instead of using the LODs manager directly you can also call `useNeedleProgressive` to enable progressive loading for a GLTFLoader
+ *
+ * ### Plugins
+ * Use {@link LODsManager.addPlugin} to add a plugin to the LODsManager. A plugin can be used to hook into the LOD update process and modify the LOD levels or perform other actions.
+ *
+ * @example Adding a LODsManager to a Three.js scene:
+ * ```ts
+ * import { LODsManager } from "@needle-tools/gltf-progressive";
+ * import { WebGLRenderer, Scene, Camera, Mesh } from "three";
+ *
+ * const renderer = new WebGLRenderer();
+ * const lodsManager = LODsManager.get(renderer);
+ * lodsManager.enable();
+ * ```
+ *
+ * @example Using the LODsManager with a GLTFLoader:
+ * ```ts
+ * import { useNeedleProgressive } from "@needle-tools/gltf-progressive";
+ * import { GLTFLoader } from "three/examples/jsm/loaders/GLTFLoader.js";
+ *
+ * const url = 'https://yourdomain.com/yourmodel.glb';
+ * const loader = new GLTFLoader();
+ * const lodsManager = useNeedleProgressive(url, renderer, loader);
+ * ```
  */
 export declare class LODsManager {
     /** Assign a function to draw debug lines for the LODs. This function will be called with the start and end position of the line and the color of the line when the `debugprogressive` query parameter is set.
@@ -12,9 +39,24 @@ export declare class LODsManager {
     static debugDrawLine?: (a: Vector3, b: Vector3, color: number) => void;
     /** @internal */
     static getObjectLODState(object: Object3D): LOD_state | undefined;
+    static addPlugin(plugin: NEEDLE_progressive_plugin): void;
+    static removePlugin(plugin: NEEDLE_progressive_plugin): void;
+    /**
+     * Gets the LODsManager for the given renderer. If the LODsManager does not exist yet, it will be created.
+     * @param renderer The renderer to get the LODsManager for.
+     * @returns The LODsManager instance.
+     */
+    static get(renderer: WebGLRenderer): LODsManager;
     readonly renderer: WebGLRenderer;
     readonly projectionScreenMatrix: Matrix4;
     readonly cameraFrustrum: Frustum;
+    /** @deprecated use static `LODsManager.addPlugin()` method. This getter will be removed in later versions */
+    get plugins(): NEEDLE_progressive_plugin[];
+    /**
+     * The target triangle density is the desired max amount of triangles on screen when the mesh is filling the screen.
+     * @default 200_000
+     */
+    targetTriangleDensity: number;
     /**
      * The update interval in frames. If set to 0, the LODs will be updated every frame. If set to 1, the LODs will be updated every second frame, etc.
      */
@@ -23,8 +65,8 @@ export declare class LODsManager {
      * If set to true, the LODsManager will not update the LODs.
      */
     pause: boolean;
-    readonly plugins: NEEDLE_progressive_plugin[];
-    constructor(renderer: WebGLRenderer);
+    private constructor();
+    private _frame;
     private _originalRender?;
     /**
      * Enable the LODsManager. This will replace the render method of the renderer with a method that updates the LODs.
@@ -50,6 +92,7 @@ export declare class LODsManager {
     private loadProgressiveMeshes;
     private readonly _sphere;
     private readonly _tempBox;
+    private readonly _tempBox2;
     private readonly tempMatrix;
     private readonly _tempWorldPosition;
     private readonly _tempBoxSize;
@@ -58,10 +101,14 @@ export declare class LODsManager {
     private static corner1;
     private static corner2;
     private static corner3;
+    private static readonly _tempPtInside;
+    private static isInside;
     private calculateLodLevel;
 }
 declare class LOD_state {
-    lastLodLevel: number;
+    frames: number;
+    lastLodLevel_Mesh: number;
+    lasLodLevel_Texture: number;
     lastScreenCoverage: number;
     readonly lastScreenspaceVolume: Vector3;
     lastCentrality: number;