splat-transform API Reference - v2.0.5
    Preparing search index...

    Type Alias Options

    Options for read/write operations.

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

    Properties

    collisionMesh? floorFill? floorFillDilation? iterations lodChunkCount lodChunkExtent lodSelect navCapsule? navExteriorRadius? navSeed? opacityCutoff? unbundled viewerSettingsJson? voxelResolution?

    Properties

    collisionMesh?: boolean | CollisionMeshShape

    When set, a collision mesh (.collision.glb) is generated alongside the voxel output. true is equivalent to smooth.

    floorFill?: boolean

    Fill each voxel column upward from the bottom until hitting solid. Runs before carve. Default: false

    floorFillDilation?: number

    When floorFill is enabled, dilation radius in world units used to identify "interior" XZ columns to patch. Empty XZ areas larger than 2 * floorFillDilation from any solid column are treated as exterior and left empty. Default: 0 (patch every empty column).

    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

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

    Capsule dimensions for carve. Height of 0 disables carve. Requires navSeed.

    navExteriorRadius?: number

    Exterior fill radius in world units. Enables exterior fill when set. Requires navSeed.

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

    Seed position in world space for exterior fill and carve flood fill.

    opacityCutoff?: number

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

    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