Tenon

class compas_timber.fabrication.Tenon

Bases: BTLxProcessing

Represents a Tenon 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. Distance from the beam start to the reference point. -100000.0 < start_x < 100000.0.

start_yfloat

The start y-coordinate of the cut in parametric space of the reference side. Distance from the reference edge to the reference point. -5000.0 < start_y < 5000.0.

start_depthfloat

The start depth of the cut in parametric space of the reference side. Margin on the reference side. -5000.0 < start_depth < 5000.0.

anglefloat

The angle of the cut. Angle between edge and reference edge. 0.1 < angle < 179.9.

inclinationfloat

The inclination of the cut. Inclination between face and reference side. 0.1 < inclination < 179.9.

rotationfloat

The rotation of the cut. Angle between axis of the tenon and rederence side. 0.1 < rotation < 179.9.

length_limited_topbool

Whether the top length of the cut is limited. True or False.

length_limited_bottombool

Whether the bottom length of the cut is limited. True or False.

lengthfloat

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

widthfloat

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

heightfloat

The height of the tenon. 0.0 < height < 1000.0.

shapestr

The shape of the cut. Must be either ‘automatic’, ‘square’, ‘round’, ‘rounded’, or ‘radius’.

shape_radiusfloat

The radius of the shape of the cut. 0.0 < shape_radius < 1000.0.

chamferbool

Whether the edges of the tenon are chamfered. True or False.

Methods

apply	Apply the feature to the beam geometry.
frame_from_params_and_beam	Calculates the cutting plane from the machining parameters in this instance and the given beam.
from_plane_and_beam	Create a Tenon instance from a cutting plane and the beam it should cut.
volume_from_params_and_beam	Calculates the tenon volume 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.