Scene object refactoring #1209

Licini · 2023-11-10T11:51:10Z

Hey guys, so this PR is about the refactoring all Artist to SceneObject. It may look like a huge PR, but besides the addition of scene class, all the rests are renaming and adjusting importing path. Basically compas.artists is now compas.scene.

Before I make the file changing list even longer, I want to make sure if we all agree on this new folder structure and naming convention:

All previous artists classes will be renamed to corresponding scene object classes:
- base class Artist to SceneObject
- Derived classes like MeshArtist to MeshObject, NetworkArtist to NetworkObject etc.
Both Scene and SceneObject is now under compas.scene, let me know if you guys think there should be a separate folder of compas.sceneobjects.

Now I have done renaming for compas core folder. If you guys are OK with this pattern I will finish the rest for compas_rhino, compas_ghpython and compas_blender.

Licini · 2023-11-30T16:56:46Z

Blender

GH

Rhino

Licini · 2023-11-30T17:10:23Z

@tomvanmele @gonzalocasas @chenkasirer Ok this one is ready. As discussed I'd like to make this PR only about renaming and make the basic scene setup work. Plz see the script at docs/userguide/tutorials/scene/scene.py which runs the same in three places above. Once this one is merged. I will continue to make following PRs to make the Scene mechanism complete:

Move functions like redraw and clear from SceneObject (formerly Artist) to Scene.
Proper serialization of everything inside a Scene.
Have all geometries and datastructures work properly everywhere (right now there are few left).
Unifying the guid tracking mechanism for all SceneObjects.
Handling of transformation stacks.
(Lastly, hash tree of scene)

Licini · 2023-11-30T17:11:22Z

docs/userguide/tutorials/scene/scene.py

Example here

docs/reference/compas.rst

docs/reference/compas.scene.rst

docs/reference/compas_blender.rst

docs/reference/compas_ghpython.rst

docs/reference/compas_rhino.rst

docs/userguide/configuration/grasshopper.rst

tomvanmele · 2023-11-30T21:50:52Z

docs/userguide/tutorials/geometry/curves_and_surfaces/curve_closest_point.py

@@ -17,11 +17,11 @@
 # Visualisation
 # ==============================================================================

-Artist.clear()
+SceneObject.clear()


this is wrong and there are many like this.
however, all files in this folder were copied from occ to be able to do some compatibility testing.
they are not meant to be part of the docs.
please remove...

tomvanmele · 2023-11-30T21:53:03Z

src/compas/scene/geometryobject.py

-class GeometryArtist(Artist):
-    """Base class for artists for geometry objects.
+class GeometryObject(SceneObject):
+    """Base class for sceneobjects for geometry objects.


perhaps do find replace scene object

tomvanmele · 2023-11-30T21:57:02Z

src/compas_blender/scene/networkobject.py

@@ -145,7 +145,7 @@ def draw_nodes(
        for node in nodes or self.network.nodes():  # type: ignore
            name = f"{self.network.name}.node.{node}"  # type: ignore
            color = self.node_color[node]  # type: ignore
-            point = self.node_xyz[node]  # type: ignore
+            point = self.network.nodes_attributes("xyz")[node]  # type: ignore


why are you changing this everywhere?

These was because they were creating double transformation. the node_xyz already preforms the transformation, then later self.update_object is doing that again.

ok but then perhaps remove the node_xyz dict

tomvanmele · 2023-11-30T21:57:24Z

src/compas_blender/scene/volmeshobject.py

@@ -153,7 +153,7 @@ def draw_vertices(
        for vertex in vertices or self.volmesh.vertices():  # type: ignore
            name = f"{self.volmesh.name}.vertex.{vertex}"  # type: ignore
            color = self.vertex_color[vertex]  # type: ignore
-            point = self.vertex_xyz[vertex]
+            point = self.volmesh.vertices_attributes("xyz")[vertex]


Why are you changing this everywhere?

Licini · 2023-12-01T09:55:42Z

@tomvanmele all done, let me know how it looks now : )

tomvanmele · 2023-12-01T09:57:47Z

src/compas/datastructures/assembly/part.py

@@ -193,7 +193,7 @@ def get_geometry(self, with_features=False):
        """
        Returns a transformed copy of the part's geometry.

-        The returned type can be drawn with an Artist.
+        The returned type can be drawn with an scene object.


tomvanmele · 2023-12-01T09:59:48Z

src/compas/scene/volmeshobject.py

-class VolMeshArtist(Artist):
-    """Artist for drawing volmesh data structures.
+class VolMeshObject(SceneObject):
+    """Sceneobject for drawing volmesh data structures.


Scene object?
SceneObject?

tomvanmele · 2023-12-01T10:00:10Z

src/compas_blender/scene/boxobject.py

-class BoxArtist(BlenderArtist, GeometryArtist):
-    """Artist for drawing box shapes in Blender.
+class BoxObject(BlenderSceneObject, GeometryObject):
+    """Sceneobject for drawing box shapes in Blender.


same question everywhere i guess

Licini · 2023-12-01T11:31:23Z

Oops, all fixed 🤣 @tomvanmele

Licini added 3 commits November 7, 2023 17:29

add scene and scene object

2b5bb5f

Tree as attribute

2f3c3f6

Refactor compas.artist to compas.scene

40d9499

Licini requested review from gonzalocasas, chenkasirer and tomvanmele November 10, 2023 11:51

Licini added 5 commits November 10, 2023 12:51

Delete 2

d3838f3

rename artists to sceneobjects in compas_rhino

4d67b1a

add transformation to all

a9670b8

rename gh artists to scene objects

154a815

update test and changelog

d737cb3

Licini force-pushed the scene-object branch from 635215a to d737cb3 Compare November 13, 2023 18:25

Rename sceneObject.py to sceneobject.py

ce03057

yck011522 mentioned this pull request Nov 16, 2023

Introduce Action and SceneState compas-dev/compas_fab#390

Draft

10 tasks

Licini added 9 commits November 27, 2023 13:43

Merge remote-tracking branch 'origin/main' into scene-object

8d6c130

post-merge clean up compas core

518fba2

post-merge clean up rhino and gh

05de3e0

refactor compas_blender

73904a7

lint

9668c98

small fix

e3ed5d9

update user guide

768b15f

doc updates

386866a

rename rst

9f7b28c

final adjustments

49f70de

Licini marked this pull request as ready for review November 30, 2023 17:10

Licini commented Nov 30, 2023

View reviewed changes

docs/userguide/tutorials/scene/scene.py Outdated

Copy link

Contributor Author

Licini Nov 30, 2023

Choose a reason for hiding this comment

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

Example here

changelog

5ce3060

tomvanmele reviewed Nov 30, 2023

View reviewed changes

Licini added 5 commits December 1, 2023 10:29

order

eebc556

register_scene_object

757f734

blank line

5a410d0

delete curve_and_surfaces test scripts

ba789d9

"sceneobject" to "scene object" in docs

3dd3074

tomvanmele reviewed Dec 1, 2023

View reviewed changes

Sceneobject => Scene object, an => a

ecac41e

tomvanmele approved these changes Dec 1, 2023

View reviewed changes

Licini merged commit 51416db into main Dec 1, 2023
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scene object refactoring #1209

Scene object refactoring #1209

Licini commented Nov 10, 2023 •

edited

Loading

Licini commented Nov 30, 2023

Licini commented Nov 30, 2023

Licini Nov 30, 2023

tomvanmele Nov 30, 2023

tomvanmele Nov 30, 2023

tomvanmele Nov 30, 2023

Licini Dec 1, 2023

tomvanmele Dec 1, 2023

tomvanmele Nov 30, 2023

Licini commented Dec 1, 2023

tomvanmele Dec 1, 2023

tomvanmele Dec 1, 2023

tomvanmele Dec 1, 2023

Licini commented Dec 1, 2023

Scene object refactoring #1209

Scene object refactoring #1209

Conversation

Licini commented Nov 10, 2023 • edited Loading

Licini commented Nov 30, 2023

Licini commented Nov 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Licini commented Dec 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Licini commented Dec 1, 2023

Licini commented Nov 10, 2023 •

edited

Loading