@miris-inc/core 0.0.8-3a3c0cf → 0.0.8-3a8fc9d

package/dist/core.d.ts

@@ -1,9 +1,17 @@
+export declare const AssetFormat: {
+    readonly GaussianSplats: 1;
+    readonly GES: 2;
+};
+
 declare interface AttributeInfo extends EmbindObject {
-    readonly dataType: number;
-    readonly componentCount: number;
-    readonly dataPtr: number;
-    readonly dataByteLength: number;
+    // Logical elements from the drop metadata: splats for a per-splat attribute, records for a
+    // per-surfel one. Not necessarily dataSizeBytes / bytesPerElement.
+    readonly elementCount: number;
+    readonly dataSizeBytes: number;
     readonly clientSideId: bigint;
+    // An embind CompressionType value, compared by identity against MainModule.CompressionType
+    readonly compressionType: unknown;
+    readonly minValue: { x: number; y: number; z: number; w: number };
     readonly maxValue: { x: number; y: number; z: number };
 }
 
@@ -20,8 +28,19 @@ export declare class AttributeNames {
     static readonly SPARK_EXTENDED_SH3_B: string;
     static readonly UNUSED: string;
     static readonly SHARK_ELLIPSOIDS: string;
+    static readonly SHARK_ELLIPSOIDS_COMPRESSED: string;
     static readonly SHARK_SPHERICAL_HARMONICS: string;
+    static readonly COLOR: string;
     static readonly OCTANT_OFFSETS: string;
+    static readonly SURFEL_OCTANT_OFFSETS: string;
+    static readonly SURFEL_COUNT: string;
+    static readonly SURFEL_OWNER_GROUPS: string;
+    static readonly OCTANT_CELL: string;
+    static readonly REFLECTANCE_DATA_V1: string;
+    static readonly REFLECTANCE_DATA_V2: string;
+    static readonly GLASS_MESH_GEOMETRY: string;
+    static readonly GLASS_MESH_PANELS: string;
+    static readonly MOD_DEPTH: string;
 }
 
 declare type CachedAttribute = {
@@ -94,7 +113,9 @@ declare class Client {
     getSceneMetadata(...args: ClientMethodParameters["getSceneMetadata"]): number;
     getSceneObjectParent(...args: ClientMethodParameters["getSceneObjectParent"]): number;
     getSceneObjectType(...args: ClientMethodParameters["getSceneObjectType"]): SceneObjectType;
+    getStreamStatus(...args: ClientMethodParameters["getStreamStatus"]): StreamStatus;
     getDrawnOctantMask(...args: ClientMethodParameters["getDrawnOctantMask"]): number;
+    getOctantLocalBoundingBoxes(...args: ClientMethodParameters["getOctantLocalBoundingBoxes"]): number[];
     getLocalTransform(...args: ClientMethodParameters["getLocalTransform"]): AquaStatus;
     getWorldTransform(...args: ClientMethodParameters["getWorldTransform"]): AquaStatus;
     hasAttribute(...args: ClientMethodParameters["hasAttribute"]): boolean;
@@ -110,6 +131,8 @@ declare class Client {
     hasFeature(...args: ClientMethodParameters["hasFeature"]): boolean;
     getFeatureVersion(...args: ClientMethodParameters["getFeatureVersion"]): number;
     getFeatureState(...args: ClientMethodParameters["getFeatureState"]): number;
+    getAssetFormatVersion(...args: ClientMethodParameters["getAssetFormatVersion"]): number;
+    getDrMapLadderRoughnessLevels(...args: ClientMethodParameters["getDrMapLadderRoughnessLevels"]): number[];
     getName(...args: ClientMethodParameters["getName"]): string;
     setVariantSelection(...args: ClientMethodParameters["setVariantSelection"]): AquaStatus;
     takeAttribute(...args: ClientMethodParameters["takeAttribute"]): AquaStatus;
@@ -117,7 +140,6 @@ declare class Client {
     takeRenderRequired(...args: ClientMethodParameters["takeRenderRequired"]): boolean;
     unlockScene(...args: ClientMethodParameters["unlockScene"]): boolean;
     updateSceneExecution(...args: ClientMethodParameters["updateSceneExecution"]): AquaStatus;
-    recordFrameTime(...args: ClientMethodParameters["recordFrameTime"]): AquaStatus;
 }
 
 declare type ClientInit = {
@@ -176,11 +198,23 @@ declare class Engine {
         readonly Loaded: 2;
         readonly Failed: 3;
     };
+    static StreamStatus: {
+        readonly Unknown: 0;
+        readonly Resolving: 1;
+        readonly Loading: 2;
+        readonly Ready: 3;
+        readonly Failed: 4;
+    };
     readonly ready: Promise<this>;
     readonly pending: boolean;
     get module(): MainModule;
     constructor(moduleOptions?: Record<string, unknown>);
     get AttributeInfo(): new () => AttributeInfo;
+    get CompressionType(): {
+        SHARK_ELLIPSOID_COMPRESSED: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE_V2: unknown;
+    };
     get Handedness(): {
         Right: number;
         Left: number;
@@ -218,6 +252,7 @@ declare class Engine {
     deactivatedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
     remaskedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
     getDrawnOctantMask(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
+    getOctantLocalBoundingBoxes(...args: [handle: AquaClientHandle, sceneObjectId: number]): number[];
     destroyClient(...args: [handle: AquaClientHandle]): AquaStatus;
     free(...args: [size: number]): number;
     getAssetsAsync(...args: [handle: AquaClientHandle, tags: StringVector]): AssetInfo[];
@@ -227,8 +262,8 @@ declare class Engine {
     attributeName: string,
     attributeInfo: AttributeInfo
     ]): AquaStatus;
-    getDefaultCameraId(...args: [handle: AquaClientHandle]): number;
-    getViewingVolumeId(...args: [handle: AquaClientHandle]): number;
+    getDefaultCameraId(...args: [handle: AquaClientHandle, streamObjectId: number]): number;
+    getViewingVolumeId(...args: [handle: AquaClientHandle, streamObjectId: number]): number;
     getLocalBoundingBox(...args: [handle: AquaClientHandle, sceneObjectId: number, boxData: number]): AquaStatus;
     getWorldBoundingBox(...args: [handle: AquaClientHandle, sceneObjectId: number, boxData: number]): AquaStatus;
     getLodIndex(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
@@ -236,6 +271,7 @@ declare class Engine {
     getSceneChangesCounts(...args: [handle: AquaClientHandle, sceneChangeIds: SceneChangeIds]): void;
     getSceneMetadata(...args: [handle: AquaClientHandle, metadata: SceneMetadata]): number;
     getSceneObjectParent(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
+    getStreamStatus(...args: [handle: AquaClientHandle, streamObjectId: number]): StreamStatus;
     getSceneObjectType(...args: [handle: AquaClientHandle, sceneObjectId: number]): SceneObjectType;
     getLocalTransform(...args: [
     handle: AquaClientHandle,
@@ -288,6 +324,7 @@ declare class Engine {
     viewportHeightPixels: number
     ]): AquaStatus;
     setMaxCacheSize(...args: [maxSizeBytes: number]): void;
+    setPreferSharkEncodingProfiles(...args: [preferShark: boolean]): void;
     setSceneObjectTransform(...args: [
     handle: AquaClientHandle,
     sceneObjectId: number,
@@ -296,6 +333,8 @@ declare class Engine {
     hasFeature(...args: [handle: AquaClientHandle, sceneObjectId: number, feature: number]): boolean;
     getFeatureVersion(...args: [handle: AquaClientHandle, sceneObjectId: number, feature: number]): number;
     getFeatureState(...args: [handle: AquaClientHandle, sceneObjectId: number, feature: number]): number;
+    getDrMapLadderRoughnessLevels(...args: [handle: AquaClientHandle, sceneObjectId: number]): number[];
+    getAssetFormatVersion(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
     getName(...args: [handle: AquaClientHandle, sceneObjectId: number]): string;
     setVariantSelection(...args: [handle: AquaClientHandle, sceneObjectId: number]): AquaStatus;
     takeAttribute(...args: [
@@ -308,8 +347,15 @@ declare class Engine {
     getActiveClientSideIdsCheckSum(): number;
     unlockScene(...args: [handle: AquaClientHandle]): boolean;
     updateSceneExecution(...args: [handle: AquaClientHandle]): AquaStatus;
-    recordFrameTime(...args: [handle: AquaClientHandle, frameTimeMs: number]): AquaStatus;
     takeRenderRequired(...args: [handle: AquaClientHandle]): boolean;
+    /**
+     * Advances the runtime by one frame and recomputes the streaming budget. Call once per
+     * displayed frame per context, before the per-client updateSceneExecution() calls.
+     * `previousFrameTimeMs` is how long the previous frame took; pass 0 when there is no plausible
+     * measurement (first frame, or a resume from a stall) and the frame advances without recording
+     * one.
+     */
+    beginFrame(...args: [contextHandle: AquaContextHandle, previousFrameTimeMs: number]): AquaStatus;
     createDeserializeWorker(_url: string, _workerUrl: string, poolSize: number): boolean;
     cancelRequest(requestIdLow: number, requestIdHigh: number): boolean;
     submitToWorker(requestIdLow: number, requestIdHigh: number, descriptorBuffer: ArrayBuffer, contextPtr: number): boolean;
@@ -323,6 +369,12 @@ declare type EngineMethodParameters<E extends Engine = Engine> = {
     [Key in keyof E]: E[Key] extends (...args: any[]) => any ? Parameters<E[Key]> : never;
 };
 
+export declare const HaveData = 2;
+
+export declare const HaveMetadata = 1;
+
+export declare const HaveNothing = 0;
+
 export declare class Lod {
     #private;
     readonly id: LodInit["id"];
@@ -353,11 +405,19 @@ export declare class Lod {
     get transform(): Float32Array<ArrayBuffer> | null;
     get _drawnOctantMask(): number;
     set _drawnOctantMask(mask: number);
+    get _octantLocalBounds(): Float32Array<ArrayBuffer> | null;
+    set _octantLocalBounds(bounds: Float32Array<ArrayBuffer> | null);
     get _octantOffsets(): Uint32Array<ArrayBuffer> | null;
     get _hasOctantOffsets(): boolean;
+    get _surfelOctantOffsets(): Uint32Array<ArrayBuffer> | null;
+    get _surfelCount(): number;
+    get _surfelOwnerGroups(): Uint32Array<ArrayBuffer> | null;
+    get _octantCell(): Uint32Array<ArrayBuffer> | null;
     _readOctantOffsets(engine: Engine): void;
     hasAttribute(attributeName: string): boolean;
     getDataFromAttribute(engine: Engine, attributeName: string, attributeInfo: AttributeInfo): CachedAttribute | null;
+    _getRawByteAttribute(engine: Engine, attributeName: string): Uint8Array<ArrayBuffer> | null;
+    _getRawByteAttributeWithBounds(engine: Engine, attributeName: string): RawByteAttributeWithBounds | null;
     dispose(): void;
     constructor({ id, modelRoot, lodStore, client }: LodInit);
 }
@@ -382,6 +442,11 @@ export declare class LodStore {
 
 declare interface MainModule {
     AttributeInfo: new () => AttributeInfo;
+    CompressionType: {
+        SHARK_ELLIPSOID_COMPRESSED: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE_V2: unknown;
+    };
     Handedness: { Right: number; Left: number };
     HEAPF32: Float32Array<ArrayBuffer>;
     HEAPU8: Uint8Array<ArrayBuffer>;
@@ -410,6 +475,7 @@ declare interface MainModule {
     remaskedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
     deletedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
     GetDrawnOctantMask(handle: number, sceneObjectId: number): number;
+    GetOctantLocalBoundingBoxes(handle: number, sceneObjectId: number): number[];
     GetAssetsAsync(handle: number, tags: StringVector): unknown[];
     GetSceneChanges(handle: number, sceneChangeIds: SceneChangeIds): void;
     GetSceneChangesCounts(handle: number, sceneChangeIds: SceneChangeIds): void;
@@ -418,13 +484,17 @@ declare interface MainModule {
     HasFeature(handle: number, sceneObjectId: number, feature: number): boolean;
     GetFeatureVersion(handle: number, sceneObjectId: number, feature: number): number;
     GetFeatureState(handle: number, sceneObjectId: number, feature: number): number;
+    GetAssetFormatVersion(handle: number, sceneObjectId: number): number;
+    GetDrMapLadderRoughnessLevels(handle: number, sceneObjectId: number): number[];
     SetClientSpatialFormat(handle: number, spatialFormat: SpatialFormat): { value: number };
     SetRuntimeSettings(handle: number, settings: RuntimeSettings): { value: number };
     TakeEvictedClientSideAttributeIds(handle: number): EmbindVector<bigint>;
     GetActiveClientSideIdsCheckSum(): number;
     TakeRenderRequired(handle: number): boolean;
+    BeginFrame(contextHandle: number, previousFrameTimeMs: number): number;
     modifiedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
     setMaxCacheSize(maxSizeBytes: number): void;
+    SetPreferSharkEncodingProfiles(prefer: boolean): void;
 }
 
 /**
@@ -461,13 +531,22 @@ export declare class Miris {
      * Why 43? Because the AVP throttles down to 45Hz :(
      */
     static readonly _XR_TARGET_FRAME_RATE = 43;
+    /* Excluded from this release type: _XR_SPLAT_COUNT_BUDGET */
+    /* Excluded from this release type: _SHARK_SPLAT_CAPACITY_MOBILE */
+    static readonly _SHARK_SPLAT_CAPACITY_DESKTOP: number;
+    /* Excluded from this release type: _SHARK_SPLAT_BUDGET_CAP_MOBILE */
+    static readonly _SHARK_SPLAT_BUDGET_CAP_DESKTOP = 2400000;
+    /* Excluded from this release type: _isMobileDevice */
+    /* Excluded from this release type: _sharkSplatCapacity */
+    /* Excluded from this release type: _limitSharkSplatCapacity */
+    /* Excluded from this release type: _sharkSplatBudgetCap */
     /* Excluded from this release type: _setTargetFrameRate */
     /* Excluded from this release type: _setXRModeActive */
     /* Excluded from this release type: _setSplatCountBudgetOverride */
     /* Excluded from this release type: _update */
     getLocalTransform(client: Client, sceneObjectId: number): Float32Array<ArrayBuffer> | undefined;
     getWorldTransform(client: Client, sceneObjectId: number): Float32Array<ArrayBuffer> | undefined;
-    update(): boolean;
+    /* Excluded from this release type: _updateForScene */
     applyChanges(_entries: Change[]): void;
     _computeAdditionalRenderNeeded(): boolean;
     onColorSpaceDetected(_isLinear: boolean): void;
@@ -496,6 +575,31 @@ export declare type ModelRootInit = {
     stream: Stream;
 };
 
+/**
+ * The byte-exact counterpart of getRawUint32Attribute above: same no-padding, no-takeAttribute
+ * contract, returning bytes rather than words.
+ *
+ * Use this rather than that one wherever the stride is not a whole number of words: the
+ * reflectance records' 18- and 26-byte strides are not, and an odd record count would lose that
+ * record's last field to dataPtrView's truncation.
+ */
+export declare type RawByteAttributeWithBounds = {
+    bytes: Uint8Array<ArrayBuffer>;
+    minValue: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    maxValue: {
+        x: number;
+        y: number;
+        z: number;
+    };
+};
+
+declare type ReadyState_2 = typeof HaveNothing | typeof HaveMetadata | typeof HaveData;
+export { ReadyState_2 as ReadyState }
+
 declare type RequestAnimationFrameFn = ((callback: FrameRequestCallback) => number) | ((callback: XRFrameRequestCallback) => void);
 
 declare interface RuntimeSettings extends EmbindObject {
@@ -504,6 +608,7 @@ declare interface RuntimeSettings extends EmbindObject {
     targetFramesPerSecond: number;
     xrModeActive: boolean;
     splatCountBudget: number;
+    splatCountBudgetCap: number;
 }
 
 export declare class Scene extends EventTarget {
@@ -515,6 +620,7 @@ export declare class Scene extends EventTarget {
     readonly id: number;
     get key(): unknown;
     set key(key: unknown);
+    /* Excluded from this release type: _assetFormat */
     get viewerKey(): string | null;
     set viewerKey(viewerKey: string | null);
     get streams(): Set<Stream>;
@@ -524,22 +630,35 @@ export declare class Scene extends EventTarget {
     readonly client: Client;
     readonly handle?: number;
     constructor({ miris, viewerKey }: SceneInit);
+    /**
+     * Drives a frame and answers whether *this* scene's canvas needs repainting. Call it once per
+     * displayed frame from the host's animation loop, and render when it returns true.
+     *
+     * Every scene on the page calls this from its own loop. The first call in a displayed frame
+     * drives one engine tick for all of them; the rest recognise the frame and reuse it.
+     *
+     * @param ts the host's frame timestamp. Optional - the document timeline supplies one, and it
+     *   reads the same for every scene in a displayed frame. Pass it when the host runs its own
+     *   clock, as an immersive XR session does, because XRFrame time is not the document timeline.
+     */
+    update(ts?: DOMHighResTimeStamp): boolean;
     dispose(): void;
-    /* Excluded from this release type: _getViewingVolumeObb */
     fetchAssets(tags?: string | Iterable<string>): Promise<{
         name: string;
         thumbnailUrl: string;
         uuid: string;
         tags: string[];
     }[]>;
-    getDefaultCameraTransform(): Float32Array<ArrayBuffer> | null | undefined;
     add(stream: Stream): void;
     getStreamForId(streamObjectId: number): Stream | undefined;
     getStreamForDescendentId(descendentObjectId: number): Stream | null;
     getModelRootForDescendentId(descendentObjectId: number): ModelRoot | null;
+    _recordAssetFormat(modelRoot: ModelRoot, formatVersion: number): void;
     /* Excluded from this release type: _getFeatureMesh */
     /* Excluded from this release type: _getDrMap */
+    /* Excluded from this release type: _onDrMapLadder */
     /* Excluded from this release type: _onFeatureData */
+    /* Excluded from this release type: _updateStreamStatuses */
     /* Excluded from this release type: _onSceneLoaded */
     delete(stream: Stream): void;
     close(): void;
@@ -629,6 +748,11 @@ export declare class Stream extends EventTarget {
     constructor(options: StreamInit);
     _initStream({ uuid }: StreamInit): void;
     /* Excluded from this release type: _onStreamLoaded */
+    getDefaultCameraTransform(): Float32Array<ArrayBuffer> | null | undefined;
+    /* Excluded from this release type: _getViewingVolumeObb */
+    /** How much of the stream has loaded, as of the last frame. */
+    get readyState(): ReadyState_2;
+    /* Excluded from this release type: _updateStatus */
     /* Excluded from this release type: _onRootLoaded */
     add(modelRoot: ModelRoot): void;
     end(): void;