DirectRule

class compas_timber.design.DirectRule[source]

Bases: JointRule

Creates a Joint Rule that directly joins multiple elements. This essentially replaces the JointDefinition.

Parameters:
joint_typecls(Joint)

The joint type to be applied to the elements.

elementslist(TimberElement)

The elements to be joined.

max_distancefloat, optional

The maximum distance to consider two elements as intersecting. This will override the global max_distance.

kwargsdict

The keyword arguments to be passed to the joint.

Methods

ToString

try_create_joint

Returns a Joint if the given cluster's elements comply with this DirectRule.