Improve performance of 3D scenes by initializing all objects at once

[falkoschindler]

This PR experiments with sending a single initialization message with all 3D objects at once to reduce the time for creating complex 3D scenes like discussed in #3009.

A demo with 10,000 boxes runs even faster than with PR #3017:

with ui.scene() as scene:
    scene.move_camera(y=-6, z=7)
    for x in range(100):
        for y in range(100):
            scene.box().scale(0.09).move(x / 10 - 5, y / 10 - 5)

This approach not only bundles multiple commands into one message, it also cuts the payload significantly by focusing on the actual data rather the sending loads of overhead for every attribute. It could be combined with PR #3017 to improve the speed for updating existing objects.

[kovalp]

Let me see how this behaves.

[kovalp]

I would use a simple method, not a property.

[falkoschindler]

Why do you think a method would be better?

[falkoschindler]

A method is easier to mock to facilitate unit testing.

Ok, I see your point. I'd like to stick with the property nonetheless, because mocking this property for a unit test is not a concert at the moment and a property feels more idiomatic in this case.

[kovalp]

This performs great! There is almost no delay for the shape 50x50 and maybe half-a-second delay for the 100x100 field.

Does this PR improve the updates too?

[kovalp]

A method is easier to mock to facilitate unit testing.

…

On Mon, May 6, 2024, 11:36 Falko Schindler ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In nicegui/elements/scene_object3d.py <#3022 (comment)>: > @@ -42,16 +42,19 @@ def with_name(self, name: str) -> Self: self._name() return self - def send(self) -> None: - """Send the object to the client.""" - self._create() - self._name() - self._material() - self._move() - self._rotate() - self._scale() - self._visible() - self._draggable() + @Property + def data(self) -> List[Any]: Why do you think a method would be better? — Reply to this email directly, view it on GitHub <#3022 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACAKSHBAUSYZPIVSKJXPPQ3ZA5FK5AVCNFSM6AAAAABHHVNK6GVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDANBQGM3DQOBUGQ> . You are receiving this because you commented.Message ID: ***@***.***>

[falkoschindler]

Does this PR improve the updates too?

@kovalp No, this PR only improves the object initialization. Updates will be tackled by PR #3017 or other improvements.

Anyway, I think we should merge this PR because it greatly improves the ui.scene element.

[kovalp]

Yes, this is mergeable already. Thanks!

…

On Mon, May 6, 2024, 11:49 Falko Schindler ***@***.***> wrote: Does this PR improve the updates too? @kovalp <https://github.com/kovalp> No, this PR only improves the object initialization. Updates will be tackled by PR #3017 <#3017> or other improvements. Anyway, I think we should merge this PR because it greatly improves the ui.scene element. — Reply to this email directly, view it on GitHub <#3022 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACAKSHA4W5TOR3RZW2E2J23ZA5G33AVCNFSM6AAAAABHHVNK6GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJVGU4TANJRGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[kovalp]

Is this improvement effective for existing scenes or only for the newly created scenes?

[falkoschindler]

@kovalp It should also improve the performance when creating new scenes dynamically, e.g. on button click. Every scene sends an "init" event to the server which responds with an "init_objects" message containing all 3D object information. Thus it benefits from the new condensed format.

[kovalp]

Ok, but what about existing scene objects? I guess whenever I have time I will try to figure out it myself.

…

On Tue, May 7, 2024, 22:27 Falko Schindler ***@***.***> wrote: @kovalp <https://github.com/kovalp> It should also improve the performance when creating new scenes dynamically, e.g. on button click. Every scene sends an "init" event to the server which responds with an "init_objects" message containing all 3D object information. Thus it benefits from the new condensed format. — Reply to this email directly, view it on GitHub <#3022 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACAKSHAT7XFQ4F3AJB7CVODZBE2MXAVCNFSM6AAAAABHHVNK6GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJZGI2DSMBTGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[falkoschindler]

As I said in #3022 (comment), updates to existing objects will be addressed by PR #3017 and other improvements.

[kovalp]

I am looking forward to the acceleration of updates. I will try to formulate my question in form of a code snippet later. Maybe I am using the objects not in an optimal way.

…

On Tue, May 7, 2024, 22:39 Falko Schindler ***@***.***> wrote: As I said in #3022 (comment) <#3022 (comment)>, updates to existing objects will be addressed by PR #3017 <#3017> and other improvements. — Reply to this email directly, view it on GitHub <#3022 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACAKSHFPJAHWWGMM7FOL2DDZBE3ZJAVCNFSM6AAAAABHHVNK6GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJZGI3DSNZWG4> . You are receiving this because you were mentioned.Message ID: ***@***.***>