StepJointNotch

class compas_timber.fabrication.StepJointNotch

Bases: BTLxProcessing

Represents a Step Joint Notch feature to be made on a beam.

Parameters:

orientationint

The orientation of the cut. Must be either OrientationType.START or OrientationType.END.

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 notch in parametric space of the reference side. -50000.0 < start_y < 50000.0.

strut_inclinationfloat

The inclination of the strut. 0.1 < strut_inclination < 179.9.

notch_limitedbool

Whether the notch is limited. If True, the notch is limited by the start_y and notch_width values.

notch_widthfloat

The width of the notch. notch_width < 50000.0.

step_depthfloat

The depth of the step. step_depth < 50000.0.

heel_depthfloat

The depth of the heel. heel_depth < 50000.0.

strut_heightfloat

The height of the strut. It is the cross beam’s height. strut_height < 50000.0.

step_shapestr

The shape of the step. Must be either StepShapeType.DOUBLE, StepShapeType.STEP, StepShapeType.HEEL or StepShapeType.TAPERED_HEEL.

mortisestr

The presence of a mortise. Must be either ‘no’ or ‘yes’.

mortise_widthfloat

The width of the mortise. mortise_width < 1000.0.

mortise_heightfloat

The height of the mortise. mortise_height < 1000.0.

Methods

add_mortise	Add a mortise to the existing StepJointNotch instance.
apply	Apply the feature to the beam geometry.
from_plane_and_beam	Create a StepJointNotch instance from a cutting surface and the beam it should cut.
mortise_volume_from_params_and_beam	Calculates the mortise volume from the machining parameters in this instance and the given beam
planes_from_params_and_beam	Calculates the cutting planes 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.
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.