@spiffcommerce/preview 5.8.9 → 5.9.0

package/dist/index.d.mts

@@ -165,7 +165,7 @@ type ThreeDPreviewService = {
      * Designed for use when utilizing the 3D preview in an editor format.
      * Given a list of material names, highlights the associated meshes in the scene.
      */
-    setHighlights(materials: readonly MaterialHandle[], color?: readonly [number, number, number]): void;
+    setHighlights(materials: readonly MaterialHandle[]): void;
     /**
      * Sets the rendering pipeline configuration for the scene. Overwrites any existing configuration.
      * @param renderingPipelineConfiguration The configuration to apply. Empty values will be set to default.
@@ -224,6 +224,12 @@ type ThreeDPreviewService = {
      * Note this will not resolve any existing promises.
      */
     forceStopCameraAnimations(): void;
+    /**
+     * Takes a list of material names supported by the highlighter. This function
+     * must be notified of materials for highlighting to work.
+     * @param materials A list of material names to allow highlighting on.
+     */
+    setHighlightMaterials(materials: string[]): void;
 };
 /**
  * Represents a service capable of managing and returning contexts that
@@ -1090,12 +1096,12 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
      * 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.
+     * A list of valid material names supported by the highlighter.
+     * All other materials will be ignored.
      */
-    private highlightLayer?;
+    private validHighlightMaterials;
+    private glowLayerManager;
     private renderingPipeline;
     private modelContainers;
     private plugins;
@@ -1131,7 +1137,7 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
     renderSceneScreenshot(resolution: number, camAnim: CameraAnimation): Promise<string>;
     orbitEnabled(): boolean;
     fireResizeEvent(): void;
-    setHighlights(materials: readonly MaterialHandle[], color?: readonly [number, number, number]): void;
+    setHighlights(materials: readonly MaterialHandle[]): void;
     setRenderingPipelineConfiguration(renderingPipelineConfiguration: RenderingPipelineConfiguration): void;
     loadModel(modelDetails: ModelDetails, options?: {
         refocusCamera?: boolean;
@@ -1154,6 +1160,7 @@ declare class SpiffCommerce3DPreviewService implements ThreeDPreviewService {
         scale: Vector;
     };
     updatePreviewOptions(options: PreviewOptions): void;
+    setHighlightMaterials(materials: string[]): void;
     /**
      * 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