@miris-inc/core 0.0.8-605dd07 → 0.0.8-628ad08

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 };
 }
 
@@ -24,6 +32,12 @@ export declare class AttributeNames {
     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 REFLECTANCE_DATA_V1: string;
+    static readonly GLASS_MESH_GEOMETRY: string;
+    static readonly GLASS_MESH_PANELS: string;
+    static readonly MOD_DEPTH: string;
 }
 
 declare type CachedAttribute = {
@@ -112,6 +126,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;
@@ -182,6 +198,10 @@ declare class Engine {
     get module(): MainModule;
     constructor(moduleOptions?: Record<string, unknown>);
     get AttributeInfo(): new () => AttributeInfo;
+    get CompressionType(): {
+        SHARK_ELLIPSOID_COMPRESSED: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE: unknown;
+    };
     get Handedness(): {
         Right: number;
         Left: number;
@@ -228,8 +248,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;
@@ -298,6 +318,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: [
@@ -364,9 +386,13 @@ export declare class Lod {
     set _drawnOctantMask(mask: number);
     get _octantOffsets(): Uint32Array<ArrayBuffer> | null;
     get _hasOctantOffsets(): boolean;
+    get _surfelOctantOffsets(): Uint32Array<ArrayBuffer> | null;
+    get _surfelCount(): number;
     _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);
 }
@@ -391,6 +417,10 @@ export declare class LodStore {
 
 declare interface MainModule {
     AttributeInfo: new () => AttributeInfo;
+    CompressionType: {
+        SHARK_ELLIPSOID_COMPRESSED: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE: unknown;
+    };
     Handedness: { Right: number; Left: number };
     HEAPF32: Float32Array<ArrayBuffer>;
     HEAPU8: Uint8Array<ArrayBuffer>;
@@ -427,6 +457,8 @@ 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>;
@@ -473,6 +505,13 @@ export declare class Miris {
      */
     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 = 3000000;
+    /* Excluded from this release type: _SHARK_SPLAT_BUDGET_CAP_MOBILE */
+    static readonly _SHARK_SPLAT_BUDGET_CAP_DESKTOP = 2500000;
+    /* Excluded from this release type: _isMobileDevice */
+    /* Excluded from this release type: _sharkSplatCapacity */
+    /* Excluded from this release type: _sharkSplatBudgetCap */
     /* Excluded from this release type: _setTargetFrameRate */
     /* Excluded from this release type: _setXRModeActive */
     /* Excluded from this release type: _setSplatCountBudgetOverride */
@@ -508,6 +547,28 @@ 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:
+ * reflectanceDataV1's 26-byte record is 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 RequestAnimationFrameFn = ((callback: FrameRequestCallback) => number) | ((callback: XRFrameRequestCallback) => void);
 
 declare interface RuntimeSettings extends EmbindObject {
@@ -516,6 +577,7 @@ declare interface RuntimeSettings extends EmbindObject {
     targetFramesPerSecond: number;
     xrModeActive: boolean;
     splatCountBudget: number;
+    splatCountBudgetCap: number;
 }
 
 export declare class Scene extends EventTarget {
@@ -527,6 +589,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>;
@@ -549,20 +612,20 @@ export declare class Scene extends EventTarget {
      */
     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: _onSceneLoaded */
     delete(stream: Stream): void;
@@ -653,6 +716,8 @@ 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 */
     /* Excluded from this release type: _onRootLoaded */
     add(modelRoot: ModelRoot): void;
     end(): void;