Add the possibility to load a scene from file #340

d0rianb · 2024-09-24T17:34:02Z

For now, the viewer can handle URL which can be downloaded from with the fetch API.
I wanted to add the possibility to load a scene directly from a file, to handle drag & drop for instance.

Some features are still missing, like the progressive loading, or multiple files loading. I plan on integrate these soon.

Moreover, I struggled a bit on the 'abortable' promise that is returned by downloadAndBuildSingleSplatSceneStandardLoad. I couldn't manage to get the differences between the two following lines :

const downloadPromise = this.downloadSplatSceneToSplatBuffer(path, splatAlphaRemovalThreshold, onProgress, false, undefined, format);
const downloadAndBuildPromise = abortablePromiseWithExtractedComponents(downloadPromise.abortHandler);

Release 0.4.3

Release 0.4.4: General updates

Update version to 0.4.5

Release v0.4.6 - Minor updates

Release 0.4.7

Update load-from-file to 0.4.7

hirako2000 · 2025-03-13T10:12:55Z

src/loaders/ply/INRIAV1PlyParser.js

 import { SplatBuffer } from '../SplatBuffer.js';
 import { PlyParserUtils } from './PlyParserUtils.js';

 const BaseFieldNamesToRead = ['scale_0', 'scale_1', 'scale_2', 'rot_0', 'rot_1', 'rot_2', 'rot_3', 'x', 'y', 'z',


applying prettifier to unchanged lines clutters reviewing the PR :)

hirako2000 · 2025-03-13T10:13:48Z

package.json

        "three": ">=0.160.0"
    },
+    "dependencies": {
+        "@aws-sdk/client-s3": "^3.750.0"


Why add the (bloated) client-s3 library? Is that relevant to loading from a file?

Hi, it's not relevant for this PR, i kept working on this branch to add remote loading from R2 buckets, but did not realise the commits will be uploaded to this PR. I will clean this.

Happy to help test and review this, it's a great PR.

* Update splat sort for small splat count

d0rianb · 2025-03-17T20:44:36Z

The changes should be those of the dev branch now, apart from the specific ones related to loading a file or a promise

hirako2000 · 2025-03-18T10:59:49Z

src/worker/sorter.cpp

    int maxDistance = -2147483640;
    int minDistance = 2147483640;

+    if (distanceMapRange > sortCount) distanceMapRange = sortCount;


Seems like an unrelated change here.

hirako2000 · 2025-03-18T10:59:57Z

src/worker/sorter_no_simd.cpp

    int minDistance = 2147483640;

+    if (distanceMapRange > sortCount) distanceMapRange = sortCount;
+


hirako2000 · 2025-03-18T11:01:44Z

src/Viewer.js

                document.body.appendChild(this.rootElement);
            } else {
-                this.rootElement = this.renderer.domElement || document.body;
+                this.rootElement = this.renderer.domElement.parentElement || document.body;


Not sure they could always be a parent element. In any case this seems unrelated to the changeset.

hirako2000 · 2025-03-18T11:02:55Z

src/Viewer.js

    setupCamera() {
        if (!this.usingExternalCamera) {
            const renderDimensions = new THREE.Vector2();
-            this.getRenderDimensions(renderDimensions);


is this refactor necessary? Is that fixing something related to processing files? It doesn't seem to be.

hirako2000 · 2025-03-18T11:12:51Z

src/Viewer.js

-            } else if (format === SceneFormat.Spz) {
-                return SpzLoader.loadFromURL(path, onProgress, splatAlphaRemovalThreshold, this.inMemoryCompressionLevel,
-                                             this.optimizeSplatData, this.sphericalHarmonicsDegree, headers);
+            if (format === SceneFormat.Splat) {


Nice refactor, but see the headers got dropped. These are used by down the stack as below. I would keep the refactor, but continue to pass the headers options.

if (headers) fetchOptions.headers = headers; fetch(path, fetchOptions) .then(async (data) => { // Handle error conditions where data is still returned if (!data.ok) { const errorText = await data.text(); reject(new Error(`Fetch failed: ${data.status} ${data.statusText} ${errorText}`)); return; }

hirako2000 · 2025-03-18T11:18:05Z

src/Viewer.js

+    loadSplatSceneFromFileToSplatBuffer(fileData, splatAlphaRemovalThreshold = 1, onProgress = undefined,
+        progressiveBuild = false, onSectionBuilt = undefined, format) {
+        if (format === SceneFormat.Splat) {
+            return SplatLoader.loadFromFileData(fileData, splatAlphaRemovalThreshold, 0, false);


why not passing the compression level? rather than magic 0?

Also, I suggest this function to handle inMemoryCompressionLevel as an option parameter with some default.

See that the viewer otherwise (URL loading feature) supports it as an option.

hirako2000 · 2025-03-18T11:21:12Z

src/loaders/spz/SpzLoader.js


    static loadFromURL(fileName, onProgress, minimumAlpha, compressionLevel, optimizeSplatData = true,
                       outSphericalHarmonicsDegree = 0, headers, sectionSize, sceneCenter, blockSize, bucketSize) {
+        const localOnProgress = (percent, percentLabel) => {


I'm unsure of the possible side effect there, but this change at least obscures how the onProgress eventing functions, which already is not trivial to grasp.

I even doubt this change is necessary.

hirako2000 · 2025-03-18T11:26:15Z

src/worker/compile_wasm_no_simd.sh

@@ -1 +1 @@
-em++ -std=c++11 sorter_no_simd.cpp -Os -s WASM=1 -s SIDE_MODULE=2 -o sorter_no_simd.wasm -s IMPORTED_MEMORY=1 -s SHARED_MEMORY=1
+em++ -std=c++11 sorter_no_simd.cpp -Os -s WASM=1 -s SIDE_MODULE=2 -o sorter_no_simd.wasm -s IMPORTED_MEMORY=1 -s USE_PTHREADS=1


was it some troubleshooting changes? is that needed?

I would not touch this given the no_simd is likely a script for compatibility sake. Not sure tbh.

hirako2000 · 2025-03-18T11:30:08Z

the branch is now far more readable, thanks for the clean up.

I would suggest updating the README with how to use this. I will test it then.

mkkellogg and others added 20 commits July 15, 2024 14:40

Merge pull request mkkellogg#281 from mkkellogg/dev

992ed9a

Release 0.4.3

Add 2D scene mode option to demo page

ef524f4

Merge pull request mkkellogg#310 from mkkellogg/dev

2d80511

Release 0.4.4: General updates

Merge pull request mkkellogg#334 from mkkellogg/dev

f6f4ade

Update version to 0.4.5

Add the possibility to add a splat scene from a file

57c5199

Revert auto-formatting

e280fc5

Add the possibility to add a splat scene from a file

b311277

Revert auto-formatting

3ac12e0

Merge from load-from-file

b2a2c48

Fix git merge issue

19f3795

Fix demo & fileName issue

80f1f12

Merge branch 'mkkellogg:main' into load-from-file

a6d4356

Merge pull request mkkellogg#384 from mkkellogg/dev

408943e

Release v0.4.6 - Minor updates

Merge pull request mkkellogg#413 from mkkellogg/dev

2dfc83e

Release 0.4.7

Update to 0.4.7

a17d21d

Merge branch 'main' into load-from-file

397dd22

Update load-from-file to 0.4.7

Add loading from an R2 bucket

617f31e

Add R2 file loading

c150adb

Refactor R2 & file loading

06deecf

Remove unsed dependency

4226a46

hirako2000 reviewed Mar 13, 2025

View reviewed changes

d0rianb and others added 5 commits March 17, 2025 09:02

Refactor to a generic function : addSplatSceneFromPromise

6574304

Update sort for small splat count (mkkellogg#420)

b344a93

* Update splat sort for small splat count

Fix onProgress status

88400f7

Tweaking calculation of renderer dimensions

cb4bd90

Update unchanged files to remotes/dev

fc0b27b

Fix loading message

d6735f5

hirako2000 reviewed Mar 18, 2025

View reviewed changes

src/worker/sorter_no_simd.cpp

int minDistance = 2147483640;

if (distanceMapRange > sortCount) distanceMapRange = sortCount;

Copy link

hirako2000 Mar 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here too.

hirako2000 reviewed Mar 18, 2025

View reviewed changes

d0rianb changed the base branch from main to dev March 19, 2025 07:47

d0rianb added 2 commits March 19, 2025 09:01

Improve argument passign in loadSplatSceneFromFileToSplatBuffer

19e9ccc

Add filename parameter to fix format detection issue

e60a5ed

		int minDistance = 2147483640;

		if (distanceMapRange > sortCount) distanceMapRange = sortCount;

		@@ -1 +1 @@
		em++ -std=c++11 sorter_no_simd.cpp -Os -s WASM=1 -s SIDE_MODULE=2 -o sorter_no_simd.wasm -s IMPORTED_MEMORY=1 -s SHARED_MEMORY=1
		em++ -std=c++11 sorter_no_simd.cpp -Os -s WASM=1 -s SIDE_MODULE=2 -o sorter_no_simd.wasm -s IMPORTED_MEMORY=1 -s USE_PTHREADS=1

Add the possibility to load a scene from file #340

Are you sure you want to change the base?

Add the possibility to load a scene from file #340

Uh oh!

Conversation

d0rianb commented Sep 24, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hirako2000 Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

d0rianb Mar 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

d0rianb commented Mar 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hirako2000 commented Mar 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hirako2000 Mar 13, 2025 •

edited

Loading

d0rianb Mar 16, 2025 •

edited

Loading