@spiffcommerce/preview 3.6.0 → 3.6.2-rc.0

package/dist/{types.d.ts → index.d.mts}

@@ -1,24 +1,25 @@
-import { Color4 } from "@babylonjs/core/Maths/math.color";
-import { Mesh } from "@babylonjs/core/Meshes/mesh";
-import { Scene } from "@babylonjs/core/scene";
-import { AutoRotationBehavior } from "@babylonjs/core/Behaviors/Cameras/autoRotationBehavior";
-import { FramingBehavior } from "@babylonjs/core/Behaviors/Cameras/framingBehavior";
-import { ArcRotateCamera } from "@babylonjs/core/Cameras/arcRotateCamera";
-import { Vector3 } from "@babylonjs/core/Maths/math.vector";
-import { Engine } from "@babylonjs/core/Engines/engine";
-import { ISceneLoaderProgressEvent } from "@babylonjs/core/Loading/sceneLoader";
+import { Engine } from '@babylonjs/core/Engines/engine';
+import { ISceneLoaderProgressEvent } from '@babylonjs/core/Loading/sceneLoader';
+import { Scene } from '@babylonjs/core/scene';
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+import { AutoRotationBehavior } from '@babylonjs/core/Behaviors/Cameras/autoRotationBehavior';
+import { FramingBehavior } from '@babylonjs/core/Behaviors/Cameras/framingBehavior';
+import { ArcRotateCamera } from '@babylonjs/core/Cameras/arcRotateCamera';
+import { Vector3 } from '@babylonjs/core/Maths/math.vector';
+import { Color4 } from '@babylonjs/core/Maths/math.color';
+
 /**
  * Defines the different behaviors supported by the camera system
  * for control when viewing a product.
  */
-export enum ProductCameraRig {
+declare enum ProductCameraRig {
     Orbit = 0,
     Pan = 1
 }
 /**
  * Details relating to a model for use in the preview.
  */
-export type ModelDetails = {
+type ModelDetails = {
     /**
      * The source of the model to load.
      */
@@ -32,7 +33,7 @@ export type ModelDetails = {
  * Identical to CameraAnimation typing, however the
  * target is always available and hence is not optional.
  */
-export type CameraPose = {
+type CameraPose = {
     readonly lonDeg: number;
     readonly radius: number;
     readonly latDeg: number;
@@ -42,7 +43,7 @@ export type CameraPose = {
         readonly z: number;
     };
 };
-export type ThreeDPreviewService = {
+type ThreeDPreviewService = {
     /**
      * Allows listeners to be aware of the camera losing focus of the
      * main product.
@@ -218,7 +219,7 @@ export type ThreeDPreviewService = {
  * Represents a service capable of managing and returning contexts that
  * can be used for rendering to textures in the 3D preview.
  */
-export type RenderableContextService = {
+type RenderableContextService = {
     /**
      * Returns all managed renderable contexts.
      */
@@ -229,7 +230,7 @@ export type RenderableContextService = {
  * with an external canvas. This context allows external clients to render to a texture
  * in the 3D preview with a simple interface.
  */
-export type RenderableContext = {
+type RenderableContext = {
     /**
      * A unique identifier for this renderable context.
      */
@@ -261,7 +262,7 @@ export type RenderableContext = {
      */
     getLastCompletedStaticRender(): number | undefined;
 };
-export type ModelLoadEventData = {
+type ModelLoadEventData = {
     /**
      * The type of event that has occurred.
      */
@@ -271,7 +272,7 @@ export type ModelLoadEventData = {
      */
     readonly modelContainer: ModelContainer;
 };
-export type LoadProgressEventData = {
+type LoadProgressEventData = {
     /**
      * The total load value of the scene, this is an average of all
      * 'in progress' loading events. when all events are fully loaded this value will be 100.
@@ -285,7 +286,7 @@ export type LoadProgressEventData = {
 /**
  * Used to specify the behavior of a material effect such as clearcoat, sheen and translucency.
  */
-export enum MaterialEffectMode {
+declare enum MaterialEffectMode {
     /**
      * When a material variant effect specifies 'None' the effect doesn't change in any way. This is the default behavior.
      */
@@ -299,14 +300,14 @@ export enum MaterialEffectMode {
      */
     ApplyWhenSelected = "ApplyWhenSelected"
 }
-export interface Asset {
+interface Asset {
     fileLink?: string;
 }
 /**
  * Represents a material resource that can be additively applied to
  * a material targeted in the scene.
  */
-export type MaterialResource = {
+type MaterialResource = {
     /**
      * A unique identified for this material.
      */
@@ -372,7 +373,7 @@ export type MaterialResource = {
  * Represents a handle to a material in the 3D scene. The underlying complexity of materials is abstracted
  * away so the client doesn't need to know anything more than the ID they're given and the name.
  */
-export type MaterialHandle = {
+type MaterialHandle = {
     /**
      * The identifier for the material.
      */
@@ -385,7 +386,7 @@ export type MaterialHandle = {
 /**
  * Settings related to the 3D preview.
  */
-export type PreviewOptions = {
+type PreviewOptions = {
     /**
      * The color expected to be seen in the background of the product. Expects a hexadecimal value.
      */
@@ -484,11 +485,16 @@ export type PreviewOptions = {
      * Configuration for post-processing effects.
      */
     readonly renderingPipelineConfiguration?: RenderingPipelineConfiguration;
+    /**
+     * Function that returns a canvas to be used for rendering. Useful when using the preview in a headless environment.
+     * @returns A canvas to be used for rendering.
+     */
+    readonly createCanvas?: () => HTMLCanvasElement;
 };
 /**
  * Defines an animation to be played on a product.
  */
-export type ModelAnimation = {
+type ModelAnimation = {
     /**
      * A value it seconds along the animation timeline to begin at.
      */
@@ -511,7 +517,7 @@ export type ModelAnimation = {
  * A CameraAnimation specifies a discrete state that the camera should
  * animate to. This state represents the final position of the camera after animations have run.
  */
-export type CameraAnimation = {
+type CameraAnimation = {
     /**
      * The longitude in degrees the camera should animate to.
      */
@@ -536,7 +542,7 @@ export type CameraAnimation = {
 /**
  * Configuration for various post processing effects.
  */
-export interface RenderingPipelineConfiguration {
+interface RenderingPipelineConfiguration {
     antiAliasing?: AntiAliasingPipelineConfiguration;
     bloom?: BloomPipelineConfiguration;
     chromaticAberration?: ChromaticAberrationPipelineConfiguration;
@@ -550,7 +556,7 @@ export interface RenderingPipelineConfiguration {
 /**
  * Anti-aliasing is a technique used to smooth out jagged edges on objects.
  */
-export interface AntiAliasingPipelineConfiguration {
+interface AntiAliasingPipelineConfiguration {
     /**
      * The number of samples to use for MSAA. 1, 2, 3, or 4.
      */
@@ -563,7 +569,7 @@ export interface AntiAliasingPipelineConfiguration {
 /**
  * Bloom is a post processing effect that adds a glow to bright areas of the scene.
  */
-export interface BloomPipelineConfiguration {
+interface BloomPipelineConfiguration {
     enabled?: boolean;
     /**
      * The size of the bloom blur kernel.
@@ -585,7 +591,7 @@ export interface BloomPipelineConfiguration {
 /**
  * Chromatic Aberration is a post processing effect that separates the RGB channels.
  */
-export interface ChromaticAberrationPipelineConfiguration {
+interface ChromaticAberrationPipelineConfiguration {
     enabled?: boolean;
     /**
      * The amount of separation between the rgb channels.
@@ -606,7 +612,7 @@ export interface ChromaticAberrationPipelineConfiguration {
 /**
  * Color Curves is a post processing effect that allows for color correction.
  */
-export interface ColorCurvesConfiguration {
+interface ColorCurvesConfiguration {
     enabled?: boolean;
     globalDensity?: number;
     globalExposure?: number;
@@ -628,7 +634,7 @@ export interface ColorCurvesConfiguration {
 /**
  * Depth of Field is a post processing effect that blurs the scene based on distance from the camera.
  */
-export interface DepthOfFieldPipelineConfiguration {
+interface DepthOfFieldPipelineConfiguration {
     enabled?: boolean;
     /**
      * The quality of the blur. Higher values will provide better quality but will be slower.
@@ -654,7 +660,7 @@ export interface DepthOfFieldPipelineConfiguration {
 /**
  * Grain is a post processing effect that adds noise to the scene.
  */
-export interface GrainPipelineConfiguration {
+interface GrainPipelineConfiguration {
     enabled?: boolean;
     /**
      * Set this to true to randomize the noise pattern each frame.
@@ -668,7 +674,7 @@ export interface GrainPipelineConfiguration {
 /**
  * Miscellaneous post processing effects.
  */
-export interface MiscPipelineConfiguration {
+interface MiscPipelineConfiguration {
     /**
      * The amount of contrast to apply to the scene.
      */
@@ -690,7 +696,7 @@ export interface MiscPipelineConfiguration {
 /**
  * Sharpening is a post processing effect that increases the contrast between pixels.
  */
-export interface SharpenPipelineConfiguration {
+interface SharpenPipelineConfiguration {
     enabled?: boolean;
     /**
      * How much of the original color to apply. 0.0 - 1.0.
@@ -701,7 +707,7 @@ export interface SharpenPipelineConfiguration {
      */
     edgeAmount?: number;
 }
-export interface VignettePipelineConfiguration {
+interface VignettePipelineConfiguration {
     enabled?: boolean;
     /**
      * "Multiply" or "Opaque". "Multiply" will mix the vignette color with the scene color. "Opaque" will replace the scene color with the vignette color.
@@ -735,13 +741,13 @@ export interface VignettePipelineConfiguration {
      */
     weight?: number;
 }
-export interface Color4Configuration {
+interface Color4Configuration {
     r: number;
     g: number;
     b: number;
     a: number;
 }
-export interface Vector {
+interface Vector {
     x: number;
     y: number;
     z: number;
@@ -749,7 +755,7 @@ export interface Vector {
 /**
  * Wraps functionality for interacting with models in the scene.
  */
-export type ModelContainer = {
+type ModelContainer = {
     /**
      * Applies a given material modifier to a target material in the scene.
      * @param targetMaterial The material to target.
@@ -839,7 +845,7 @@ export type ModelContainer = {
  * Provides references to 3D preview engine objects.
  * The types of these objects are dependent on the engine being used.
  */
-export type EngineContext = {
+type EngineContext = {
     /**
      * The camera being used by the ThreeDPreviewService.
      */
@@ -856,7 +862,7 @@ export type EngineContext = {
 /**
  * A plugin that provides additional functionality to the preview service.
  */
-export type PreviewServicePlugin = {
+type PreviewServicePlugin = {
     /**
      * Called when the plugin is first registered with the preview service.
      * @param previewService A reference to the preview service.
@@ -871,6 +877,20 @@ export type PreviewServicePlugin = {
      */
     dispose(isServiceShutdown: boolean): void;
 };
+
+/**
+ * Automatically manages construction and destruction of the glow layer.
+ */
+declare class GlowLayerManager {
+    private readonly scene;
+    private readonly intensity;
+    private glowLayer?;
+    private meshCount;
+    constructor(scene: Scene, intensity: number);
+    includeMeshes(meshes: readonly Mesh[]): void;
+    removeMeshes(meshes: readonly Mesh[]): void;
+}
+
 /**
  * Configuration for the preview. Optionally, you can provide a custom configuration. (from a workflow for example) Sensible
  * defaults will be specified for all properties otherwise.
@@ -878,6 +898,7 @@ export type PreviewServicePlugin = {
 declare class Configuration {
     readonly customOptions?: PreviewOptions;
     constructor(options?: PreviewOptions);
+    createCanvas(): HTMLCanvasElement;
     get options(): PreviewOptions;
     /**
      * Configuration related to the scene
@@ -922,46 +943,15 @@ declare class Configuration {
         contrast: number;
     };
     get emissiveGlowIntensity(): number;
-}
-/**
- * Represents the dimensions of a texture, enforcing power of two numbers.
- */
-type RenderDimensions = {
-    readonly width: PowerOfTwoNumber;
-    readonly height: PowerOfTwoNumber;
-};
-/**
- * A class containing largely static configuration information.
- */
-export class RenderingConfiguration {
-    /**
-     * Returns the resolution expected for generated textures.
-     */
-    static getDynamicTextureResolution(): RenderDimensions;
     /**
-     * Returns true when textures should generate mip maps
+     * Will return clear color based on custom configuration or a sensible default.
+     * @returns A Color4 object for use as a clear color.
      */
-    static shouldMipMap(): boolean;
-    /**
-     * Returns true when multithreaded rendering is supported.
-     */
-    static offscreenRenderingSupported(): boolean;
-    /**
-     * Returns the resolution expected for mirror textures.
-     */
-    static getMirrorTextureResolution(): PowerOfTwoNumber;
-}
-export const REFLECTION_PROBE_RESOLUTION = 128;
-export type PowerOfTwoNumber = 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192;
-export const renderingPipelineDefaults: RenderingPipelineConfiguration;
-/**
- * Automatically manages construction and destruction of the glow layer.
- */
-declare class GlowLayerManager {
-    constructor(scene: Scene, intensity: number);
-    includeMeshes(meshes: readonly Mesh[]): void;
-    removeMeshes(meshes: readonly Mesh[]): void;
+    private getSceneClearColor;
+    private highlightColorFromConfig;
+    private hexToColor4;
 }
+
 /**
  * A slightly extended version of the ArcRotateCamera.
  * Configures the camera in a way that best suites product visualization.
@@ -974,6 +964,7 @@ declare class ProductCamera extends ArcRotateCamera {
      * via panning we can notify ui about the fact to help users reset the camera.
      */
     readonly lastFocus: Vector3;
+    private panDenominator;
     /**
      * Returns the framing behavior of this camera.
      */
@@ -1014,12 +1005,60 @@ declare class ProductCamera extends ArcRotateCamera {
      */
     static create(scene: Scene, configuration: Configuration, assignActive?: boolean): ProductCamera;
 }
+
 /**
  * An example implementation of the ThreeDPreviewService interface. The inclusion of 3D previews
  * is designed to be optional, anyone can come along and implement their own 3D preview service or
  * they can use this one to get things running more quickly.
  */
-export class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
+declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
+    private readonly camera;
+    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.
+     */
+    private queuedCameraAnimation?;
+    /**
+     * When listeners have been notified of a change in camera target position
+     * 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.
+     */
+    private focusLostObservable;
+    /**
+     * An observable handling the initialization of the preview service.
+     */
+    private initializedCallbacks;
+    /**
+     * Whether or not the preview service has been initialized.
+     */
+    private isInitialized;
+    /**
+     * A collection of callbacks to be invoked when a model is loaded or unloaded.
+     */
+    private modelLoadEventCallbacks;
+    private glowLayerManager;
+    /**
+     * When instantiated, contains a list of meshes that contribute to highlighting
+     * in the scene.
+     */
+    private highlightLayer?;
+    private renderingPipeline;
+    private modelContainers;
+    private plugins;
+    private screenshotPrepareResolve;
     constructor(options?: PreviewOptions);
     getEngineContext(): {
         engine: Engine;
@@ -1060,6 +1099,57 @@ export class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
     unregisterPlugin(plugin: PreviewServicePlugin): void;
     getGlowLayerManager(): GlowLayerManager;
     modelUnloaded(modelContainer: ModelContainer): void;
+    private triggerModelLoadEvent;
+    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;
+}
+
+/**
+ * Represents the dimensions of a texture, enforcing power of two numbers.
+ */
+type RenderDimensions = {
+    readonly width: PowerOfTwoNumber;
+    readonly height: PowerOfTwoNumber;
+};
+/**
+ * A class containing largely static configuration information.
+ */
+declare class RenderingConfiguration {
+    /**
+     * Returns the resolution expected for generated textures.
+     */
+    static getDynamicTextureResolution(): RenderDimensions;
+    /**
+     * Returns true when textures should generate mip maps
+     */
+    static shouldMipMap(): boolean;
+    /**
+     * Returns true when multithreaded rendering is supported.
+     */
+    static offscreenRenderingSupported(): boolean;
+    /**
+     * Returns the resolution expected for mirror textures.
+     */
+    static getMirrorTextureResolution(): PowerOfTwoNumber;
+    private static getIsMobile;
 }
+declare const REFLECTION_PROBE_RESOLUTION = 128;
+type PowerOfTwoNumber = 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192;
+declare const renderingPipelineDefaults: RenderingPipelineConfiguration;
 
-//# sourceMappingURL=types.d.ts.map
+export { AntiAliasingPipelineConfiguration, Asset, BloomPipelineConfiguration, CameraAnimation, CameraPose, ChromaticAberrationPipelineConfiguration, Color4Configuration, ColorCurvesConfiguration, DepthOfFieldPipelineConfiguration, EngineContext, GrainPipelineConfiguration, LoadProgressEventData, MaterialEffectMode, MaterialHandle, MaterialResource, MiscPipelineConfiguration, ModelAnimation, ModelContainer, ModelDetails, ModelLoadEventData, PowerOfTwoNumber, PreviewOptions, PreviewServicePlugin, ProductCameraRig, REFLECTION_PROBE_RESOLUTION, RenderableContext, RenderableContextService, RenderingConfiguration, RenderingPipelineConfiguration, SharpenPipelineConfiguration, SpiffCommerce3DPreviewService, ThreeDPreviewService, Vector, VignettePipelineConfiguration, renderingPipelineDefaults };