Interface XGFStreamingRuntimeIndex

Compact runtime index for an XGF stream dataset.

This representation minimizes repeated JSON property names in large stream indexes. Decode it with readXGFStreamingRuntimeIndex before passing it to loaders or view controllers.

interface XGFStreamingRuntimeIndex {
    aabb?: number[];
    coordinateSystem?: Record<string, any>;
    counts?: [
        "transforms",
        "geometries",
        "materials",
        "textures",
        "meshes",
        "objects",
    ];
    format: "XGFStreamingRuntimeIndex";
    indexVersion: "1.0.0"
    | "1.1.0"
    | "1.2.0";
    metadata?: Record<string, any>;
    roles?: ["full", "assetLibrary", "referencesOnly"];
    root?: (string | number)[];
    strings?: string[];
}

Properties

aabb?: number[]

Aggregate stream AABB.

coordinateSystem?: Record<string, any>

Optional coordinate system for the stream's chunk coordinates.

counts?: [
    "transforms",
    "geometries",
    "materials",
    "textures",
    "meshes",
    "objects",
]

Count lookup table used by compact chunk tuples.

format: "XGFStreamingRuntimeIndex"

Runtime index format identifier.

indexVersion: "1.0.0" | "1.1.0" | "1.2.0"

Runtime index schema version.

metadata?: Record<string, any>

Optional application metadata copied through unchanged.

roles?: ["full", "assetLibrary", "referencesOnly"]

Role lookup table used by compact chunk tuples.

root?: (string | number)[]

IDs of primary scene-content chunks.

strings?: string[]

String lookup table used by runtime index v1.1.