Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BatchedMesh: Add "toJSON" and "copy" support #27131

Merged
merged 5 commits into from
Nov 7, 2023

Conversation

gkjohnson
Copy link
Collaborator

@gkjohnson gkjohnson commented Nov 6, 2023

Related issue: #22376, #27111

Description

Add support for "toJSON" and "copy" to "BatchedMesh".

Upcoming PRs

  • Raycasting, sorting support
  • Object-level bounds
  • Add support to ObjectLoader
  • Move to core
  • Documentation

Copy link

github-actions bot commented Nov 6, 2023

📦 Bundle size

Full ESM build, minified and gzipped.

Filesize dev Filesize PR Diff
655.1 kB (162.2 kB) 655.5 kB (162.3 kB) +406 B

🌳 Bundle size after tree-shaking

Minimal build including a renderer, camera, empty scene, and dependencies.

Filesize dev Filesize PR Diff
447.7 kB (108.2 kB) 448.1 kB (108.3 kB) +406 B

@gkjohnson gkjohnson added this to the r159 milestone Nov 6, 2023
object._geometryInitialized = this._geometryInitialized;
object._geometryCount = this._geometryCount;

object._matricesTexture = this._matricesTexture.toJSON();
Copy link
Collaborator

@Mugen87 Mugen87 Nov 7, 2023

Choose a reason for hiding this comment

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

Can we avoid serializing the internal texture? Ideally, it is just recreated in BatchedMesh if it is missing.

Besides, can we avoid the underscore syntax in the JSON object?

Also, at some point this logic should be moved to BatchedMesh.toJSON(). Object3D should not access private variables of subclasses.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Can we avoid serializing the internal texture? Ideally, it is just recreated in BatchedMesh if it is missing.

This texture is how the matrices are canonically stored. I can generate a list of serialized matrices from the texture instead, though, if that's acceptable.

Besides, can we avoid the underscore syntax in the JSON object?

Yup! I'll fix it.

Also, at some point this logic should be moved to BatchedMesh.toJSON(). Object3D should not access private variables of subclasses.

I thought so, too, but this looked like how all the other classes like InstancedMesh were working. Though it's unclear to me why this is needed.

Copy link
Collaborator

@Mugen87 Mugen87 Nov 7, 2023

Choose a reason for hiding this comment

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

This texture is how the matrices are canonically stored. I can generate a list of serialized matrices from the texture instead, though, if that's acceptable.

I forgot after #27130 there is only the texture that holds the matrices. In this case, I'm fine with serializing directly the texture.

I thought so, too, but this looked like how all the other classes like InstancedMesh were working. Though it's unclear to me why this is needed.

We can try to find a different solution in the future. Just wanted to note it in this PR.

Copy link
Collaborator

Choose a reason for hiding this comment

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

BTW: ObjectLoader should also be able to handle BatchedMesh. Maybe we can add this to the todo list.

@Mugen87
Copy link
Collaborator

Mugen87 commented Nov 7, 2023

Sorry, approved a bit too early. The removal of the underscore in the JSON would still be nice^^!

@gkjohnson
Copy link
Collaborator Author

Sorry, approved a bit too early. The removal of the underscore in the JSON would still be nice^^!

Fixed!

BTW: ObjectLoader should also be able to handle BatchedMesh. Maybe we can add this to the todo list.

Added to the list!

@Mugen87 Mugen87 merged commit d5bd248 into mrdoob:dev Nov 7, 2023
18 checks passed
@gkjohnson gkjohnson deleted the batched-tojson-copy branch November 7, 2023 09:59
@@ -563,17 +563,29 @@ class BatchedMesh extends Mesh {

}

copy() {
copy( source ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we have copy return this to make it consistent with parent classes Object3D and Mesh?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants