TopologyRule.comply

TopologyRule.comply(elements, model_max_distance=1e-09)[source]

Checks if the given elements comply with this TopologyRule. It checks that the max_distance is not exceeded and that the topology of the elements matches the rule. If the elements are not in the correct order, they are reversed.

Parameters:
elementstuple(TimberElement, TimberElement)

A tuple containing two elements to check.

model_max_distancefloat, optional

The maximum distance to consider two elements as intersecting. Defaults to TOL.absolute. This is only used if the rule does not already have a max_distance set.

Returns:
bool

True if the elements comply with the rule, False otherwise.

list(TimberElement)

The elements in the correct order.