Skip to main content

Editor.GaussianSplatting

Class

Namespace providing utilities to create and import Gaussian splatting (GSAF) assets from PLY input files.

Index

Methods

createGsafFromPlyFiles()

static createGsafFromPlyFiles(inputFiles, outputPath, settings): Promise<GsafCreationInfo>

Asynchronously converts the ordered list of PLY input files into a GSAF asset at the given output path using the provided importer settings, resolving with metadata describing the result.

Parameters

ParameterType
inputFilesPath[]
outputPathPath
settingsGsafImporterSettings

Returns

Promise<GsafCreationInfo>


createGsafImporterSettings()

static createGsafImporterSettings(scene): GsafImporterSettings

Creates a new GsafImporterSettings entity initialized with defaults for the given scene, ready to be passed to createGsafFromPlyFiles.

Parameters

ParameterType
sceneScene

Returns

GsafImporterSettings


createImporterSettings()

static createImporterSettings(scene): GaussianSplattingImporterSettings

Parameters

ParameterType
sceneScene

Returns

GaussianSplattingImporterSettings

Nested types

Enumerations

EnumerationDescription
GsCompressionProfileEnum of preset compression profiles consumed by GsafImporterSettings.compressionProfile, trading file size against visual quality.
GsQuatPackingMethodEnum selecting how splat rotation quaternions are packed when encoding a GSAF asset, consumed by GsafImporterSettings.quatPackingMethod.

Classes

ClassDescription
GaussianSplattingImporterSettingsEntity subclass representing the structural organization of entities within a scene.
GsafCreationInfoRead-only metadata returned by createGsafFromPlyFiles describing the bit rate and quantization characteristics of the resulting GSAF asset.
GsafImporterSettingsConfiguration entity controlling how PLY files are compressed and packed into a GSAF asset by createGsafFromPlyFiles.