compas_timber.connections

Joints

`Joint`	Base class for a joint connecting two beams.
`PlateJoint`	Models a plate to plate interaction.
`LapJoint`	Abstract Lap type joint with functions common to L-Lap, T-Lap, and X-Lap Joints.
`ButtJoint`	Represents an L-Butt type joint which joins two beam in their ends, trimming the main beam.
`TButtJoint`	Represents a T-Butt type joint which joins the end of a beam along the length of another beam, trimming the main beam.
`LButtJoint`	Represents an L-Butt type joint which joins two beam in their ends, trimming the main beam.
`TStepJoint`	Represents an T-Step type joint which joins two beams, one of them at it's end (main) and the other one along it's centerline (cross).
`LFrenchRidgeLapJoint`	Represents an L-FrenchRidgeLap type joint which joins two beams at their ends, by lapping them with a ridge.
`LLapJoint`	Represents an L-Lap type joint which joins the ends of two beams with a lap.
`LMiterJoint`	Represents an L-Miter type joint which joins two beam in their ends, trimming them with a plane at the bisector angle between the beams' centerlines.
`JointCandidate`	A JointCandidate is an information-only joint, which does not add any features to the elements it connects.
`PlateJointCandidate`	A PlateJointCandidate is an information-only joint for plate connections.
`TBirdsmouthJoint`	Represents a T-Birdsmouth type joint which joins two beams, one of them at it's end (main) and the other one along it's centerline (cross).
`LMiterJoint`	Represents an L-Miter type joint which joins two beam in their ends, trimming them with a plane at the bisector angle between the beams' centerlines.
`XLapJoint`	Represents an X-Lap type joint which joins the two beams somewhere along their length with a lap.
`XNotchJoint`	Represents an X-Notch type joint which joins the two beams somewhere along their length with a notch applied on the main_beam.
`TLapJoint`	Represents a T-Lap type joint which joins the end of a beam along the length of another beam with a lap.
`LLapJoint`	Represents an L-Lap type joint which joins the ends of two beams with a lap.
`JointCandidate`	A JointCandidate is an information-only joint, which does not add any features to the elements it connects.
`LFrenchRidgeLapJoint`	Represents an L-FrenchRidgeLap type joint which joins two beams at their ends, by lapping them with a ridge.
`JointTopology`	Enumeration of the possible joint topologies.
`ConnectionSolver`	Provides tools for detecting beam intersections and joint topologies.
`PlateConnectionSolver`	Provides tools for detecting plate intersections and joint topologies.
`TDovetailJoint`	Represents a T-Dovetail type joint which joins two beams, one of them at its end (main) and the other one along its centerline (cross).
`BallNodeJoint`	Represents a ball node type joint which joins the ends of multiple beams, trimming the main beam.
`TenonMortiseJoint`	Represents a TenonMortise type joint which joins two beams, one of them at its end (main) and the other one along its centerline (cross) or both of them at their ends.
`YButtJoint`	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.
`WallJoint`	Models a wall to wall interaction.
`PlateJoint`	Models a plate to plate interaction.
`PlateButtJoint`	Creates a plate-to-plate butt-joint connection.
`PlateLButtJoint`	Creates a plate-to-plate butt-joint connection.
`PlateTButtJoint`	Creates a plate-to-plate butt-joint connection.
`PlateMiterJoint`	Creates a mitered edge plate-to-plate connection.

Joint Interfaces

`InterfaceLocation`	Enumeration of the possible interface location within the wall.
`InterfaceRole`	Enumeration of the possible interface roles.

Solvers

`ConnectionSolver`	Provides tools for detecting beam intersections and joint topologies.
`JointTopology`	Enumeration of the possible joint topologies.
`Cluster`	One result of an analyzer, groups together the clustered joints and offers access to the beams
`BeamGroupAnalyzer`	Interface for a beam group analyzer.
`NBeamKDTreeAnalyzer`	Finds clusters of N beams connected pairwise at the same point within a given max_distance.
`TripletAnalyzer`	Finds clusters of 3 beams connected pairwise at the same point within a given max_distance.
`QuadAnalyzer`	Finds clusters of 4 beams connected pairwise at the same point within a given max_distance.
`CompositeAnalyzer`	CompositeAnalyzer combines multiple analyzers to find clusters of beams.
`MaxNCompositeAnalyzer`	Finds clusters of up to n beams (minimum 2), preferring larger clusters first.

Functions

`find_neighboring_elements`	Finds neighboring pairs of beams in the given list of beams, using R-tree search.
`beam_ref_side_incidence`	Returns a map of ref_side indices of beam_b and the angle of their normal with beam_a's centerline.
`beam_ref_side_incidence_with_vector`	Returns a map of ref_side indices of beam_b and the angle of their normal with a given vector.
`point_centerline_towards_joint`	Returns the centerline vector of beam_a pointing towards the joint with beam_b.

Exceptions

The following exceptions may be raised by this module. See the compas_timber.errors module for details.