@miris-inc/core 0.0.8-c5df0f3 → 0.0.8-c61ee8d

package/dist/core.d.ts

@@ -4,11 +4,14 @@ export declare const AssetFormat: {
 };
 
 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 };
 }
 
@@ -29,6 +32,15 @@ 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 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 = {
@@ -101,6 +113,7 @@ 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;
     getLocalTransform(...args: ClientMethodParameters["getLocalTransform"]): AquaStatus;
     getWorldTransform(...args: ClientMethodParameters["getWorldTransform"]): AquaStatus;
@@ -118,6 +131,7 @@ declare class Client {
     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;
@@ -183,11 +197,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;
@@ -243,6 +269,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,
@@ -304,6 +331,7 @@ 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;
@@ -339,6 +367,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"];
@@ -371,9 +405,15 @@ export declare class Lod {
     set _drawnOctantMask(mask: number);
     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);
 }
@@ -398,6 +438,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>;
@@ -435,6 +480,7 @@ declare interface MainModule {
     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>;
@@ -487,6 +533,7 @@ export declare class Miris {
     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: _limitSharkSplatCapacity */
     /* Excluded from this release type: _sharkSplatBudgetCap */
     /* Excluded from this release type: _setTargetFrameRate */
     /* Excluded from this release type: _setXRModeActive */
@@ -523,6 +570,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 {
@@ -579,7 +651,9 @@ export declare class Scene extends EventTarget {
     _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;
@@ -671,6 +745,9 @@ export declare class Stream extends EventTarget {
     /* 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;