Beam
- class compas_timber.elements.Beam[source]
Bases:
TimberElement
A class to represent timber beams (studs, slats, etc.) with rectangular cross-sections.
- Parameters:
- frame
compas.geometry.Frame
A local coordinate system of the beam: Origin is located at the starting point of the centerline. x-axis corresponds to the centerline (major axis), usually also the fibre direction in solid wood beams. y-axis corresponds to the width of the cross-section, usually the smaller dimension. z-axis corresponds to the height of the cross-section, usually the larger dimension.
- lengthfloat
Length of the beam
- widthfloat
Width of the cross-section
- heightfloat
Height of the cross-section
- frame
- Attributes:
- frame
Frame
The coordinate system (frame) of this beam.
- lengthfloat
Length of the beam.
- widthfloat
Width of the cross-section
- heightfloat
Height of the cross-section
- shape
Box
A feature-less box representing the parametric geometry of this beam.
- blank
Box
A feature-less box representing the material stock geometry to produce this beam.
- ref_frame
Frame
Reference frame for machining processes according to BTLx standard.
- ref_sidestuple(
Frame
) A tuple containing the 6 frames representing the sides of the beam according to BTLx standard.
- ref_edgestuple(
Line
) A tuple containing the 4 lines representing the long edges of the beam according to BTLx standard.
- faceslist(
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) 1: +z 2: -y 3: -z 4: -x (side at the starting end) 5: +x (side at the end of the beam)
- centerline
Line
A line representing the centerline of this beam.
- centerline_start
Point
The point at the start of the centerline of this beam.
- centerline_end
Point
The point at the end of the centerline of this beam.
- aabbtuple(float, float, float, float, float, float)
An axis-aligned bounding box of this beam as a 6 valued tuple of (xmin, ymin, zmin, xmax, ymax, zmax).
- long_edgeslist(
Line
) A list containing the 4 lines along the long axis of this beam.
- midpoint
Point
The point at the middle of the centerline of this beam.
- keyint, optional
Once beam is added to a model, it will have this model-wide-unique integer key.
- frame
Methods
Adds a blank extension to the beam.
Adds one or more features to the beam.
Computes the Axis Aligned Bounding Box (AABB) of the element.
Computes the collision geometry of the element.
Compute the geometry of the element.
Computes the Oriented Bounding Box (OBB) of the element.
Returns which endpoint of the centerline of the beam is closer to the given point.
Returns the amount by which to extend the beam in each direction using metric units.
Define the beam from its centerline.
Creates a Beam from the given endpoints.
Returns the index of reference side opposing the given side index.
Removes a blank extension from the beam.
Removes a feature from the beam.
Returns the requested side of the beam as a parametric planar surface.
Inherited Methods
Converts the instance to a string.
Add a feature to the list of features of the lement.
Compute the transformation to world coordinates of this element based on its position in the spatial hierarchy of the model.
Make an independent copy of the data object.
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Resets the element to its initial state by removing all features, extensions, and debug_info.
Compute a hash of the data for comparison during version control using the sha256 algorithm.
Convert an object to its native data representation and save it to a JSON file.
Convert an object to its native data representation and save it to a JSON string.
Transforms the element.
Creates a transformed copy of the element.
Validate the data against the object's data schema.