Class GaussianSplattingDebugger
Constructors
constructor
-
Returns GaussianSplattingDebugger
Accessors
clipping Box
opacity Culling
opacity Saturate
-
get opacitySaturate(): boolean
When true, replaces the Gaussian spatial falloff with a flat uniform opacity, showing each splat as a solid disk.
Returns boolean
-
set opacitySaturate(value: boolean): void
Parameters
- value: boolean
Returns void
opacity Scale
-
get opacityScale(): number
Scalar multiplier applied to every splat's opacity. 1.0 = no change.
Returns number
-
set opacityScale(value: number): void
Parameters
- value: number
Returns void
sh Dc
-
get shDc(): boolean
Include the DC (base) color from colorsTexture. Default: true.
Returns boolean
-
set shDc(value: boolean): void
Parameters
- value: boolean
Returns void
sh Order1
-
get shOrder1(): boolean
Include SH band 1 contribution. Default: true.
Returns boolean
-
set shOrder1(value: boolean): void
Parameters
- value: boolean
Returns void
sh Order2
-
get shOrder2(): boolean
Include SH band 2 contribution. Default: true.
Returns boolean
-
set shOrder2(value: boolean): void
Parameters
- value: boolean
Returns void
sh Order3
-
get shOrder3(): boolean
Include SH band 3 contribution. Default: true.
Returns boolean
-
set shOrder3(value: boolean): void
Parameters
- value: boolean
Returns void
sh Order4
-
get shOrder4(): boolean
Include SH band 4 contribution. Default: true.
Returns boolean
-
set shOrder4(value: boolean): void
Parameters
- value: boolean
Returns void
size Culling
-
Size culling range. Size is pow(|det(Σ)|, 1/6) of the 3D covariance matrix, equal to the geometric mean of the principal radii. Splats outside this range are not rendered. Use GaussianSplattingDebugger.GetSplatSizeRange(mesh) to find an asset's range. Set to null to disable.
Returns Nullable<{ max: number; min: number }>
-
Parameters
- value: Nullable<{ max: number; min: number }>
Returns void
Methods
add Mesh
-
Adds a mesh to the debugger, attaching a debug plugin to its material. The mesh must already have a GaussianSplattingMaterial assigned (i.e., data must have been loaded at least once). Current option values are applied immediately. The mesh is automatically unregistered if it is disposed.
Parameters
- mesh: GaussianSplattingMeshBase
The mesh to register.
Returns void
- mesh: GaussianSplattingMeshBase
clear Part Options
-
Clears all per-part debug overrides for a specific part, falling back to global settings.
Parameters
- mesh: GaussianSplattingMeshBase
The compound mesh.
- partIndex: number
The zero-based part index.
Returns void
- mesh: GaussianSplattingMeshBase
dispose
-
Disposes all debug plugins and clears the mesh list.
Returns void
remove Mesh
-
Removes a mesh and disposes its debug plugin.
Parameters
- mesh: GaussianSplattingMeshBase
The mesh to unregister.
Returns void
- mesh: GaussianSplattingMeshBase
set Part Options
-
setPartOptions(
mesh: GaussianSplattingMeshBase,
partIndex: number,
options: Partial<IGaussianSplattingDebugOptions>,
): voidSets per-part debug overrides for a specific part of a compound mesh. The mesh must already be registered via addMesh(). Logs an error if the mesh is not compound (partCount is 0).
Parameters
- mesh: GaussianSplattingMeshBase
The compound mesh.
- partIndex: number
The zero-based part index.
- options: Partial<IGaussianSplattingDebugOptions>
Partial set of debug options to override for this part.
Returns void
- mesh: GaussianSplattingMeshBase
StaticGet Splat Size Range
-
Returns the min/max size range of splats in a mesh. Convenience wrapper for GaussianSplattingMeshBase.splatSizeRange.
Parameters
- mesh: GaussianSplattingMeshBase
The mesh to query.
Returns Nullable<{ max: number; min: number }>
the splat size range, or null if not yet computed.
- mesh: GaussianSplattingMeshBase
Manages debug rendering options across a set of Gaussian splat meshes. Create one instance, add meshes via addMesh(), then set options to apply them to every registered mesh simultaneously.
All options default to their "off" states so there is no rendering cost until a feature is explicitly enabled.
Example