splat-transform API Reference - v2.4.0
    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;
        renderBackground?: { a: number; b: number; g: number; r: number };
        renderCameraEndPosition?: { x: number; y: number; z: number };
        renderCameraPosition?: { x: number; y: number; z: number };
        renderFocusDistance?: number;
        renderFov?: number;
        renderFStop?: number;
        renderHeight?: number;
        renderLookAt?: { x: number; y: number; z: number };
        renderLookAtEnd?: { x: number; y: number; z: number };
        renderMotionSamples?: number;
        renderNear?: number;
        renderProjection?: "pinhole" | "equirect";
        renderSensorSize?: number;
        renderShutter?: number;
        renderUp?: { x: number; y: number; z: number };
        renderUpEnd?: { x: number; y: number; z: number };
        renderWidth?: number;
        spzVersion?: 3 | 4;
        unbundled: boolean;
        viewerSettingsJson?: any;
        voxelResolution?: number;
    }
    Index

    Properties

    collisionMesh? floorFill? floorFillDilation? iterations lodChunkCount lodChunkExtent lodSelect navCapsule? navExteriorRadius? navSeed? opacityCutoff? renderBackground? renderCameraEndPosition? renderCameraPosition? renderFocusDistance? renderFov? renderFStop? renderHeight? renderLookAt? renderLookAtEnd? renderMotionSamples? renderNear? renderProjection? renderSensorSize? renderShutter? renderUp? renderUpEnd? renderWidth? spzVersion? 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

    renderBackground?: { a: number; b: number; g: number; r: number }

    RGBA background (each channel in [0, 1]) for image output. Default: (0, 0, 0, 1).

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

    End camera position for motion blur. When set, enables camera motion blur: the renderer averages multiple sub-frames with the camera interpolated between renderCameraPosition (shutter open) and renderCameraEndPosition (shutter close).

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

    Camera position (world space) for image output. Default: (2, 1, -2).

    renderFocusDistance?: number

    Camera-space Z of the focus plane in world units for image output. Defaults to the distance from the camera to the look-at point when renderFStop is set. No effect without renderFStop. Pinhole projection only.

    renderFov?: number

    Vertical field of view in degrees for image output. Default: 60.

    renderFStop?: number

    Aperture as a photographic f-stop (e.g. 2.8, 5.6, 11) for image output. Enables defocus blur / depth-of-field: smaller numbers = stronger blur. Defaults to disabled. Pinhole projection only.

    renderHeight?: number

    Output image height in pixels. Default: 720.

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

    Camera look-at target (world space) for image output. Default: (0, 0, 0).

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

    End look-at target for motion blur. Defaults to renderLookAt when motion blur is enabled. Only meaningful with renderCameraEndPosition.

    renderMotionSamples?: number

    Number of sub-frames to accumulate for motion blur. More samples = smoother streaks at proportionally higher cost. Default: 16. No effect without renderCameraEndPosition.

    renderNear?: number

    Near clip distance for image output. Default: 0.2.

    renderProjection?: "pinhole" | "equirect"

    Camera projection for image output: 'pinhole' (default) or 'equirect' (360°×180° panorama).

    renderSensorSize?: number

    Vertical sensor height in world units. Calibrates renderFStop to your world scale. Default 0.024 (35mm full-frame in meters). No effect without renderFStop. Pinhole projection only.

    renderShutter?: number

    Shutter fraction in [0, 1]. Controls what portion of the start→end camera segment is integrated, centered on the midpoint (standard shutter-angle convention: 1.0 = full motion, 0.5 = 180° shutter). Default: 1. No effect without renderCameraEndPosition.

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

    World-space up vector for image output. Default: (0, 1, 0).

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

    End up vector for motion blur. Defaults to renderUp when motion blur is enabled. Only meaningful with renderCameraEndPosition.

    renderWidth?: number

    Output image width in pixels. Default: 1280.

    spzVersion?: 3 | 4

    SPZ format version to write. Default: 4.

    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