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

    Type Alias WriteVoxelOptions

    Options for writing a voxel octree file.

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

    Properties

    collisionMesh? createDevice? dataTable filename meshSimplify? navCapsule? 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

    meshSimplify?: number

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

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

    Capsule dimensions for navigation simplification. When set, only voxels contactable from the seed are kept.

    navSeed?: NavSeed

    Seed position in world space for navigation flood fill. Required when navCapsule is set.

    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