Joint

class compas_timber.connections.Joint[source]

Bases: Interaction

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.

Attributes:
beamstuple(Beam)

The beams joined by this joint.

endsdict(Beam, str)

Returns a map of which end of each beam is joined by this joint.

frameFrame

The frame of the joint.

keystr

A unique identifier for this joint.

featureslist(Feature)

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

attributesdict

A dictionary of additional attributes for 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).

create

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

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.

restore_beams_from_keys

Restores the reference to the beams associate 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.