GaussianSplat

GaussianSplat is an object representing a cloud of gaussians, soft ellipsoids representing a detailed picture of a model or entire 3D scene.

Gaussian splats do not cast shadows, setting castShadow = true will have no effect.

Constructor

GaussianSplat(splatGeometry : Geometry, material : Material, parameters : Object)

• splatGeometry — a geometry instance that must containt position (vec3), covariance (6 floats), color (RGBA, normalized), and optional sphericalHarmonics1/sphericalHarmonics2/sphericalHarmonics3 attributes.
• material — an instance of GaussianSplatMaterial.
• parameters — (optional) parameters object, currently contains only one parameter autoSort (true by default).

Creates a new GaussianSplat.

Properties

See the base Object3D class for inherited properties.

# .isGaussianSplat : Boolean

Read-only flag to check if a given object is of type GaussianSplat.

# .material : GaussianSplatMaterial

An instance of GaussianSplatMaterial, defining the appearance of the gaussians.

# .splatGeometry : Geometry

A geometry representing gaussians.

Methods

See the base Object3D class for inherited methods.

# .clone() → GaussianSplat

Returns a clone of this GaussianSplat object and any descendants.

# .copy(gaussianSplat : GaussianSplat) → this

Copies the properties of the passed gaussianSplat to this one.

# .raycast(raycaster : Raycaster, intersects : Array)

Get intersections between a casted ray and the cloud of gaussians. Raycaster.intersectObject() will call this method. The raycaster must be initialized by calling Raycaster.setFromCamera() before raycasting against gaussians.

# .updateSort(camera : Camera) → Boolean

Performs a transparency sorting of the gaussians from back to front. Returns true if the actual sorting was done (camera moved enough distance) or false if sorting is not necessary.

Source

For more info on how to obtain the source code of this module see this page.