splat-transform API Reference - v1.10.1
    Preparing search index...

    Type Alias Options

    Options for read/write operations.

    type Options = {
        collisionMesh?: boolean;
        iterations: number;
        lodChunkCount: number;
        lodChunkExtent: number;
        lodSelect: number[];
        meshSimplify?: number;
        navCapsule?: { height: number; radius: number };
        navSeed?: { x: number; y: number; z: number };
        navSimplify?: boolean;
        opacityCutoff?: number;
        unbundled: boolean;
        viewerSettingsJson?: any;
        voxelResolution?: number;
    }
    Index

    Properties

    collisionMesh? iterations lodChunkCount lodChunkExtent lodSelect meshSimplify? navCapsule? navSeed? navSimplify? opacityCutoff? unbundled viewerSettingsJson? voxelResolution?

    Properties

    collisionMesh?: boolean

    Whether to generate a collision mesh (.collision.glb) alongside voxel output. Default: false

    iterations: number

    Number of iterations for SOG SH compression (higher = better quality). Default: 10

    lodChunkCount: number

    Approximate number of Gaussians per LOD chunk (in thousands). Default: 512

    lodChunkExtent: number

    Approximate size of an LOD chunk in world units (meters). Default: 16

    lodSelect: number[]

    LOD levels to read from LCC input

    meshSimplify?: number

    Ratio of triangles to keep when simplifying the collision mesh (0-1). Default: 0.25

    navCapsule?: { height: number; radius: number }

    Capsule dimensions (height, radius) for navigation simplification. Default: { height: 1.6, radius: 0.2 }

    navSeed?: { x: number; y: number; z: number }

    Seed position in world space for navigation flood fill. Default: { x: 0, y: 0, z: 0 }

    navSimplify?: boolean

    Enable navigation simplification with default capsule (height 1.6, radius 0.2) and seed (0,0,0). Default: true (set to false to disable).

    opacityCutoff?: number

    Opacity threshold for solid voxels - voxels below this are considered empty. Default: 0.5

    unbundled: boolean

    Whether to generate unbundled HTML output with separate files

    viewerSettingsJson?: any

    Viewer settings JSON for HTML output

    voxelResolution?: number

    Size of each voxel in world units for voxel output. Default: 0.05

    Settings

    Member Visibility

    On This Page

    Properties