PocketProxy

class compas_timber.fabrication.PocketProxy[source]

Bases: object

This object behaves like a Pocket except it only calculates the machining parameters once unproxified. Can also be used to defer the creation of the processing instance until it is actually needed.

Until then, it can be used to visualize the machining operation. This slightly improves performance.

Parameters:
volumePolyhedron or Brep or Mesh

The volume of the pocket. Must have 6 faces.

elementBeam or Plate

The element that is cut by this instance.

machining_limitsdict, optional

The machining limits for the cut. Default is None.

ref_side_indexint, optional

The index of the reference side of the element. Default is 0.

Returns:
Pocket

The Pocket feature.

Methods

apply

Apply the feature to the beam geometry.

from_volume_and_element

Construct a Pocket feature from a volume and a TimberElement.

unproxified

Returns the unproxified processing instance.