find_neighboring_beams

compas_timber.connections.find_neighboring_beams(beams, inflate_by=None)[source]

Finds neighboring pairs of beams in the given list of beams, using R-tree search.

The inputs to the R-tree algorithm are the axis-aligned bounding boxes of the beams (beam.aabb), enlarged by the inflate_by amount. The returned elements are sets containing pairs of Beam objects.

Parameters:

• beams (list(Beam)) – The list of beams in which neighboring beams should be identified.

• inflate_by (optional, float) – A value in design units by which the regarded bounding boxes should be inflated.

Returns:

list(set(Beam, Beam))

Notes

This is a pluggable. In order to use this function, a compatible plugin has to be available. For example, in Rhino, the function find_neighboring_beams() will be used.