compas_timber.fabrication

Core

BTLxWriter

Class for writing BTLx files from a given model.

BTLxPart

Class representing a BTLx part.

BTLxRawpart

Class representing a BTLx Rawpart.

BTLxProcessing

Base class for BTLx Processing.

BTLxFromGeometryDefinition

Container linking a BTLx Process Type and generator function to an input geometry.

Processings

DoubleCut

Represents a Double Cut feature to be made on a beam.

DovetailTenon

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

DovetailMortise

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

Drilling

Represents a drilling processing.

FrenchRidgeLap

Represents a French Ridge Lap feature to be made on a beam.

JackRafterCut

Represents a Jack Rafter Cut feature to be made on a beam.

Lap

Represents a Lap feature to be made on a beam.

LongitudinalCut

Represents a Longitudinal Cut feature to be made on a beam.

Pocket

Represents a Pocket feature to be made on a beam.

Slot

StepJoint

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

StepJointNotch

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

Tenon

Represents a Tenon feature to be made on a beam.

Mortise

Represents a Mortise feature to be made on a beam.

FreeContour

Represents a free contour processing.

Text

Represents a Text feature to be made on a beam.

Processings Parameters

AlignmentType

Enum for the alignment of the cut. Attributes ---------- TOP : literal("top") Top alignment. BOTTOM : literal("bottom") Bottom alignment. LEFT : literal("left") Left alignment. RIGHT : literal("right") Right alignment. CENTER : literal("center") Center alignment.

EdgePositionType

Enum for the edge position of the cut.

LimitationTopType

Enum for the top limitation of the cut.

MachiningLimits

Configuration class for the machining limits of the cut.

OrientationType

Enum for the orientation of the cut.

StepShapeType

Enum for the step shape of the cut.

TenonShapeType

Enum for the tenon shape of the cut.

Contour

Represens the generic contour for specific free contour processings.

DualContour

Represens the generic contour for specific free contour processings.

Processings Proxies

Proxies can be used interchangably with their corresponding processings in-order to speed up visualization. Upon creating a BTLx file, these are converted to their respective processings.

JackRafterCutProxy

This object behaves like a JackRafterCut except it only calculates the machining parameters once unproxified.

PocketProxy

This object behaves like a Pocket except it only calculates the machining parameters once unproxified.

LapProxy

This object behaves like a Lap except it only calculates the machining parameters once unproxified.