@miris-inc/core 0.0.8-6ba4cfb → 0.0.8-6e08ae4

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://miris.com">
-    <img src="./banner.svg" alt="Miris" width="100%" />
+    <img src="https://cdn.jsdelivr.net/npm/@miris-inc/core/banner.svg" alt="Miris" width="100%" />
   </a>
 </p>
 

package/dist/core.d.ts

@@ -7,10 +7,36 @@ declare interface AttributeInfo extends EmbindObject {
     readonly maxValue: { x: number; y: number; z: number };
 }
 
+export declare class AttributeNames {
+    static readonly SPARK_PACKED_SPLAT: string;
+    static readonly SPARK_EXTENDED_SPLAT_LOW: string;
+    static readonly SPARK_EXTENDED_SPLAT_HIGH: string;
+    static readonly SPARK_PACKED_SH1: string;
+    static readonly SPARK_PACKED_SH2: string;
+    static readonly SPARK_PACKED_SH3: string;
+    static readonly SPARK_EXTENDED_SH1: string;
+    static readonly SPARK_EXTENDED_SH2: string;
+    static readonly SPARK_EXTENDED_SH3_A: string;
+    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;
+}
+
+declare type CachedAttribute = {
+    paddedData: Uint32Array<ArrayBuffer>;
+    originalSizeInUints: number;
+};
+
 export declare class Camera {
     #private;
     readonly id: number;
     update(): void;
+    get viewportHeight(): number;
+    set viewportHeight(viewportHeight: number);
     get aspect(): number;
     set aspect(aspect: number);
     get fov(): number;
@@ -24,7 +50,7 @@ export declare class Camera {
     readonly engine: Engine;
     readonly miris: Miris;
     readonly scene: Scene;
-    constructor({ aspect, fov, near, far, matrix, scene }: CameraInit);
+    constructor({ aspect, fov, near, far, matrix, scene, viewportHeight, }: CameraInit);
 }
 
 export declare type CameraInit = {
@@ -34,6 +60,7 @@ export declare type CameraInit = {
     far: number;
     matrix: Matrix4x4Tuple;
     scene: Scene;
+    viewportHeight?: number;
 };
 
 export declare class Change {
@@ -43,7 +70,7 @@ export declare class Change {
 }
 
 export declare type ChangeInit = {
-    type: "created" | "activated" | "modified" | "deactivated" | "deleted";
+    type: "created" | "activated" | "modified" | "deactivated" | "deleted" | "remasked";
     lod: Lod;
 };
 
@@ -60,6 +87,7 @@ declare class Client {
     getAssetsAsync(...args: ClientMethodParameters["getAssetsAsync"]): AssetInfo[];
     getAttribute(...args: ClientMethodParameters["getAttribute"]): AquaStatus;
     getDefaultCameraId(...args: ClientMethodParameters["getDefaultCameraId"]): number;
+    getViewingVolumeId(...args: ClientMethodParameters["getViewingVolumeId"]): number;
     getLocalBoundingBox(...args: ClientMethodParameters["getLocalBoundingBox"]): AquaStatus;
     getWorldBoundingBox(...args: ClientMethodParameters["getWorldBoundingBox"]): AquaStatus;
     getLodIndex(...args: ClientMethodParameters["getLodIndex"]): number;
@@ -68,6 +96,7 @@ declare class Client {
     getSceneMetadata(...args: ClientMethodParameters["getSceneMetadata"]): number;
     getSceneObjectParent(...args: ClientMethodParameters["getSceneObjectParent"]): number;
     getSceneObjectType(...args: ClientMethodParameters["getSceneObjectType"]): SceneObjectType;
+    getDrawnOctantMask(...args: ClientMethodParameters["getDrawnOctantMask"]): number;
     getLocalTransform(...args: ClientMethodParameters["getLocalTransform"]): AquaStatus;
     getWorldTransform(...args: ClientMethodParameters["getWorldTransform"]): AquaStatus;
     hasAttribute(...args: ClientMethodParameters["hasAttribute"]): boolean;
@@ -139,6 +168,8 @@ declare class Engine {
     };
     static Feature: {
         readonly DrMap: 0;
+        readonly ReflMesh: 1;
+        readonly GlassMesh: 2;
     };
     static FeatureState: {
         readonly NotLoaded: 0;
@@ -186,6 +217,8 @@ declare class Engine {
     deletedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
     dataPtrView(...args: [attributeInfo: AttributeInfo]): Uint32Array;
     deactivatedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
+    remaskedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
+    getDrawnOctantMask(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
     destroyClient(...args: [handle: AquaClientHandle]): AquaStatus;
     free(...args: [size: number]): number;
     getAssetsAsync(...args: [handle: AquaClientHandle, tags: StringVector]): AssetInfo[];
@@ -196,6 +229,7 @@ declare class Engine {
     attributeInfo: AttributeInfo
     ]): AquaStatus;
     getDefaultCameraId(...args: [handle: AquaClientHandle]): number;
+    getViewingVolumeId(...args: [handle: AquaClientHandle]): 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;
@@ -244,19 +278,18 @@ declare class Engine {
     removeStream(...args: [handle: AquaClientHandle, streamObjectId: number]): boolean;
     setAssetViewerKey(...args: [handle: AquaClientHandle, key: string]): AquaStatus;
     setClientSpatialFormat(...args: [handle: AquaClientHandle, spatialFormat: SpatialFormat]): AquaStatus;
-    setRuntimeSettings(...args: [
-    handle: AquaClientHandle,
-    settings: RuntimeSettings
-    ]): AquaStatus;
+    setRuntimeSettings(...args: [handle: AquaClientHandle, settings: RuntimeSettings]): AquaStatus;
     setMainCameraTransform(...args: [handle: AquaClientHandle, cameraTransform: number]): AquaStatus;
     setMainCameraViewFrustum(...args: [
     handle: AquaClientHandle,
     aspectRatio: number,
     verticalFov: number,
     nearPlane: number,
-    farPlane: number
+    farPlane: number,
+    viewportHeightPixels: number
     ]): AquaStatus;
     setMaxCacheSize(...args: [maxSizeBytes: number]): void;
+    setPreferSharkEncodingProfiles(...args: [preferShark: boolean]): void;
     setSceneObjectTransform(...args: [
     handle: AquaClientHandle,
     sceneObjectId: number,
@@ -265,14 +298,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;
-    getName(...args: [
-    handle: AquaClientHandle,
-    sceneObjectId: number
-    ]): string;
-    setVariantSelection(...args: [
-    handle: AquaClientHandle,
-    sceneObjectId: number
-    ]): AquaStatus;
+    getName(...args: [handle: AquaClientHandle, sceneObjectId: number]): string;
+    setVariantSelection(...args: [handle: AquaClientHandle, sceneObjectId: number]): AquaStatus;
     takeAttribute(...args: [
     handle: AquaClientHandle,
     sceneObjectId: number,
@@ -282,11 +309,16 @@ declare class Engine {
     takeEvictedClientSideAttributeIds(...args: [handle: AquaClientHandle]): EmbindVector<bigint>;
     getActiveClientSideIdsCheckSum(): number;
     unlockScene(...args: [handle: AquaClientHandle]): boolean;
-    updateSceneExecution(...args: [
-    handle: AquaClientHandle,
-    firstInSequence: boolean
-    ]): AquaStatus;
+    updateSceneExecution(...args: [handle: AquaClientHandle]): 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;
@@ -304,41 +336,46 @@ export declare class Lod {
     #private;
     readonly id: LodInit["id"];
     readonly store: LodStore;
-    useExtSplats: boolean;
-    splatsExtendedData: Uint32Array<ArrayBuffer> | null;
-    sh1Data: Uint32Array<ArrayBuffer> | null;
-    sh1Max: number;
-    sh2Data: Uint32Array<ArrayBuffer> | null;
-    sh2Max: number;
-    sh3Data: Uint32Array<ArrayBuffer> | null;
-    sh3Max: number;
-    sh3ExtendedData: Uint32Array<ArrayBuffer> | null;
     get key(): unknown;
     set key(key: unknown);
     readonly modelRoot: ModelRoot;
-    set splats(splats: Uint32Array<ArrayBuffer> | null);
-    get splats(): Uint32Array<ArrayBuffer> | null;
     set bounds(bounds: Float32Array<ArrayBuffer> | null);
+    /**
+     * Retrieves the cached world bounds of this object
+     *
+     * @deprecated Retrieve the local bounds and transform as needed
+     */
     get bounds(): Float32Array<ArrayBuffer> | null;
-    /* Excluded from this release type: _boundsStreamSpace */
-    /* Excluded from this release type: _boundsStreamSpace */
+    /**
+     * Sets the local bounds of this lod
+     */
+    set localBounds(bounds: Float32Array<ArrayBuffer> | null);
+    /**
+     * Retrieves the local bounds of this lod
+     */
+    get localBounds(): Float32Array<ArrayBuffer> | null;
     set lodIndex(index: number);
     get lodIndex(): number | null;
-    set paddingCount(count: number);
-    get paddingCount(): number;
+    set paddingSplatsCount(count: number);
+    get paddingSplatsCount(): number;
     set transform(transform: Float32Array<ArrayBuffer> | null);
     get transform(): Float32Array<ArrayBuffer> | null;
-    setSh1(sh1Data: Uint32Array<ArrayBuffer>, sh1Max: number): void;
-    setSh2(sh2Data: Uint32Array<ArrayBuffer>, sh2Max: number): void;
-    setSh3(sh3Data: Uint32Array<ArrayBuffer>, sh3Max: number): void;
+    get _drawnOctantMask(): number;
+    set _drawnOctantMask(mask: number);
+    get _octantOffsets(): Uint32Array<ArrayBuffer> | null;
+    get _hasOctantOffsets(): boolean;
+    _readOctantOffsets(engine: Engine): void;
+    hasAttribute(attributeName: string): boolean;
+    getDataFromAttribute(engine: Engine, attributeName: string, attributeInfo: AttributeInfo): CachedAttribute | null;
     dispose(): void;
-    constructor({ id, modelRoot, lodStore }: LodInit);
+    constructor({ id, modelRoot, lodStore, client }: LodInit);
 }
 
 export declare type LodInit = {
     id: number;
     modelRoot: ModelRoot;
     lodStore: LodStore;
+    client: Client;
 };
 
 export declare class LodStore {
@@ -379,7 +416,9 @@ declare interface MainModule {
     createdObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
     dataPtrView(attributeInfo: AttributeInfo): Uint32Array;
     deactivatedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
+    remaskedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
     deletedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
+    GetDrawnOctantMask(handle: number, sceneObjectId: number): number;
     GetAssetsAsync(handle: number, tags: StringVector): unknown[];
     GetSceneChanges(handle: number, sceneChangeIds: SceneChangeIds): void;
     GetSceneChangesCounts(handle: number, sceneChangeIds: SceneChangeIds): void;
@@ -393,8 +432,10 @@ declare interface MainModule {
     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;
 }
 
 /**
@@ -407,6 +448,7 @@ declare interface MainModule {
  */
 export declare class Miris {
     #private;
+    static tryUseShark: boolean;
     static _instance: Miris;
     static instance<T extends typeof Miris>(this: T): Promise<InstanceType<T>>;
     readonly engine: Engine;
@@ -416,14 +458,28 @@ export declare class Miris {
     get viewerKey(): string | null | undefined;
     set viewerKey(viewerKey: string | null | undefined);
     get scenes(): Set<Scene>;
+    get useSphericalHarmonics(): boolean;
+    set useSphericalHarmonics(value: boolean);
     constructor();
     dispose(): void;
     updateParentedTransform(_modelTransform: Float32Array<ArrayBuffer>, _parentTransform: Float32Array<ArrayBuffer>): Float32Array<ArrayBuffer> | undefined;
+    protected _xrModeActive: boolean;
+    protected _xrSession: XRSession | null;
+    protected _requestAnimationFrame: RequestAnimationFrameFn | null;
+    signalResumeFromIdle(): void;
+    get _splatCountBudget(): number;
+    /**
+     * 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: _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;
@@ -452,11 +508,14 @@ export declare type ModelRootInit = {
     stream: Stream;
 };
 
+declare type RequestAnimationFrameFn = ((callback: FrameRequestCallback) => number) | ((callback: XRFrameRequestCallback) => void);
+
 declare interface RuntimeSettings extends EmbindObject {
     maxBandwidthBitsPerSecond: number;
     maxConcurrentRequests: number;
     targetFramesPerSecond: number;
     xrModeActive: boolean;
+    splatCountBudget: number;
 }
 
 export declare class Scene extends EventTarget {
@@ -477,7 +536,20 @@ 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;
@@ -489,6 +561,7 @@ export declare class Scene extends EventTarget {
     getStreamForId(streamObjectId: number): Stream | undefined;
     getStreamForDescendentId(descendentObjectId: number): Stream | null;
     getModelRootForDescendentId(descendentObjectId: number): ModelRoot | null;
+    /* Excluded from this release type: _getFeatureMesh */
     /* Excluded from this release type: _getDrMap */
     /* Excluded from this release type: _onFeatureData */
     /* Excluded from this release type: _onSceneLoaded */
@@ -502,6 +575,7 @@ declare interface SceneChangeIds extends EmbindObject {
     readonly modifiedObjectsCount: number;
     readonly deactivatedObjectsCount: number;
     readonly deletedObjectsCount: number;
+    readonly remaskedObjectsCount: number;
 }
 
 export declare type SceneInit = {
@@ -513,6 +587,13 @@ declare interface SceneMetadata extends EmbindObject {
     readonly inputColorSpace: string;
 }
 
+declare type SparkAttributeInfo = {
+    elementsPerSplat: number;
+    discard: boolean;
+};
+
+export declare const sparkAttributeList: Record<string, SparkAttributeInfo>;
+
 declare interface SpatialFormat extends EmbindObject {
     metersPerUnit: number;
     upAxis: number;
@@ -540,6 +621,8 @@ export declare class Stream extends EventTarget {
     set key(key: unknown);
     get matrix(): Matrix4x4Tuple;
     set matrix(matrix: Matrix4x4Tuple);
+    get opacity(): number;
+    set opacity(opacity: number);
     get boundingBox(): {
         min: {
             x: number;