LongitudinalCut

class compas_timber.fabrication.LongitudinalCut[source]

Bases: BTLxProcessing

Represents a Longitudinal Cut 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. 0.0 < start_y < 50000.0.

inclinationfloat

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

start_limitedbool

Whether the cut is limited at the start. If True, the cut starts at the start_x coordinate.

end_limitedbool

Whether the cut is limited at the end. If True, the cut ends at the start_x + length coordinate.

lengthfloat

The length of the cut in parametric space of the reference side. 0.0 < length < 100000.0.

depth_limitedbool

Whether the cut is limited in depth. If True, the cut goes to a certain depth.

depthfloat

The depth of the cut in parametric space of the reference side. 0.0 < depth < 50000.0.

angle_startfloat

The angle at the start of the cut in degrees. 0.1 < angle_start < 179.9.

angle_endfloat

The angle at the end of the cut in degrees. 0.1 < angle_end < 179.9.

tool_positionAlignmentType

The position of the tool relative to the beam. Can be ‘left’, ‘center’, or ‘right’.

Methods

apply

Apply the feature to the beam geometry.

from_plane_and_beam

Create a LongitudinalCut instance from a cutting plane and the beam it should cut.

from_shapes_and_element

Construct a Longitudinal Cut process from a shape and a beam.

plane_from_params_and_beam

Calculates the cutting plane from the machining parameters in this instance and the given beam

volume_from_params_and_beam

Calculates the negative volume representing the cut from the machining parameters in this instance and the given beam.

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.