OpenSCAD AddOpenSCADElement: Difference between revisions

Latest revision as of 11:05, 28 December 2022

Other languages:

Explode Group

Mesh Boolean

OpenSCAD

Menu location
OpenSCAD AddOpenSCADElement
OpenSCAD -> Add OpenSCAD Element
Workbenches
OpenSCAD
Default shortcut
None
Introduced in version
-
See also
None

Description

Add an OpenSCAD element by entering OpenSCAD code into the task panel and executing the OpenSCAD binary (requires OpenSCAD)

When 'as mesh' is selected, OpenSCAD renders a Mesh.

Each time Add is pressed the OpenSCAD code is executed and elements are imported.

If OpenSCAD returns successfully, its messages are displayed as warnings in the report window. This will be the case if the path to imported, included and used files is broken. In case of undesired results it is highly recommend to have a look at the report windows, as there might be a lot of other output, created by the importer. If OpenSCAD fails, its messages will be logged as errors.

Libraries should be accessible as usual, whereas example can be reached as stated below.

include <../examples/example001.scad>;

would include the first examples also known as the OpenSCAD icon.

Setup OpenSCAD within FreeCAD

Note: OpenSCAD needs to be installed on your computer before FreeCAD will have this functionality
Install OpenSCAD in the appropriate manner for your operating system. See the OpenSCAD web site for more information.

FreeCAD needs to be told where to find the OpenSCAD executable:

Switch to the OpenSCAD Workbench via View → Workbench → OpenSCAD
Open the preferences dialog Edit → Preferences
Click on "OpenSCAD" on the left plane
Click on the button labled ... in General Settings → General OpenSCAD Settings → OpenSCAD executable to browse the directory or enter the path (e.g. Ubuntu based Linux distributions /usr/bin/openscad) directly into the line input right to the button
Close and restart FreeCAD

Result: A new OpenSCAD icon will appear on the tool bar, and in the OpenSCAD menu, in the FreeCAD OpenSCAD workbench.

Note: It is also possible to add another optional Parameter which controls the maximum sides of a polygon before it is considered a circle (fn).

Starting from version 0.14 and above, FreeCAD will search for the OpenSCAD executable if the setting mentioned above is empty.

Explode Group

Mesh Boolean

OpenSCAD

Tools: Color code shape, Replace object, Remove subtree, Refine shape feature, Increase tolerance feature, Convert edges to faces, Expand placements, Explode group, Add OpenSCAD element, Mesh Boolean, Hull, Minkowski

Additional: Preferences; Import OpenSCAD code (CSG)

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
 <languages/>
 <translate>
 <!--T:9-->
 {{Docnav
 |[[OpenSCAD_ExplodeGroup|Explode Group]]
 |[[OpenSCAD_MeshBoolean|Mesh Boolean]]
-|[[OpenSCAD_Module|OpenSCAD]]
+|[[OpenSCAD_Workbench|OpenSCAD]]
 |IconL=OpenSCAD_ExplodeGroup.svg
+|IconR=OpenSCAD_MeshBoolean.svg
 |IconC=Workbench_OpenSCAD.svg
-|IconR=OpenSCAD_MeshBoolean.png
 }}
@@ Line 16: / Line 17: @@
 |Empty=1
 |MenuLocation=OpenSCAD -> Add OpenSCAD Element
-|Workbenches=[[OpenSCAD_Module|OpenSCAD]]
+|Workbenches=[[OpenSCAD_Workbench|OpenSCAD]]
 }}
-==Description== <!--T:2-->
+==Description== <!--T:15-->
+<!--T:2-->
 Add an OpenSCAD element by entering OpenSCAD code into the task panel and executing the OpenSCAD binary (requires OpenSCAD)
@@ Line 29: / Line 32: @@
 <!--T:5-->
-If OpenSCAD returns successfully, its messages are displayed as warnings in the report window. This will be the case if the path to imported, included and used files is broken.
+If OpenSCAD returns successfully, its messages are displayed as warnings in the report window. This will be the case if the path to imported, included and used files is broken. In case of undesired results it is highly recommend to have a look at the report windows, as there might be a lot of other output, created by the importer. If OpenSCAD fails, its messages will be logged as errors.
-In case of undesired results it is highly recommend to have a look at the report windows, as there might be a lot of other output, created by the importer.
+<!--T:16-->
-If OpenSCAD fails, its messages will be logged as errors.
-Libraries should be accessible as usual, whereas example can be reached as stated below
+Libraries should be accessible as usual, whereas example can be reached as stated below.
 </translate>
 {{Code|code=
@@ Line 38: / Line 42: @@
 }}
 <translate>
 <!--T:6-->
-would include the first examples also known as the OpenSCAD icon
+would include the first examples also known as the OpenSCAD icon.
+==Setup OpenSCAD within FreeCAD== <!--T:17-->
-==Setup OpenSCAD within FreeCAD== <!--T:7-->
+<!--T:7-->
 '''Note:''' OpenSCAD needs to be installed on your computer before FreeCAD will have this functionality<br/>
-Install OpenSCAD in the appropriate manner for your operating system. See [https://www.openscad.org/ the OpenSCAD web site] for more information
+Install OpenSCAD in the appropriate manner for your operating system. See [https://www.openscad.org/ the OpenSCAD web site] for more information.
 <!--T:13-->
-FreeCAD needs to be told where to find the OpenSCAD executable
+FreeCAD needs to be told where to find the OpenSCAD executable:
-* Switch to the [[Image:Workbench_OpenSCAD.svg|24px]] [[OpenSCAD Workbench]] via {{MenuCommand|Menu → View Workbench → OpenSCAD}}
+* Switch to the [[Image:Workbench_OpenSCAD.svg|24px]] [[OpenSCAD_Workbench|OpenSCAD Workbench]] via {{MenuCommand|View → Workbench → OpenSCAD}}
-* Open the preferences dialog {{MenuCommand|Menu
+* Open the preferences dialog {{MenuCommand|Edit → Preferences}}
-→ Edit → Preferences}}
 * Click on "OpenSCAD" on the left plane
 * Click on the button labled {{Button|...}} in {{MenuCommand|General Settings → General OpenSCAD Settings → OpenSCAD executable}} to browse the directory or enter the path (e.g. Ubuntu based Linux distributions {{incode|/usr/bin/openscad}}) directly into the line input right to the button
 * Close and restart FreeCAD
-:'''Result:''' A new OpenSCAD icon will appear on the tool bar, and in the OpenSCAD menu, in the FreeCAD OpenSCAD workbench
+: '''Result:''' A new OpenSCAD icon will appear on the tool bar, and in the OpenSCAD menu, in the FreeCAD OpenSCAD workbench.
 <!--T:14-->
@@ Line 59: / Line 65: @@
 <!--T:8-->
-Starting from {{VersionPlus|0.14}} FreeCAD will search for the OpenSCAD executable if the setting mentioned above is empty.
+Starting from {{VersionPlus|0.14}}, FreeCAD will search for the OpenSCAD executable if the setting mentioned above is empty.
@@ Line 66: / Line 72: @@
 |[[OpenSCAD_ExplodeGroup|Explode Group]]
 |[[OpenSCAD_MeshBoolean|Mesh Boolean]]
-|[[OpenSCAD_Module|OpenSCAD]]
+|[[OpenSCAD_Workbench|OpenSCAD]]
 |IconL=OpenSCAD_ExplodeGroup.svg
+|IconR=OpenSCAD_MeshBoolean.svg
 |IconC=Workbench_OpenSCAD.svg
-|IconR=OpenSCAD_MeshBoolean.png
 }}