Joint

class compas_timber.connections.Joint

Bases: Data

Base class for a joint connecting two beams.

This is a base class and should not be instantiated directly. Use the create() class method of the respective implementation of Joint instead.

Parameters:

topologyliteral, one of JointTopology

The topology by which the two elements connected with this joint interact.

locationPoint

The estimated location of the interaction point of the two elements connected with this joint.

Attributes:

namestr

The name of the joint. Corresponds to the class name.

elementstuple(Element)

The elements joined by this joint.

generated_elementslist(Element)

A list of elements that were generated by this joint.

endsdict(str, str)

Maps the GUID of each element to start or end, depending on which end of the element is connected by this joint.

interactionslist(tuple(Element, Element))

A list of tuples containing the elements that are interacting with each other through this joint.

featureslist(BTLxProcessing)

A list of features that were added to the elements by this joint.

topologyliteral, one of JointTopology

The topology by which the two elements connected with this joint interact.

locationPoint

The estimated location of the interaction point of the two elements connected with this joint.

Methods

add_extensions	Adds the extensions defined by this joint to affected beam(s).
add_features	Adds the features defined by this joint to affected beam(s).
check_elements_compatibility	Checks if the cluster of beams complies with the requirements for the Joint.
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.
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.
restore_beams_from_keys	Restores the reference to the elements associated with this joint.

Inherited Methods

ToString	Converts the instance to a string.
copy	Make an independent copy of the data object.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
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.