Pocket

class compas_timber.fabrication.Pocket

Bases: BTLxProcessing

Represents a Pocket feature to be made on a beam.

Parameters:

start_xfloat

The start x-coordinate of the cut in parametric space of the reference side. -100000.0 < start_x < 100000.0.

start_yfloat

The start y-coordinate of the cut in parametric space of the reference side. -50000.0 < start_y < 50000.0.

start_depthfloat

The start depth of the cut. -50000.0 < start_depth < 50000.0.

anglefloat

The horizontal angle of the cut. -179.9 < angle < 179.9.

inclinationfloat

The vertical angle of the cut. -179.9 < inclination < 179.9.

slopefloat

The slope of the cut. -179.9 < slope < 179.9.

lengthfloat

The length of the cut. 0.0 < length < 100000.0.

widthfloat

The width of the cut. 0.0 < width < 50000.0.

internal_anglefloat

The internal angle of the cut. 0.1 < internal_angle < 179.9.

tilt_ref_sidefloat

The tilt angle of the reference side. 0.1 < tilt_ref_side < 179.9.

tilt_end_sidefloat

The tilt angle of the end side. 0.1 < tilt_end_side < 179.9.

tilt_opp_sidefloat

The tilt angle of the opposing side. 0.1 < tilt_opp_side < 179.9.

tilt_start_sidefloat

The tilt angle of the start side. 0.1 < tilt_start_side < 179.9.

machining_limitsdict, optional

The machining limits for the cut. Default is None

Methods

apply	Apply the feature to the element geometry.
from_shapes_and_element	Construct a Pocket feature from a volume and a TimberElement.
from_volume_and_element	Construct a Pocket feature from a volume and a TimberElement.
scale	Scale the parameters of this processing by a given factor.
volume_from_params_and_element	Calculates the subtracting volume from the machining parameters in this instance and the given element, ensuring correct face orientation.

Inherited Methods

ToString	Converts the instance to a string.
add_subprocessing	Add a nested subprocessing.
copy	Make an independent copy of the data object.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
scaled	Returns a new instance of the processing with the parameters scaled by a given factor.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
to_json	Convert an object to its native data representation and save it to a JSON file.
to_jsonstring	Convert an object to its native data representation and save it to a JSON string.
validate_data	Validate the data against the object's data schema.