FreeContour

class compas_timber.fabrication.FreeContour

Bases: BTLxProcessing

Represents a free contour processing.

Parameters:

contour_param_objectcompas_timber.fabrication.btlx.Contour or compas_timber.fabrication.btlx.DualContour

The contour parameter object.

counter_sinkbool, optional

If True, the contour is a counter sink. Default is False.

tool_positionstr, optional

The position of the tool. Default is “left”.

depth_boundedbool, optional

If True, the depth is bounded. Default is False, meaning the machining will cut all the way through the element.

Methods

apply	Apply the feature to the beam geometry.
are_all_segments_parallel
from_polyline_and_element	Construct a Contour processing from a polyline and element.
from_shapes_and_element	Construct a Contour processing from a list of shapes and element.
from_top_bottom_and_elements	Construct a Contour processing from a list of polylines and element.
get_ref_face_index
parse_tool_position
scale	Scale the parameters of this processing by a given factor.

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.