@expofp/renderer 3.1.6 → 3.2.0

package/dist/index.d.ts

@@ -178,6 +178,14 @@ export declare interface EventsAPI {
     clear(): void;
 }
 
+/**
+ * Loads a GLB file, converts it to a Three.js {@link Scene}, exports the scene as a GLTF
+ * (JSON) file, and triggers a browser download of the result.
+ * @param url - The URL of the GLB file.
+ * @param isMeshopt - Whether the model file uses meshopt compression.
+ */
+export declare function glb2gltf(url: string, isMeshopt?: boolean): Promise<void>;
+
 /**
  * Public API interface exposed through renderer.controls.handlers.
  * Each handler implements this interface to provide consistent enable/disable/configure functionality.
@@ -254,6 +262,10 @@ export declare function isLineDef(def: RenderableDef): def is LineDef;
 
 export declare function isLineLayer(layer: LayerDef): layer is TypedLayerDef<LineDef>;
 
+export declare function isModelDef(def: RenderableDef): def is ModelDef;
+
+export declare function isModelLayer(layer: LayerDef): layer is TypedLayerDef<ModelDef>;
+
 export declare function isShapeDef(def: RenderableDef): def is ShapeDef;
 
 export declare function isShapeLayer(layer: LayerDef): layer is TypedLayerDef<ShapeDef>;
@@ -294,6 +306,26 @@ export declare interface LineDef extends SharedDef {
     width: number;
 }
 
+/** Options for loading a GLB file. */
+export declare interface LoadGLBOptions {
+    /** The URL of the GLB file. */
+    url: string;
+    /** Whether the model file uses meshopt compression. */
+    isMeshopt?: boolean;
+    /** Whether the model file uses Draco compression. */
+    isDraco?: boolean;
+}
+
+/** External 3D model definition */
+export declare interface ModelDef extends SharedDef {
+    /** Model's URL. Not updatable. */
+    url: string;
+    /** Model's bounds */
+    bounds: Rect;
+    /** Model's opacity. Optional. */
+    opacity?: number;
+}
+
 /**
  * Data for mouse events
  */
@@ -452,7 +484,7 @@ export declare class Rect {
     private updateMinAndMax;
 }
 
-export declare type RenderableDef = LayerDef | ShapeDef | ImageDef | TextDef | LineDef;
+export declare type RenderableDef = LayerDef | ShapeDef | ImageDef | TextDef | LineDef | ModelDef;
 
 export declare type RenderableDefCollection<T = RenderableDef> = T extends RenderableDef ? T[] : never;
 
@@ -530,6 +562,11 @@ export declare class Renderer {
      * Returns true if the renderer is disposed, meaning that all WebGL resources have been released.
      */
     get isDisposed(): boolean;
+    /**
+     * Loads a GLB file and returns a Three.js model.
+     * @param models - The models to load.
+     */
+    loadModel(models: LoadGLBOptions[]): Promise<void>;
     /**
      * Initializes viewport and scene with the given scene definition.
      * Should be called once on startup. Repeated calls will produce console warnings.
@@ -644,6 +681,16 @@ export declare interface SharedDef {
     dim?: boolean;
 }
 
+/**
+ * Loads a GLTF/GLB file and splits its top-level children into two GLB files based on
+ * whether each child's name starts with `BasisTransform`. The matching children are saved
+ * with a `-decor` suffix; the rest are saved with a `-base` suffix. Both files are
+ * triggered as browser downloads. The output is intentionally uncompressed — run a
+ * meshopt/quantize pass offline (e.g. via `gltf-transform`) afterwards.
+ * @param url - The URL of the GLTF/GLB file.
+ */
+export declare function splitGltf(url: string): Promise<void>;
+
 /** Text alignment */
 export declare interface TextAlignment {
     /** Horizontal alignment */