@spiffcommerce/preview 5.11.15 → 5.12.0

package/CHANGELOG.md

@@ -14,6 +14,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [5.12.0]
+
+### Added
+
+- `ModelContainer.getUVIslandOutline(materialName)` returns the boundary/seam
+  edges of a material's UV island(s) as normalized 0..1 UV segments, for
+  overlaying a guide showing the model's actual texture unwrap in an editor.
+
 ## [5.10.5] - 14-11-2024
 
 ### Fixed

package/dist/index.d.ts

@@ -406,6 +406,15 @@ type MaterialResource = {
      */
     updatedAt: string;
 };
+/**
+ * One edge of a material's UV island outline, in normalized 0..1 UV space.
+ */
+type UVSegment = {
+    readonly u0: number;
+    readonly v0: number;
+    readonly u1: number;
+    readonly v1: number;
+};
 /**
  * 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.
@@ -887,6 +896,15 @@ type ModelContainer = {
      * Designed for use when utilizing the 3D preview in an editor format.
      */
     listMaterials(): readonly MaterialHandle[];
+    /**
+     * Traces the boundary/seam edges of the UV island(s) that a named material's
+     * mesh(es) occupy in the model's texture unwrap. Designed for use when
+     * utilizing the 3D preview in an editor format, to overlay a guide showing
+     * where a material's UVs actually land versus the canvas/panel bounds.
+     * Segments are returned in normalized 0..1 UV space.
+     * @param materialName The name of the material to trace, as returned by `listMaterials()`.
+     */
+    getUVIslandOutline(materialName: string): readonly UVSegment[];
     /**
      * Registers a callback that will be invoked when a material is under the cursor.
      * @param callback The callback to register.
@@ -1333,4 +1351,4 @@ declare const renderingPipelineDefaults: {
     };
 };
 
-export { type AntiAliasingPipelineConfiguration, type Asset, type BloomPipelineConfiguration, type CameraAnimation, type CameraPose, type ChromaticAberrationPipelineConfiguration, type Color4Configuration, type ColorCurvesConfiguration, type DepthOfFieldPipelineConfiguration, type EngineContext, type GrainPipelineConfiguration, type LoadProgressEventData, MaterialEffectMode, type MaterialHandle, type MaterialResource, type MiscPipelineConfiguration, type ModelAnimation, type ModelContainer, type ModelDetails, type ModelLoadEventData, type PowerOfTwoNumber, type PreviewOptions, type PreviewServicePlugin, ProductCameraRig, REFLECTION_PROBE_RESOLUTION, type RenderableContext, type RenderableContextService, RenderingConfiguration, type RenderingPipelineConfiguration, type SharpenPipelineConfiguration, SpiffCommerce3DPreviewService, type ThreeDPreviewService, type Vector, type VignettePipelineConfiguration, renderingPipelineDefaults };
+export { type AntiAliasingPipelineConfiguration, type Asset, type BloomPipelineConfiguration, type CameraAnimation, type CameraPose, type ChromaticAberrationPipelineConfiguration, type Color4Configuration, type ColorCurvesConfiguration, type DepthOfFieldPipelineConfiguration, type EngineContext, type GrainPipelineConfiguration, type LoadProgressEventData, MaterialEffectMode, type MaterialHandle, type MaterialResource, type MiscPipelineConfiguration, type ModelAnimation, type ModelContainer, type ModelDetails, type ModelLoadEventData, type PowerOfTwoNumber, type PreviewOptions, type PreviewServicePlugin, ProductCameraRig, REFLECTION_PROBE_RESOLUTION, type RenderableContext, type RenderableContextService, RenderingConfiguration, type RenderingPipelineConfiguration, type SharpenPipelineConfiguration, SpiffCommerce3DPreviewService, type ThreeDPreviewService, type UVSegment, type Vector, type VignettePipelineConfiguration, renderingPipelineDefaults };