@playcanvas/splat-transform 1.8.3 → 1.9.1

package/dist/lib/data-table/decimate.d.ts

@@ -0,0 +1,14 @@
+import { DataTable } from './data-table';
+declare const sortByVisibility: (dataTable: DataTable, indices: Uint32Array) => void;
+/**
+ * Simplifies a Gaussian splat DataTable to a target number of splats using the
+ * NanoGS progressive pairwise merging algorithm.
+ *
+ * Reference: "NanoGS: Training-Free Gaussian Splat Simplification" (Xiong et al.)
+ *
+ * @param dataTable - The input splat DataTable.
+ * @param targetCount - The desired number of output splats.
+ * @returns A new DataTable with approximately `targetCount` splats.
+ */
+declare const simplifyGaussians: (dataTable: DataTable, targetCount: number) => DataTable;
+export { sortByVisibility, simplifyGaussians };

package/dist/lib/index.d.cts

@@ -5,13 +5,13 @@ export { transform } from './data-table/transform';
 export { computeSummary } from './data-table/summary';
 export type { ColumnStats, SummaryData } from './data-table/summary';
 export { sortMortonOrder } from './data-table/morton-order';
-export { sortByVisibility } from './data-table/filter-visibility';
+export { sortByVisibility, simplifyGaussians } from './data-table/decimate';
 export { readFile, getInputFormat } from './read';
 export type { InputFormat, ReadFileOptions } from './read';
 export { writeFile, getOutputFormat } from './write';
 export type { OutputFormat, WriteOptions } from './write';
 export { processDataTable } from './process';
-export type { ProcessAction, Translate, Rotate, Scale, FilterNaN, FilterByValue, FilterBands, FilterBox, FilterSphere, Param as ProcessParam, Lod, Summary, MortonOrder, FilterVisibility } from './process';
+export type { ProcessAction, Translate, Rotate, Scale, FilterNaN, FilterByValue, FilterBands, FilterBox, FilterSphere, Param as ProcessParam, Lod, Summary, MortonOrder, Decimate } from './process';
 export { ReadStream, BufferedReadStream, MemoryReadFileSystem, UrlReadFileSystem, ZipReadFileSystem } from './io/read';
 export type { ReadSource, ReadFileSystem, ProgressCallback, ZipEntry } from './io/read';
 export { MemoryFileSystem, ZipFileSystem } from './io/write';
@@ -31,6 +31,7 @@ export { writeCompressedPly } from './writers/write-compressed-ply';
 export { writeCsv } from './writers/write-csv';
 export { writeHtml } from './writers/write-html';
 export { writeLod } from './writers/write-lod';
+export { writeGlb } from './writers/write-glb';
 export { writeVoxel } from './writers/write-voxel';
 export type { WriteVoxelOptions, VoxelMetadata } from './writers/write-voxel';
 export type { Options, Param } from './types';

package/dist/lib/index.d.ts

@@ -5,13 +5,13 @@ export { transform } from './data-table/transform';
 export { computeSummary } from './data-table/summary';
 export type { ColumnStats, SummaryData } from './data-table/summary';
 export { sortMortonOrder } from './data-table/morton-order';
-export { sortByVisibility } from './data-table/filter-visibility';
+export { sortByVisibility, simplifyGaussians } from './data-table/decimate';
 export { readFile, getInputFormat } from './read';
 export type { InputFormat, ReadFileOptions } from './read';
 export { writeFile, getOutputFormat } from './write';
 export type { OutputFormat, WriteOptions } from './write';
 export { processDataTable } from './process';
-export type { ProcessAction, Translate, Rotate, Scale, FilterNaN, FilterByValue, FilterBands, FilterBox, FilterSphere, Param as ProcessParam, Lod, Summary, MortonOrder, FilterVisibility } from './process';
+export type { ProcessAction, Translate, Rotate, Scale, FilterNaN, FilterByValue, FilterBands, FilterBox, FilterSphere, Param as ProcessParam, Lod, Summary, MortonOrder, Decimate } from './process';
 export { ReadStream, BufferedReadStream, MemoryReadFileSystem, UrlReadFileSystem, ZipReadFileSystem } from './io/read';
 export type { ReadSource, ReadFileSystem, ProgressCallback, ZipEntry } from './io/read';
 export { MemoryFileSystem, ZipFileSystem } from './io/write';
@@ -31,6 +31,7 @@ export { writeCompressedPly } from './writers/write-compressed-ply';
 export { writeCsv } from './writers/write-csv';
 export { writeHtml } from './writers/write-html';
 export { writeLod } from './writers/write-lod';
+export { writeGlb } from './writers/write-glb';
 export { writeVoxel } from './writers/write-voxel';
 export type { WriteVoxelOptions, VoxelMetadata } from './writers/write-voxel';
 export type { Options, Param } from './types';

package/dist/lib/process.d.ts

@@ -120,14 +120,15 @@ type MortonOrder = {
     kind: 'mortonOrder';
 };
 /**
- * Filter splats by visibility score, keeping only the most visible ones.
+ * Simplify splats to a target count using NanoGS progressive pairwise merging.
  *
- * Visibility is computed as: linear_opacity * volume
- * where opacity is converted from logit and scales from log space.
+ * Instead of discarding low-visibility splats, this iteratively merges nearby
+ * similar splats into single approximating Gaussians using Mass-Preserving
+ * Moment Matching (MPMM), preserving scene structure and appearance.
  */
-type FilterVisibility = {
+type Decimate = {
     /** Action type identifier. */
-    kind: 'filterVisibility';
+    kind: 'decimate';
     /** Target number of splats to keep, or null for percentage mode. */
     count: number | null;
     /** Percentage of splats to keep (0-100), or null for count mode. */
@@ -148,9 +149,9 @@ type FilterVisibility = {
  * - `lod` - Assign LOD level to all splats
  * - `summary` - Print statistical summary to logger
  * - `mortonOrder` - Reorder splats by Morton code for spatial locality
- * - `filterVisibility` - Keep only the most visible splats by opacity * volume
+ * - `decimate` - Simplify to target count via progressive pairwise merging
  */
-type ProcessAction = Translate | Rotate | Scale | FilterNaN | FilterByValue | FilterBands | FilterBox | FilterSphere | Param | Lod | Summary | MortonOrder | FilterVisibility;
+type ProcessAction = Translate | Rotate | Scale | FilterNaN | FilterByValue | FilterBands | FilterBox | FilterSphere | Param | Lod | Summary | MortonOrder | Decimate;
 /**
  * Applies a sequence of processing actions to splat data.
  *
@@ -175,4 +176,4 @@ type ProcessAction = Translate | Rotate | Scale | FilterNaN | FilterByValue | Fi
  * ```
  */
 declare const processDataTable: (dataTable: DataTable, processActions: ProcessAction[]) => DataTable;
-export { processDataTable, type ProcessAction, type Translate, type Rotate, type Scale, type FilterNaN, type FilterByValue, type FilterBands, type FilterBox, type FilterSphere, type Param, type Lod, type Summary, type MortonOrder, type FilterVisibility };
+export { processDataTable, type ProcessAction, type Translate, type Rotate, type Scale, type FilterNaN, type FilterByValue, type FilterBands, type FilterBox, type FilterSphere, type Param, type Lod, type Summary, type MortonOrder, type Decimate };

package/dist/lib/spatial/kd-tree.d.ts

@@ -8,11 +8,16 @@ interface KdTreeNode {
 declare class KdTree {
     centroids: DataTable;
     root: KdTreeNode;
+    private colData;
     constructor(centroids: DataTable);
     findNearest(point: Float32Array, filterFunc?: (index: number) => boolean): {
         index: number;
         distanceSqr: number;
         cnt: number;
     };
+    findKNearest(point: Float32Array, k: number, filterFunc?: (index: number) => boolean): {
+        indices: Int32Array<ArrayBuffer>;
+        distances: Float32Array<ArrayBuffer>;
+    };
 }
 export { KdTreeNode, KdTree };

package/dist/lib/utils/logger.d.ts

@@ -43,6 +43,12 @@ declare class Progress {
      * @param totalSteps - Total number of steps in the operation.
      */
     begin(totalSteps: number): void;
+    /**
+     * Cancel the current progress node, popping it from the stack without
+     * completing remaining steps. Use this before early exits (e.g. break)
+     * to keep the progress stack balanced.
+     */
+    cancel(): void;
     /**
      * Advance to the next step. Auto-increments the step counter.
      * Auto-ends when all steps are complete.

package/dist/lib/write.d.ts

@@ -7,6 +7,7 @@ import { type DeviceCreator } from './writers/write-sog';
  *
  * - `ply` - Standard PLY format
  * - `compressed-ply` - Compressed PLY format
+ * - `glb` - Binary glTF with KHR_gaussian_splatting extension
  * - `csv` - CSV text format (for debugging/analysis)
  * - `sog` - PlayCanvas SOG format (separate files)
  * - `sog-bundle` - PlayCanvas SOG format (bundled into single .sog file)
@@ -15,7 +16,7 @@ import { type DeviceCreator } from './writers/write-sog';
  * - `html-bundle` - Self-contained HTML viewer (all assets embedded)
  * - `voxel` - Sparse voxel octree format for collision detection
  */
-type OutputFormat = 'csv' | 'sog' | 'sog-bundle' | 'lod' | 'compressed-ply' | 'ply' | 'html' | 'html-bundle' | 'voxel';
+type OutputFormat = 'csv' | 'sog' | 'sog-bundle' | 'lod' | 'compressed-ply' | 'ply' | 'glb' | 'html' | 'html-bundle' | 'voxel';
 /**
  * Options for writing a Gaussian splat file.
  */

package/dist/lib/writers/write-glb.d.ts

@@ -0,0 +1,15 @@
+import { DataTable } from '../data-table/data-table';
+import { type FileSystem } from '../io/write';
+type WriteGlbOptions = {
+    filename: string;
+    dataTable: DataTable;
+};
+/**
+ * Writes Gaussian splat data to a GLB file using the KHR_gaussian_splatting extension.
+ *
+ * @param options - Options including filename and data table to write.
+ * @param fs - File system for writing the output file.
+ * @ignore
+ */
+declare const writeGlb: (options: WriteGlbOptions, fs: FileSystem) => Promise<void>;
+export { writeGlb };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playcanvas/splat-transform",
-  "version": "1.8.3",
+  "version": "1.9.1",
   "author": "PlayCanvas<support@playcanvas.com>",
   "homepage": "https://playcanvas.com",
   "description": "Library and CLI tool for 3D Gaussian splat format conversion and transformation",

package/dist/lib/data-table/filter-visibility.d.ts

@@ -1,17 +0,0 @@
-import { DataTable } from './data-table';
-/**
- * Sorts the provided indices by visibility score (descending order).
- *
- * Visibility is computed as: linear_opacity * volume
- * where:
- * - linear_opacity = sigmoid(opacity) = 1 / (1 + exp(-opacity))
- * - volume = exp(scale_0) * exp(scale_1) * exp(scale_2)
- *
- * After calling this function, indices[0] will contain the index of the most
- * visible splat, indices[1] the second most visible, and so on.
- *
- * @param dataTable - The DataTable containing splat data.
- * @param indices - Array of indices to sort in-place.
- */
-declare const sortByVisibility: (dataTable: DataTable, indices: Uint32Array) => void;
-export { sortByVisibility };