@manycore/aholo-viewer 1.0.0-alpha.0 → 1.0.0

package/dist/index.d.ts

@@ -14383,6 +14383,10 @@ interface LodMeta {
         }>;
     }>;
 }
+interface DistanceStep {
+    distance: number;
+    step: number;
+}
 interface LodConfig {
     minLevel: number;
     maxBudget: number;
@@ -14391,6 +14395,7 @@ interface LodConfig {
     behindPenalty: number;
     behindTolerance: number;
     behindDistanceTolerance: number;
+    distanceStep: DistanceStep[];
     hysteresisTicks: number;
     schedulerParallelCounts: number;
     schedulerExistingTaskLimit: number;
@@ -14408,6 +14413,7 @@ declare class LodSplat {
     private behindPenalty;
     private behindTolerance;
     private behindDistanceTolerance;
+    private distanceStep;
     private hysteresisTicks;
     private schedulerParallelCounts;
     private schedulerExistingTaskLimit;
@@ -14466,8 +14472,8 @@ interface RenderCloudConfig {
      */
     apiPrefix?: string;
     /**
-     * Aholo Open Platform AppKey 鈫?HTTP header `Authorization: <AppKey>` (no `Bearer` prefix).
-     * @see https://labs-beta.aholo3d.cn/api-docs/api-reference
+     * Aholo Open Platform AppKey HTTP header `Authorization: <AppKey>` (no `Bearer` prefix).
+     * @see https://labs.aholo3d.cn/api-docs/api-reference
      */
     getAppKey?: () => string | Promise<string>;
     /** Rewrite WebSocket URL before connect. */
@@ -14478,7 +14484,7 @@ interface RenderCloudConfig {
     WebSocket?: typeof WebSocket;
     createRequestId?: () => string;
 }
-/** `components.schemas.OperationMetaData` 鈥?often `null` while processing. */
+/** `components.schemas.OperationMetaData` often `null` while processing. */
 type OperationMetaData = Record<string, unknown> | null;
 type RenderCloudErrorStatus = 'INVALID_ARGUMENT' | 'NOT_FOUND' | 'RESOURCE_EXHAUSTED' | 'INTERNAL' | string;
 /** `components.schemas.RenderCloudErrorDetails` */
@@ -14543,6 +14549,8 @@ interface StreamingStatusMessage {
 }
 interface RealtimeSessionOptions {
     usda: string;
+    /** Abort session creation and close any server session that was already allocated. */
+    signal?: AbortSignal;
     /** Poll interval when waiting for stream ACTIVE. OpenAPI suggests 2s. */
     poll?: {
         intervalMs?: number;
@@ -14559,6 +14567,8 @@ interface RealtimeSessionOptions {
     onFrame?: (frame: RenderFrame) => void;
     onError?: (error: unknown) => void;
     onStateChange?: (state: SessionState) => void;
+    /** OpenAPI returns `operationId` as the realtime `sessionId` before the session becomes ACTIVE. */
+    onSessionId?: (sessionId: string) => void;
     /** WebSocket JSON status (`code`, `desc`, queue info). Includes render errors `2001` / `2002`. */
     onStreamingStatus?: (message: StreamingStatusMessage) => void;
     /**
@@ -14638,7 +14648,7 @@ interface RealtimeSession {
     close(): Promise<void>;
 }
 /**
- * Create a realtime session: REST submit 鈫?poll ACTIVE 鈫?WebSocket 鈫?optional `:push` updates.
+ * Create a realtime session: REST submit poll ACTIVE WebSocket optional `:push` updates.
  * Aligns with OpenAPI `openapi.yaml` (RenderCloud tag).
  */
 declare function createRealtimeSession(config: RenderCloudConfig, options: RealtimeSessionOptions): Promise<RealtimeSession>;
@@ -14659,11 +14669,11 @@ declare class OfflineRenderClient {
 }
 
 /**
- * Column-major 4脳4 (e.g. Aholo Viewer `Math.Matrix4.elements`) 鈫?USDA `matrix4d` rows.
+ * Column-major 4x4 (e.g. Aholo Viewer `Math.Matrix4.elements`) USDA `matrix4d` rows.
  * USDA uses row-vector layout; column-major world matrices must be transposed for rows.
  */
 declare function matrixColumnsToUsdMatrix4d(columns: ArrayLike<number>): UsdMatrix4d;
-/** USDA `matrix4d` rows 鈫?column-major 16-element layout (Aholo Viewer `Math.Matrix4.fromArray` indexing). */
+/** USDA `matrix4d` rows column-major 16-element layout (Aholo Viewer `Math.Matrix4.fromArray` indexing). */
 declare function usdMatrix4dToMatrixColumns(rows: UsdMatrix4d, target?: Float32Array<ArrayBuffer>): Float32Array;
 
 declare class RenderCloudError extends Error {
@@ -14671,6 +14681,19 @@ declare class RenderCloudError extends Error {
     readonly body?: RenderCloudApiError | unknown;
     constructor(message: string, status: number, body?: RenderCloudApiError | unknown);
 }
+/** `Operation.error` / HTTP `RenderCloudApiError.details`. */
+declare function readRenderCloudApiErrorDetails(body: unknown): RenderCloudErrorDetails | undefined;
+/** `details.reason` per OpenAPI (`UPPER_SNAKE_CASE`). */
+declare function readRenderCloudApiErrorReason(body: unknown): string | undefined;
+/** `Operation.error.message` or top-level `RenderCloudApiError.message`. */
+declare function readRenderCloudApiErrorMessage(body: unknown): string | undefined;
+/**
+ * User-facing error text aligned with OpenAPI `RenderCloudApiError`:
+ * prefer `message` (human-readable), then `details.reason`.
+ */
+declare function formatRenderCloudUserError(body: unknown, options?: {
+    fallbackMessage?: string;
+}): string | undefined;
 
 type index_d_OfflineRenderClient = OfflineRenderClient;
 declare const index_d_OfflineRenderClient: typeof OfflineRenderClient;
@@ -14693,10 +14716,14 @@ type index_d_UsdCameraParams = UsdCameraParams;
 type index_d_UsdMatrix4d = UsdMatrix4d;
 declare const index_d_closeStreamKeepalive: typeof closeStreamKeepalive;
 declare const index_d_createRealtimeSession: typeof createRealtimeSession;
+declare const index_d_formatRenderCloudUserError: typeof formatRenderCloudUserError;
 declare const index_d_matrixColumnsToUsdMatrix4d: typeof matrixColumnsToUsdMatrix4d;
+declare const index_d_readRenderCloudApiErrorDetails: typeof readRenderCloudApiErrorDetails;
+declare const index_d_readRenderCloudApiErrorMessage: typeof readRenderCloudApiErrorMessage;
+declare const index_d_readRenderCloudApiErrorReason: typeof readRenderCloudApiErrorReason;
 declare const index_d_usdMatrix4dToMatrixColumns: typeof usdMatrix4dToMatrixColumns;
 declare namespace index_d {
-  export { index_d_OfflineRenderClient as OfflineRenderClient, index_d_RenderCloudError as RenderCloudError, index_d_closeStreamKeepalive as closeStreamKeepalive, index_d_createRealtimeSession as createRealtimeSession, index_d_matrixColumnsToUsdMatrix4d as matrixColumnsToUsdMatrix4d, index_d_usdMatrix4dToMatrixColumns as usdMatrix4dToMatrixColumns };
+  export { index_d_OfflineRenderClient as OfflineRenderClient, index_d_RenderCloudError as RenderCloudError, index_d_closeStreamKeepalive as closeStreamKeepalive, index_d_createRealtimeSession as createRealtimeSession, index_d_formatRenderCloudUserError as formatRenderCloudUserError, index_d_matrixColumnsToUsdMatrix4d as matrixColumnsToUsdMatrix4d, index_d_readRenderCloudApiErrorDetails as readRenderCloudApiErrorDetails, index_d_readRenderCloudApiErrorMessage as readRenderCloudApiErrorMessage, index_d_readRenderCloudApiErrorReason as readRenderCloudApiErrorReason, index_d_usdMatrix4dToMatrixColumns as usdMatrix4dToMatrixColumns };
   export type { index_d_OfflineRenderResult as OfflineRenderResult, index_d_Operation as Operation, index_d_OperationMetaData as OperationMetaData, index_d_RealtimeSession as RealtimeSession, index_d_RealtimeSessionOptions as RealtimeSessionOptions, index_d_RealtimeStreamResult as RealtimeStreamResult, index_d_RenderCloudApiError as RenderCloudApiError, index_d_RenderCloudConfig as RenderCloudConfig, index_d_RenderCloudErrorDetails as RenderCloudErrorDetails, index_d_RenderCloudErrorStatus as RenderCloudErrorStatus, index_d_RenderFrame as RenderFrame, index_d_SessionState as SessionState, index_d_StreamingStatusMessage as StreamingStatusMessage, index_d_UsdCameraParams as UsdCameraParams, index_d_UsdMatrix4d as UsdMatrix4d };
 }
 
@@ -14723,197 +14750,197 @@ declare const SpriteMaterial: {
     new (p?: SpriteMaterialParameters<SourceTexture$1> | undefined): SpriteMaterial$1<SourceTexture$1>;
     readonly MAX_TEXTURES: 6;
 };
-interface IPipelineConfig {
+interface IBasicBackgroundConfig {
+    color?: Color;
+    alpha?: number;
+    texture?: Texture | null;
+}
+interface IEnvMapBackgroundConfig {
+    texture?: Texture;
+    luma?: number;
+    verticalRotation?: number;
+    horizonRotation?: number;
+    reverseVertical?: boolean;
+    reverseHorizon?: boolean;
+}
+interface IGradientBackgroundConfig {
+    skyColor?: Color;
+    groundColor?: Color;
+}
+interface ISkyBackgroundConfig {
+    enablePreSkyMap?: boolean;
+    luminance?: number;
+    turbidity?: number;
+    rayleigh?: number;
+    mieCoefficient?: number;
+    mieDirectionalG?: number;
+}
+interface IBackgroundPluginConfig {
     /**
-     * background and ground
+     * @default `true`
+     */
+    enabled?: boolean;
+    /**
+     * up for background rendering, will effect ground and background
+     * @default `Vector3(0.0, 0.0, 1.0)`
      */
-    Background?: {
+    up?: Vector3;
+    ground?: {
         /**
-         * @default true
+         * enable ground grid
+         * @default `true`
          */
         enabled?: boolean;
         /**
-         * up for background rendering, will effect ground and background
-         * @default `Vector3(0.0, 0.0, 1.0)`
+         * default ground grid size
+         * @default `1000000`
          */
-        up?: Vector3;
-        ground?: {
-            /**
-             * enable ground grid
-             * @default `true`
-             */
-            enabled?: boolean;
-            /**
-             * default ground grid size
-             * @default `1000000`
-             */
-            gridSize?: number;
-            /**
-             * grid A gap
-             * @default `500`
-             */
-            gridGapSizeA?: number;
-            /**
-             * grid A color
-             * @default `Color(1.0, 1.0, 1.0)`
-             */
-            colorA?: Color;
-            /**
-             * grid A line width
-             * @default `1`
-             */
-            lineWidthA?: number;
-            /**
-             * grid B gap
-             * @default `5000`
-             */
-            gridGapSizeB?: number;
-            /**
-             * grid B color
-             * @default `Color(1.0, 1.0, 1.0)`
-             */
-            colorB?: Color;
-            /**
-             * grid B line width
-             * @default `1`
-             */
-            lineWidthB?: number;
-            /**
-             * enable ground color shading, by default will only render noise for ground.
-             * @default `false`
-             */
-            isGroundColorEnabled?: boolean;
-            /**
-             * ground color
-             * @default `Color(0.7, 0.7, 0.7)`
-             */
-            groundColor?: Color;
-        };
-        background?: {
-            /**
-             * @default `BackgroundMode.BasicBackground`
-             */
-            active?: BackgroundMode;
-            /**
-             * basic color and texture
-             * active by `BackgroundMode.BasicBackground`
-             */
-            basic?: {
-                color?: Color;
-                alpha?: number;
-                texture?: Texture | null;
-            };
-            /**
-             * sphere envmap
-             * active by `BackgroundMode.EnvMapBackground`
-             */
-            envmap?: {
-                texture?: Texture;
-                luma?: number;
-                verticalRotation?: number;
-                horizonRotation?: number;
-                reverseVertical?: boolean;
-                reverseHorizon?: boolean;
-            };
-            /**
-             * sphere gradient
-             * active by `BackgroundMode.GradientBackground`
-             */
-            gradient?: {
-                skyColor?: Color;
-                groundColor?: Color;
-            };
-            /**
-             * sky box
-             * active by `BackgroundMode.SkyBackground`
-             */
-            sky?: {
-                enablePreSkyMap?: boolean;
-                luminance?: number;
-                turbidity?: number;
-                rayleigh?: number;
-                mieCoefficient?: number;
-                mieDirectionalG?: number;
-            };
-            /**
-             * solid color
-             * active by `BackgroundMode.SolidColorBackground`, if not necessary use `BackgroundMode.BasicBackground` instead
-             */
-            solid?: {
-                color?: Color;
-                alpha?: number;
-            };
-        };
-    };
-    /**
-     * output Composite, used to optimize multi viewport rendering
-     */
-    Composite?: {
-        enabled?: boolean;
-        multiSamplingEnabled?: boolean;
-        staticFrameCacheEnabled?: boolean;
+        gridSize?: number;
+        /**
+         * grid A gap
+         * @default `500`
+         */
+        gridGapSizeA?: number;
+        /**
+         * grid A color
+         * @default `Color(1.0, 1.0, 1.0)`
+         */
+        colorA?: Color;
+        /**
+         * grid A line width
+         * @default `1`
+         */
+        lineWidthA?: number;
+        /**
+         * grid B gap
+         * @default `5000`
+         */
+        gridGapSizeB?: number;
+        /**
+         * grid B color
+         * @default `Color(1.0, 1.0, 1.0)`
+         */
+        colorB?: Color;
+        /**
+         * grid B line width
+         * @default `1`
+         */
+        lineWidthB?: number;
+        /**
+         * enable ground color shading, by default will only render noise for ground.
+         * @default `false`
+         */
+        isGroundColorEnabled?: boolean;
+        /**
+         * ground color
+         * @default `Color(0.7, 0.7, 0.7)`
+         */
+        groundColor?: Color;
     };
-    /**
-     * gaussian splatting
-     */
-    Splatting?: {
-        enabled?: boolean;
-        precalculateEnabled?: boolean;
-        repackEnabled?: boolean;
-        packHighPrecisionEnabled?: boolean;
-        preBlurAmount?: number;
-        blurAmount?: number;
-        focalAdjustment?: number;
-        maxStdDev?: number;
-        maxPixelRadius?: number;
-        detailCullingThreshold?: number;
-        normalizedFalloff?: boolean;
-        selectedColor?: Vector4;
+    background?: {
         /**
-         * gaussian sorting
+         * @default `BackgroundMode.BasicBackground`
          */
-        sort?: {
-            sortRadial?: boolean;
-            sortMinDuration?: number;
-            sortSplatDistance?: number;
-            sortSplatCoorient?: number;
-            sortCameraDistance?: number;
-            sortCameraCoorient?: number;
-        };
+        active?: BackgroundMode;
         /**
-         * composite before output
+         * basic color and texture
+         * active by `BackgroundMode.BasicBackground`
          */
-        composite?: {
-            enabled?: boolean;
-            highPrecisionAttachEnabled?: boolean;
-        };
+        basic?: IBasicBackgroundConfig;
         /**
-         * tone mapping functions
+         * sphere envmap
+         * active by `BackgroundMode.EnvMapBackground`
          */
-        toneMapping?: {
-            enabled?: boolean;
-            toneMapping?: ToneMapping;
-            exposure?: number;
-        };
+        envmap?: IEnvMapBackgroundConfig;
         /**
-         * gaussian center highlight
+         * sphere gradient
+         * active by `BackgroundMode.GradientBackground`
          */
-        highlightKernel?: {
-            enabled?: boolean;
-            size?: number;
-            color?: number;
-        };
+        gradient?: IGradientBackgroundConfig;
+        /**
+         * sky box
+         * active by `BackgroundMode.SkyBackground`
+         */
+        sky?: ISkyBackgroundConfig;
     };
+}
+interface ICompositePluginConfig {
+    enabled?: boolean;
+    multiSamplingEnabled?: boolean;
+    staticFrameCacheEnabled?: boolean;
+}
+interface ISplattingPluginConfig {
+    enabled?: boolean;
+    precalculateEnabled?: boolean;
+    repackEnabled?: boolean;
+    packHighPrecisionEnabled?: boolean;
+    preBlurAmount?: number;
+    blurAmount?: number;
+    focalAdjustment?: number;
+    maxStdDev?: number;
+    maxPixelRadius?: number;
+    detailCullingThreshold?: number;
+    normalizedFalloff?: boolean;
+    selectedColor?: Vector4;
     /**
-     * static TAA
+     * gaussian sorting
      */
-    TAA?: {
-        /**
-         * enabled static TAA
-         * @default true
-         */
+    sort?: {
+        sortRadial?: boolean;
+        sortMinDuration?: number;
+        sortSplatDistance?: number;
+        sortSplatCoorient?: number;
+        sortCameraDistance?: number;
+        sortCameraCoorient?: number;
+    };
+    /**
+     * composite before output
+     */
+    composite?: {
         enabled?: boolean;
+        highPrecisionAttachEnabled?: boolean;
     };
+    /**
+     * tone mapping functions
+     */
+    toneMapping?: {
+        enabled?: boolean;
+        toneMapping?: ToneMapping;
+        exposure?: number;
+    };
+    /**
+     * gaussian center highlight
+     */
+    highlightKernel?: {
+        enabled?: boolean;
+        size?: number;
+        color?: number;
+    };
+}
+interface ITaaPluginConfig {
+    /**
+     * enabled static TAA
+     * @default `true`
+     */
+    enabled?: boolean;
+}
+interface IPipelineConfig {
+    /**
+     * background and ground
+     */
+    Background?: IBackgroundPluginConfig;
+    /**
+     * output Composite, used to optimize multi viewport rendering
+     */
+    Composite?: ICompositePluginConfig;
+    /**
+     * gaussian splatting
+     */
+    Splatting?: ISplattingPluginConfig;
+    /**
+     * static TAA
+     */
+    TAA?: ITaaPluginConfig;
 }
 interface IViewerConfig {
     /**
@@ -14934,4 +14961,4 @@ declare function createViewer(name: string, container: HTMLElement, config: Engi
 declare function setViewerConfig(ctx: Viewer | Viewport, config: IViewerConfig): void;
 
 export { AmbientLight, animation_d as Animation, BackgroundMode, Blending, BlendingEquation, BlendingFactor, Box3, BufferAttribute, BufferGeometry, Camera3D, Color, CompressedSplat, DepthModes, DirectionalLight, dracoLoader_d as DracoLoader, DrawMode, DrawableRenderMode, Euler, events_d as Events, FatLineBufferGeometry, FatLineMaterial, FatLineSegments, FilterTarget, Frustum, gltfLoader_d as GLTFLoader, InstanceMesh, InstancedBufferAttribute, InstancedBufferGeometry, Layers, Light, Line, LineBasicMaterial as LineMaterial, LineSegments, Material, Matrix3, Matrix4, Mesh, MeshBasicMaterial, MeshPhongMaterial, Object3D, OrthographicCamera, PerspectiveCamera, Plane, PointLight, Points, PointsMaterial, Quaternion, Ray, Raycaster, index_d as RenderCloud, SamplerFilter, SamplerWrap, Scene3D, Side, SogSplat, SourceTexture, Sphere, Splat, splatLoader_d as SplatLoader, SplatState, splatUtils_d as SplatUtils, SpotLight, Sprite, SpriteMaterial, StencilFunc, StencilOp, SuperCompressedSplat, TextureDimension, TextureFormat, TextureViewDimension, ToneMapping, TypeAssert, Vector2, Vector3, Vector4, Viewer, Viewport, createViewer, createViewerContext, downloadTexture, setViewerConfig };
-export type { IPipelineConfig, IViewerConfig, IViewerContext, Intersection, ReadonlyColor, ReadonlyMatrix3, ReadonlyMatrix4, ReadonlyVector2, ReadonlyVector3, ReadonlyVector4 };
+export type { IBackgroundPluginConfig, IBasicBackgroundConfig, ICompositePluginConfig, IEnvMapBackgroundConfig, IGradientBackgroundConfig, IPipelineConfig, ISkyBackgroundConfig, ISplattingPluginConfig, ITaaPluginConfig, IViewerConfig, IViewerContext, Intersection, ReadonlyColor, ReadonlyMatrix3, ReadonlyMatrix4, ReadonlyVector2, ReadonlyVector3, ReadonlyVector4 };