TopologyRule

class compas_timber.design.TopologyRule[source]

Bases: JointRule

for a given connection topology type (L,T,X,I,K…), this rule assigns a joint type.

Parameters:
topology_typeconstant(compas_timber.connections.JointTopology)

The topology type to which the rule is applied.

joint_typecls(compas_timber.connections.Joint)

The joint type to be applied to this topology.

max_distancefloat, optional

The maximum distance to consider two elements as intersecting. This will override a global max_distance if set.

kwargsdict

The keyword arguments to be passed to the joint.

Methods

ToString

comply

Checks if the given elements comply with this TopologyRule.

Inherited Methods

get_category_rules

get_direct_rules

get_topology_rules

joints_from_beams_and_rules

processes joint rules into joint definitions.