TenonMortiseJoint.promote_cluster

classmethod TenonMortiseJoint.promote_cluster(model, cluster, reordered_elements=None, **kwargs)

Creates an instance of this joint from a cluster of elements.

Parameters:

modelTimberModel

The model to which the elements and this joint belong.

clusterCluster

The cluster containing the elements to be connected by this joint.

reordered_elementslist(Element), optional

The elements to be connected by this joint. If not provided, the elements of the cluster will be used. This is used to explicitly define the element order.

**kwargsdict

Additional keyword arguments that are passed to the joint’s constructor.

Returns:

compas_timber.connections.Joint

The instance of the created joint.