DovetailMortise

class compas_timber.fabrication.DovetailMortise[source]

Bases: BTLxProcessing

Represents a Dovetail Mortise feature to be made on a beam.

Parameters:
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. 0.0 < start_depth < 5000.0.

anglefloat

The angle of the cut. Angle between edge and reference edge. -180.0 < angle < 180.0.

slopefloat

The slope of the cut. Angle between axis along the length of the mortise and rederence side. 0.1 < slope < 179.9.

inclinationfloat

The inclination of the cut. Angle between axis along the width of the mortise and rederence side. 0.1 < inclination < 179.9.

limitation_topstr

The limitation type of the top length of the cut. Should be either ‘limited’, ‘unlimited’, or ‘pocket’.

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.

depthfloat

The depth of the mortise. 0.0 < depth < 1000.0.

cone_anglefloat

The cone angle of the cut. 0.0 < cone_angle < 30.0.

use_flank_anglebool

Whether the flank angle is used. True or False.

flank_anglefloat

The flank angle of the cut. Angle of the tool. 5.0 < flank_angle < 35.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.

Methods

apply

Apply the feature to the beam geometry.

define_dovetail_tool

Define the parameters for the dovetail feature based on a defined dovetail cutting tool.

dovetail_cutting_frames_from_params_and_beam

Calculates the cutting frames for the dovetail mortise from the machining parameters in this instance and the given beam.

dovetail_volume_from_params_and_beam

Calculates the dovetail mortise volume from the machining parameters in this instance and the given beam.

frame_from_params_and_beam

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

from_frame_and_beam

Create a DovetailMortise instance from a cutting surface and the beam it should cut.

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.