OpenSCAD Workbench/cs

Introduction
The OpenSCAD Workbench is intended to offer interoperability with the open source software OpenSCAD. This program is not distributed as part of FreeCAD, but should be installed to make full use of this workbench. OpenSCAD should not be confused with OpenCASCADE, which is the geometrical kernel that FreeCAD uses to build geometry on screen. The OpenCASCADE libraries are always needed to use FreeCAD, while the OpenSCAD executable is entirely optional.

It contains a CSG importer to open the CSG files from OpenSCAD, and an exporter to output a CSG based tree. Geometry which is not based on CSG operations will be exported as a mesh.

This workbench contains functions to modify the CSG feature tree and repair models. It also contains general purpose tools that do not require installation of OpenSCAD; they can be used in conjunction with other workbenches. For example, the Mesh Workbench internally uses the OpenSCAD functions to perform operations with meshes, as they are quite robust.



Dependencies
In FreeCAD 0.19, the Ply (Python-Lex-Yacc) module, which is used to import CSG files, was removed from the FreeCAD source code, as it is a third party library not developed by FreeCAD. As a result, you now need to install Ply before using the OpenSCAD Workbench. When using a pre-packaged, stable version of FreeCAD this dependency should be installed automatically in all platforms; in other cases, for example, when compiling from source, you may have to install it from an online repository.

In Debian/Ubuntu based systems this is done like this.

The general installation in all platforms can be done from the Python package index.

OpenSCAD language and file format
The OpenSCAD language allows the use of variables and loops. It allows you to specify sub-modules to reuse geometry and code. This high degree of flexibility makes parsing very complex. Currently the OpenSCAD Workbench cannot handle the OpenSCAD language natively. Instead, if OpenSCAD is installed, it can be used to convert the input to the CSG format, which is a subset of the OpenSCAD language, and can be used as the input to OpenSCAD for further processing. During conversion all parametric behavior is lost, meaning that all variable names are discarded, loops expanded, and mathematical expressions evaluated.

Tools

 * [[Image:OpenSCAD_ColorCodeShape.png|32px]] Color Code Shape: Change the color of selected or all shapes based on their validity.
 * [[Image:OpenSCAD_ReplaceObject.png|32px]] Replace Object: Replace an object in the feature tree.
 * [[Image:OpenSCAD_RemoveSubtree.png|32px]] Remove Subtree: Removes the selected objects and all children that are not referenced from other objects.
 * [[Image:OpenSCAD_RefineShapeFeature.png|32px]] Refine Shape Feature: Create Refine Shape Feature.
 * [[Image:OpenSCAD_IncreaseTolerance.png|32px]] Increase Tolerance Feature: Increases tolerance of edges/faces/vertex of selected object(s).
 * [[Image:OpenSCAD_Edgestofaces.png|32px]] Convert Edges To Faces: Convert edges to faces. Useful to prepare imported DXF geometry for extrusion.
 * [[Image:OpenSCAD_ExpandPlacements.png|32px]] Expand Placements: Expand all placements downwards the FeatureTree.
 * [[Image:OpenSCAD_ExplodeGroup.png|32px]] Explode Group: Explodes fused part primitives.
 * [[Image:OpenSCAD_AddOpenSCADElement.png|32px]] Add OpenSCAD Element: Add an OpenSCAD element by entering OpenSCAD code into the task panel.
 * [[Image:OpenSCAD_MeshBoolean.png|32px]] Mesh Boolean: Creates new mesh object by boolean operation from shapes.
 * [[Image:OpenSCAD_Hull.png|32px]] Hull: Apllies a hull to selected shapes.
 * [[Image:OpenSCAD_Minkowski.png|32px]] Minkowski: Applies a minkowski sum to selected shapes.


 * [[Image:OpenSCAD_ColorCodeShape.svg|32px]] Color Code Shape: Change the color of selected or all shapes based on their validity.
 * [[Image:OpenSCAD_ReplaceObject.svg|32px]] Replace Object: Replace an object in the feature tree.
 * [[Image:OpenSCAD_RemoveSubtree.svg|32px]] Remove Subtree: Removes the selected objects and all children that are not referenced from other objects.
 * [[Image:OpenSCAD_RefineShapeFeature.svg|32px]] Refine Shape Feature: Create Refine Shape Feature.
 * [[Image:OpenSCAD_MirrorMeshFeature.svg|32px]] Mirror Mesh Feature: Create Mirror Mesh Feature.
 * [[Image:OpenSCAD_IncreaseToleranceFeature.svg|32px]] Increase Tolerance Feature: Increases tolerance of edges/faces/vertex of selected object(s).
 * [[Image:OpenSCAD_Edgestofaces.png|32px]] Convert Edges To Faces: Convert edges to faces. Useful to prepare imported DXF geometry for extrusion.
 * [[Image:OpenSCAD_ExpandPlacements.png|32px]] Expand Placements: Expand all placements downwards the FeatureTree.
 * [[Image:OpenSCAD_ExplodeGroup.png|32px]] Explode Group: Explodes fused part primitives.
 * [[Image:OpenSCAD_AddOpenSCADElement.png|32px]] Add OpenSCAD Element: Add an OpenSCAD element by entering OpenSCAD code into the task panel.
 * [[Image:OpenSCAD_MeshBoolean.png|32px]] Mesh Boolean: Creates new mesh object by boolean operation from shapes.
 * [[Image:OpenSCAD_Hull.svg|32px]] Hull: Applies a hull to selected shapes.
 * [[Image:OpenSCAD_Minkowski.svg|32px]] Minkowski: Applies a minkowski sum to selected shapes.

Preferences

 * [[Image:Std_DlgParameter.svg|32px]] Preferences: preferences available for the OpenSCAD tools.

Limitations
OpenSCAD creates constructive solid geometry, as well as imports mesh files and extrudes 2D geometry from DXF files. FreeCAD allows you to create CSG with primitives as well. The FreeCAD geometry kernel (OCCT) works using a boundary representation. Therefore conversion from CSG to BREP should, in theory, be possible whereas conversion from BREP to CSG is, in general, not.

OpenSCAD works internally on meshes. Some operations which are useful on meshes are not meaningful on a BREP model and can not be fully supported. Among these are convex hull, minkowski sum, glide and subdiv. Currently we run the OpenSCAD binary in order to perform hull and minkwoski operations and import the result. This means that the involved geometry will be triangulated. In OpenSCAD non-uniform scaling is often used, which does not impose any problems when using meshes. In our geometry kernel geometric primitives (lines, circular sections, etc) are converted to BSpline prior to performing such deformations. Those BSplines are known to cause trouble in later boolean operations. An automatic solution is not available at the moment. Please feel free to post to the forum if you encounter such problems. Often such problems can be solved be remodeling small parts. A deformation of a cylinder can substituted by an extrusion of an ellipses.

Hints
When importing DXF set the Draft precision to a sensible amount as this will affect the detection of connected edges.

If FreeCAD crashes when importing CSG, it is strongly recommended that you enable "automatically check model after boolean operation" in.

Tutorials

 * Import OpenSCAD code

Links

 * OpenSCAD source code repository on GitHub
 * Open tickets tagged "Openscad" on the FreeCAD bugtracker
 * Things tagged with "OpenSCAD" on Thingiverse