@spiffcommerce/preview 5.0.0-beta.0 → 5.0.0-rc.1

package/dist/index.d.mts

@@ -56,19 +56,6 @@ type ThreeDPreviewService = {
      * @param listener The listener to remove.
      */
     unregisterFocusLostListener(listener: () => void): void;
-    /**
-     * Providers listeners with information about load progress when
-     * the preview is loading scenes.
-     * @param listener A function to get load progress updates
-     */
-    registerLoadProgressListener(listener: (e: LoadProgressEventData) => void): void;
-    /**
-     * Allows you to pass any function that originally called registerLoadProgressListener()
-     * to have it excluded from load progress updates.
-     * If the function was never registered this call has no effect.
-     * @param listener The listener to exclude from load progress.
-     */
-    unregisterLoadProgressListener(listener: (e: LoadProgressEventData) => void): void;
     /**
      * Provides a callback that will be called when the service has been initialized.
      * @param listener The callback function to add.
@@ -115,12 +102,6 @@ type ThreeDPreviewService = {
      * Shutdown the preview engine and all registered plugins. Noop if the engine is not initialized.
      */
     shutdown(): void;
-    /**
-     * Initialize the scene. Also initialize the engine, if it hasn't been done already.
-     * @param modelDetails Optional model details to load.
-     * @returns A promise that resolves with the model container, or undefined if no model was loaded.
-     */
-    initialize(modelDetails?: ModelDetails): Promise<ModelContainer | undefined>;
     /**
      * Executes an animation of the camera.
      * @param animation The animation to execute.
@@ -151,10 +132,6 @@ type ThreeDPreviewService = {
      * @param shouldAutoRotate When true rotation is running, paused otherwise.
      */
     setAutoRotation(shouldAutoRotate: boolean): void;
-    /**
-     * Get current load progress for the scene.
-     */
-    getSceneInitializationProgress(): number;
     /**
      * Returns the current configuration object applied to the scene.
      */
@@ -1016,10 +993,6 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
     private readonly configuration;
     private readonly engine;
     private readonly scene;
-    /**
-     * The current progress of loading the scene. A value between 0-100.
-     */
-    private loadProgress;
     /**
      * The last camera animation requested if the scene wasn't ready.
      */
@@ -1029,10 +1002,6 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
      * this field will be set to true.
      */
     private focusLostNotified;
-    /**
-     * A list of listener who want to know about the progress of scene loading.
-     */
-    private loadObservable;
     /**
      * An observable handling loss of target focus by the camera.
      */
@@ -1042,7 +1011,7 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
      */
     private initializedCallbacks;
     /**
-     * Whether or not the preview service has been initialized.
+     * Whether or not the preview service has completed its first render
      */
     private isInitialized;
     /**
@@ -1067,8 +1036,6 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
     };
     registerFocusLostListener(listener: () => void): void;
     unregisterFocusLostListener(listener: () => void): void;
-    registerLoadProgressListener(listener: (e: LoadProgressEventData) => void): void;
-    unregisterLoadProgressListener(listener: (e: LoadProgressEventData) => void): void;
     registerInitializedListener(listener: () => void | Promise<void>): void;
     unregisterInitializedListener(listener: () => void | Promise<void>): void;
     getIsInitialized(): boolean;
@@ -1078,8 +1045,7 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
     getNumViewports(): number;
     unregisterView(canvas: HTMLCanvasElement): void;
     shutdown(): void;
-    getSceneInitializationProgress(): number;
-    initialize(modelDetails?: ModelDetails): Promise<ModelContainer | undefined>;
+    private renderLoop;
     executeCameraAnimation(animation: CameraAnimation): void;
     getCameraPose(): CameraPose | undefined;
     setCameraPose(cameraPose: CameraPose): void;
@@ -1108,23 +1074,12 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
         rotation: Vector;
         scale: Vector;
     };
-    private handleMaterialProgressCallback;
-    private handleModelProgressCallback;
     /**
      * Given a valid canvas element, will remove any existing input controls
      * and re-attach them to the given canvas. The pan mouse button can be set
      * to either 0 (left mouse) or 2 (right mouse).
      */
     private reattachControls;
-    /**
-     * Computes a load listener event based on current state of scene.
-     */
-    private getLoadListenerEvent;
-    /**
-     * Computes the average loading time across all loading events and notifies
-     * listeners of the current load progress.
-     */
-    private notifyLoadHandlers;
 }
 
 /**