LButtJoint

class compas_timber.connections.LButtJoint[source]

Bases: Joint

Represents an L-Butt type joint which joins two beam in their ends, trimming the main beam.

This joint type is compatible with beams in L topology.

Please use LButtJoint.create() to properly create an instance of this class and associate it with a model.

Parameters:
main_beamBeam

The main beam to be joined.

cross_beamBeam

The cross beam to be joined.

mill_depthfloat

The depth of the pocket to be milled in the cross beam.

small_beam_buttsbool, default False

If True, the beam with the smaller cross-section will be trimmed. Otherwise, the main beam will be trimmed.

modify_crossbool, default False

If True, the cross beam will be extended to the opposite face of the main beam and cut with the same plane.

reject_ibool, default False

If True, the joint will reject beams in I topology.

Attributes:
main_beamBeam

The main beam to be joined.

cross_beamBeam

The cross beam to be joined.

mill_depthfloat

The depth of the pocket to be milled in the cross beam.

small_beam_buttsbool, default False

If True, the beam with the smaller cross-section will be trimmed. Otherwise, the main beam will be trimmed.

modify_crossbool, default False

If True, the cross beam will be extended to the opposite face of the main beam and cut with the same plane.

reject_ibool, default False

If True, the joint will reject beams in I topology.

Methods

add_extensions

Calculates and adds the necessary extensions to the beams.

add_features

Adds the required extension and trimming features to both beams.

restore_beams_from_keys

After de-serialization, restores references to the main and cross beams saved in the model.

update_beam_roles

Flips the main and cross beams based on the joint parameters.

Inherited Methods

ToString

Converts the instance to a string.

check_elements_compatibility

Checks if the beams are compatible for the creation of the joint.

copy

Make an independent copy of the data object.

create

Creates an instance of this joint and creates the new connection in model.

element_count_complies

from_json

Construct an object of this type from a JSON file.

from_jsonstring

Construct an object of this type from a JSON string.

get_face_most_ortho_to_beam

Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.

get_face_most_towards_beam

Of all the faces of beam_b, returns the one whose normal most faces beam_a.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_json

Convert an object to its native data representation and save it to a JSON file.

to_jsonstring

Convert an object to its native data representation and save it to a JSON string.

validate_data

Validate the data against the object's data schema.