XLapJoint

class compas_timber.connections.XLapJoint[source]

Represents an X-Lap type joint which joins the two beams somewhere along their length with a lap.

This joint type is compatible with beams in X topology.

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

Parameters:

main_beamBeam: The first beam to be joined.
cross_beamBeam: The second beam to be joined.
flip_lap_sidebool: If True, the lap is flipped to the other side of the beams.
cut_plane_biasfloat: Allows lap to be shifted deeper into one beam or the other. Value should be between 0 and 1.0 without completely cutting through either beam. Default is 0.5.

Attributes:

main_beamBeam: The first beam to be joined.
cross_beamBeam: The second beam to be joined.
flip_lap_sidebool: If True, the lap is flipped to the other side of the beams.
cut_plane_biasfloat: Allows lap to be shifted deeper into one beam or the other. Value should be between 0 and 1.0 without completely cutting through either beam. Default is 0.5.

Methods

Adds the required extension and trimming features to both beams.

Inherited Methods

`ToString`	Converts the instance to a string.
`add_extensions`	Adds the extensions defined by this joint to affected beam(s).
`check_elements_compatibility`	Checks if the elements 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_cross_cutting_frame`
`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.
`get_main_cutting_frame`
`restore_beams_from_keys`	After de-serialization, restores references to the main and cross beams saved in the model.
`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.