Skip to content

Commit

Permalink
added attributes to docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
chenkasirer committed Jul 5, 2024
1 parent 15494bc commit 9d1ca0d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/compas_timber/elements/beam.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ class Beam(Element):
A feature-less box representing the parametric geometry of this beam.
blank : :class:`~compas.geometry.Box`
A feature-less box representing the material stock geometry to produce this beam.
ref_frame : :class:`~compas.geometry.Frame`
Reference frame for machining processes according to BTLx standard.
ref_sides : tuple(:class:`~compas.geometry.Frame`)
A tuple containing the 6 frames representing the sides of the beam according to BTLx standard.
faces : list(:class:`~compas.geometry.Frame`)
A list of frames representing the 6 faces of this beam.
0: +y (side's frame normal is equal to the beam's Y positive direction)
Expand Down Expand Up @@ -169,6 +173,7 @@ def faces(self):
@property
def ref_sides(self):
# type: () -> tuple[Frame, Frame, Frame, Frame, Frame, Frame]
# See: https://design2machine.com/btlx/BTLx_2_2_0.pdf
# TODO: cache these
rs1_point = self.ref_frame.point
rs2_point = rs1_point + self.ref_frame.yaxis * self.height
Expand Down

0 comments on commit 9d1ca0d

Please sign in to comment.