Skip to main content

Editor.GaussianSplatting.GsafImporterSettings

Class

Configuration entity controlling how PLY files are compressed and packed into a GSAF asset by createGsafFromPlyFiles.

Index

Extends

Properties

advancedSettings

advancedSettings: boolean

When true, the per-attribute bit-depth fields are honored; when false, the compressionProfile preset determines bit depths.


bitsCenter

bitsCenter: number

Number of bits used to encode each splat's center position.


bitsColor

bitsColor: number

Number of bits used to encode each splat's color.


bitsDeltaPos

bitsDeltaPos: number

Number of bits used to encode per-frame position deltas between key frames.


bitsDeltaRot

bitsDeltaRot: number

Number of bits used to encode per-frame rotation deltas between key frames.


bitsRotation

bitsRotation: number

Number of bits used to encode each splat's packed rotation quaternion.


bitsScale

bitsScale: number

Number of bits used to encode each splat's scale.


compressionProfile

compressionProfile: GsCompressionProfile

Preset compression profile that selects default bit depths and quantization when advancedSettings is disabled.


crisp

crisp: boolean


groupOfPictures

groupOfPictures: boolean

Whether frames are encoded in groups of pictures to exploit temporal coherence between successive frames.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Entity.id


keyFrameInterval

keyFrameInterval: number

Number of frames between full key frames in the encoded sequence.


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

Entity.meta


minimumOpacity

minimumOpacity: number

Splats with opacity below this threshold are discarded during import.


numFrames

readonly numFrames: number

Number of frames detected in the PLY input sequence.


preserveOrder

preserveOrder: boolean

Whether the original splat order from the PLY input is preserved instead of being reordered for better compression.


quatPackingMethod

quatPackingMethod: GsQuatPackingMethod

Method used to pack splat rotation quaternions when encoding the asset.


type

readonly type: string

The entity's type.

Inherited from

Entity.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Entity.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Entity.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Entity.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Entity.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Entity.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Entity.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Entity.isSame