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

    Type Alias WriteVoxelOptions

    Options for writing a voxel octree file.

    type WriteVoxelOptions = {
        collisionMesh?: boolean;
        createDevice?: DeviceCreator;
        dataTable: DataTable;
        filename: string;
        meshSimplifyError?: number;
        navCapsule?: { height: number; radius: number };
        navExteriorRadius?: number;
        navSeed?: NavSeed;
        opacityCutoff?: number;
        voxelResolution?: number;
    }
    Index

    Properties

    collisionMesh? createDevice? dataTable filename meshSimplifyError? navCapsule? navExteriorRadius? navSeed? opacityCutoff? voxelResolution?

    Properties

    collisionMesh?: boolean

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

    createDevice?: DeviceCreator

    Optional function to create a GPU device for voxelization

    dataTable: DataTable

    Gaussian splat data to voxelize

    filename: string

    Output filename ending in .voxel.json

    meshSimplifyError?: number

    Maximum geometric error for collision mesh simplification as a fraction of voxelResolution. Default: 0.08

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

    Capsule dimensions for navigation simplification. Height of 0 disables interior carve. When height > 0, only voxels contactable from the seed are kept.

    navExteriorRadius?: number

    Exterior fill radius in world units. Set to 0 to disable exterior fill. Defaults to 1.6 when nav simplification is active. Requires navSeed to be set; ignored without it.

    navSeed?: NavSeed

    Seed position in world space for navigation flood fill. Required when navCapsule is set with height > 0.

    opacityCutoff?: number

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

    voxelResolution?: number

    Size of each voxel in world units. Default: 0.05

    Settings

    Member Visibility

    On This Page

    Properties