minimal changes to get geometry goind + some TODOs

Author: chenkasirer

examples/model/0002_stand.py

@@ -78,6 +78,7 @@ def create_viewer():
 
 # draw geometry (with features)
 for beam in model.beams:
-    viewer.scene.add(beam.geometry)
+    beam: Beam
+    viewer.scene.add(beam.modelgeometry)
 
 viewer.show()

requirements-dev.txt

@@ -12,3 +12,4 @@ pytest-mock
 build
 pythonnet
 tomlkit
+compas_viewer

src/compas_timber/elements/beam.py

@@ -134,23 +134,19 @@ def blank_length(self):
     @property
     def blank_frame(self):
         # type: () -> Frame
-        # TODO: could be replaced by `ref_frame`?
+        # TODO: unlike `frame` this may me translated by the start extension.
+        # TODO: could be replaced by `ref_frame` (which is also affected by extension)?
+        #
         assert self.frame
         start, _ = self._resolve_blank_extensions()
         frame = self.frame.copy()
         frame.point += -frame.xaxis * start  # "extension" to the start edge
         return frame
 
-    @property
-    def ref_frame(self):
-        # type: () -> Frame
-        ref_point = self.blank_frame.point.copy()
-        ref_point += self.blank_frame.yaxis * self.width * 0.5
-        ref_point -= self.blank_frame.zaxis * self.height * 0.5
-        return Frame(ref_point, self.blank_frame.xaxis, self.blank_frame.zaxis)
 
     @property
     def faces(self):
+        # TODO: this should be removed! see if used anywhere, replace with `ref_sides` and DESTROY!
         # type: () -> list[Frame]
         assert self.frame
         return [
@@ -182,6 +178,19 @@ def faces(self):
             ),  # small face at end point
         ]
 
+
+    ########################################################################
+    # BTLx properties
+    # TODO: move these to TimberElement.
+    ########################################################################
+    @property
+    def ref_frame(self):
+        # type: () -> Frame
+        ref_point = self.blank_frame.point.copy()
+        ref_point += self.blank_frame.yaxis * self.width * 0.5
+        ref_point -= self.blank_frame.zaxis * self.height * 0.5
+        return Frame(ref_point, self.blank_frame.xaxis, self.blank_frame.zaxis)
+
     @property
     def ref_sides(self):
         # type: () -> tuple[Frame, Frame, Frame, Frame, Frame, Frame]
@@ -233,6 +242,7 @@ def centerline_end(self):
 
     @property
     def long_edges(self):
+        # TODO: can we replace this with `ref_edges`?
         # type: () -> list[Line]
         assert self.frame
         y = self.frame.yaxis
@@ -256,6 +266,7 @@ def has_features(self):
 
     @property
     def key(self):
+        # TODO: should be removed, this was just for compatibility with old code.
         # type: () -> int | None
         return self.graph_node
 
@@ -420,7 +431,7 @@ def from_endpoints(cls, point_start, point_end, width, height, z_vector=None):
     @staticmethod
     def _create_shape(frame, xsize, ysize, zsize):
         # type: (Frame, float, float, float) -> Box
-        boxframe = frame.copy()
+        boxframe = Frame.worldXY()
         depth_offset = boxframe.xaxis * xsize * 0.5
         boxframe.point += depth_offset
         return Box(xsize, ysize, zsize, frame=boxframe)

src/compas_timber/elements/timber.py

@@ -1,3 +1,4 @@
+from compas.geometry import Transformation
 from compas_model.elements import Element
 from compas_model.elements import reset_computed
 
@@ -23,13 +24,11 @@ class TimberElement(Element):
     @property
     def __data__(self):
         data = super(TimberElement, self).__data__
-        data["frame"] = self.frame
         data["features"] = [f for f in self.features if not f.is_joinery]  # type: ignore
         return data
 
-    def __init__(self, features=None, **kwargs):
-        super(TimberElement, self).__init__(**kwargs)
-        self._frame = kwargs.get("frame", None)
+    def __init__(self, features=None, frame=None, **kwargs):
+        super(TimberElement, self).__init__(transformation=Transformation.from_frame(frame), **kwargs)
         self._features = features or []
         self.debug_info = []
 
@@ -53,17 +52,6 @@ def is_group_element(self):
     def is_fastener(self):
         return False
 
-    @property
-    def frame(self):
-        # type: () -> Frame
-        """The local coordinate frame of the element."""
-        return self._frame
-
-    @frame.setter
-    @reset_computed
-    def frame(self, frame):
-        self._frame = frame
-
     @property
     def features(self):
         # type: () -> list[Feature]