YButtJoint

class compas_timber.connections.YButtJoint

Bases: Joint

Represents a Y-Butt type joint which joins the ends of three beams, trimming the main beam with a double cut and the cross beams with a miter cut.

Please use YButtJoint.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_beamslist of Beam

The cross beams to be joined.

mill_depthfloat

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

Attributes:

main_beamBeam

The main beam to be joined.

cross_beamsBeam

The cross beam to be joined.

mill_depthfloat

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

Methods

add_extensions	Calculates and adds the necessary extensions to the beams.
add_features	Adds the required extension and trimming features to both beams.
check_elements_compatibility	Checks if the cluster of beams complies with the requirements for the YButtJoint.
cross_beam_ref_side_index
get_miter_planes
main_beam_ref_side_index
restore_beams_from_keys	After de-serialization, restores references to the main and cross beams saved in the model.

Inherited Methods

ToString	Converts the instance to a string.
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	Checks if the number of elements complies with the joint's requirements.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
promote_cluster	Creates an instance of this joint from a cluster of elements.
promote_joint_candidate	Creates an instance of this joint from a joint candidate.
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.